Metadata Types and Fields
Metadata types and fields have been added or modified in version 32.0.
New Metadata Types
- AuraDefinitionBundle
- Represents a Lightning definition bundle. A bundle contains a Lightning definition and all its related resources. The definition can be a component, application, event, or interface. Lightning components is a beta feature.
- CorsWhitelistOrigin
- Represents an origin in the CORS (cross-origin resource sharing) whitelist. CORS 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.
- ManagedTopics
- Represents navigational and featured topics managed in a community.
- SynonymDictionary
- Manage synonym groups. Optimize search results for acronyms, variations of product names, and other terminology unique to your organization.
- Territory2
- Represents the metadata associated with a sales territory in Territory Management 2.0.
- Territory2Model
- Represents the metadata associated with a territory model in Territory Management 2.0.
- Territory2Rule
- Represents the metadata associated with a territory assignment rule associated with an object, such as Account, in Territory Management 2.0.
- Territory2Settings
- Represents the metadata for the default settings for Territory Management 2.0 users to access and modify records associated with sales territories. The standard record access settings apply to accounts and opportunities. If your organization uses Private default internal access for contacts or cases, you can also set access for those records.
- Territory2Type
- Represents the metadata for a category of territories in Territory Management 2.0. Every Territory2 must have a Territory2Type.
- XOrgHub
- Represents the metadata that’s associated with a hub organization in a cross-organization data connection.
- XOrgHubSharedObject
- Represents the metadata that’s associated with a shared object in a cross-organization data connection.
Updated Metadata Types and Fields
These metadata fields have been added or changed in API version 32.0.
- ActivitiesSettings
- The following fields have been added:
- enableSimpleTaskCreateUI
- Allows administrators to specify whether tapping New Task in Salesforce1 opens a regular task record edit page or a page that displays key task fields first. For details, see It’s Easier to Create a Task.
- enableUNSTaskDelegatedToNotifications
- On the Activity settings page, exposes a setting for administrators to hide or show a user setting that lets individual users enable or disable email notifications when tasks are assigned to them. For details, see Let Your Users Control Task Notifications Globally.
- AssignmentRules
- The following field has been added to the RuleEntry type:
- notifyCcRecipents
- Specifies whether email addresses included on the Cc line of an incoming Email-to-Case or Web-to-Lead message should be included on the Cc line of the auto-response to that message (true) or not (false).
- AuthProvider
- The following field has been added:
- iconURL
- The path to an icon to use as a button on the login page for a community. Users click the button to log in to a community with the associated authentication provider, such as Twitter© or LinkedIn©.
- The following supported values for the providerType field have
been added:
- For information, see Configure a LinkedIn Authentication Provider.
- For more information, see Configure a Twitter Authentication Provider.
- CaseSettings
- The following field has been added:
- caseFeedItemSettings
- Specifies the settings for feed items in feed-based case page layouts.
- ConnectedApp
- The following field has been added to the ConnectedAppOauthConfig subtype.
- consumerSecret
-
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. Typically,
this value is generated by Salesforce when you create
the connected app. However, the
field is write-enabled so you can customize the shared secret value. Once set, the
value is not returned in metadata API
requests.
The value must be alphanumeric (no special characters and no spaces) and a minimum of eight characters (maximum of 256 characters). If you specify a secret already in use for another connected app in the organization, you’ll get an error.
- The following field has been updated in the ConnectedAppOauthConfig subtype.
- consumerKey
- This field is now write-enabled so you can customize the value when you create the OAuth configuration. Once set, the value cannot be edited. The value must be alphanumeric (no special characters and no spaces) and a minimum of eight characters (maximum of 256 characters). If you specify a key already in use for another connected app in the organization, you’ll get an error.
- The following field has been updated in the ConnectedAppCanvasConfig subtype.
- options
- This field now accepts an additional value: PersonalEnabled, which indicates whether the canvas app can be designated by the developer as a canvas personal app (installable by end users). This is a new value for the CanvasOptions enumeration.
- CustomField
- The following fields have been added:
- externalDeveloperName
- Available only for external objects. Name of the table column on the external data source that maps to this custom field in Salesforce.
- isFilteringDisabled
- Available only for external objects. Indicates whether the custom field is available in filters.
- isNameField
- Available only for external object fields of type text. For each external object, you can specify one field as the name field.
- isSortingDisabled
- Available only for external objects. Indicates whether the custom field is sortable.
- referenceTargetField
- Available only for indirect lookup relationship fields on external objects. Specifies the custom unique, external ID field on the parent object to match against the child’s indirect lookup relationship field, whose values come from an external data source.
- CustomObject
- The following fields have been added:
- externalDataSource
- Required and available for external objects only. The name of the external data source that stores the data for the external object.
- externalName
- Required and available for external objects only. The name of the table in the external data source that contains the data for the external object.
- CustomPermission
- The following field has been added:
- requiredPermission
- Indicates which custom permissions are required by the parent custom permission.
- CustomSite
- The following field has been added:
- requireHttps
- Determines whether the site requires secure connections (true) or not (false). When false, the site operates normally via insecure connections instead of redirecting to a secure connection.
- CustomTab
- The following field has been added:
- auraComponent
- Indicates whether this tab is for a Lightning component (true) or not (false). If set to true, the name of the tab matches the name of the Lightning component. This field is part of the Lightning Components (Beta) feature.
- ExternalDataSource
- The following field has been added:
- authProvider
- The authentication provider that is represented by the AuthProvider component.
- The following fields have been changed:
- apiKey
- This field is now reserved for future use. It was previously used by a beta feature that is no longer available.
- type
- The field type changed from string to enumeration of type string.
- FlexiPage
- The following field has been added:
- type
- Required. The type of a page. In API version 32.0, this field can only have a value of AppPage.
- Flow
- The following field has been added to the Flow type.
- waits
- An array of wait nodes. Wait nodes allow you to configure the flow to wait for one or more events to occur.
- The following base type has been added.
- FlowBaseElement
- Base class for all flow elements that require contextual information in metadata values. This is an abstract class. Some flow metadata types now inherit from FlowBaseElement, including all input and output parameter types.
The following field has been changed on the FlowVariable subtype.- isCollection
- This field can now be set to true for variables of any data type.
- Layout
- The following values are now supported for the componentType
field on the SidebarComponent subtype:
- Files and CaseExperts.
Note
Case Experts is currently available through a pilot program.
- The following field has been added to the FeedLayout subtype.
- compactFeed
- Specifies whether the feed-based page layout uses a compact feed (true) or not (false). If set to true, feed items on the page are collapsed by default, and the feed view has an updated design.
- The following field has been added to the Container
subtype:
- isContainerAutoSizeEnabled
- Determines if stacked console components in the sidebars autosize vertically. Set to true by default for newly created console components.
- Network
- The following field has been added to the Network type:
- enableNicknameDisplay
- Determines if user nicknames display instead of their first and last names in most places in the community. Set to false by default.
- The following field has been added to the ReputationLevel subtype:
- branding
- Represents branding associated with the reputation level, specifically, the custom image for the reputation level. If not specified, the default reputation level image is used.
These metadata field types have been changed in API version 32.0.
- Gender Field Type
- The gender field type allows a new value, AnimateMasculine, for use in Slavic languages—currently Czech, Polish, Russian, Slovak, Slovenian, and Ukrainian. Additionally, the documentation was corrected to note that the values Euter and Common are displayed in the user interface but aren’t valid in the Metadata API.