Metadata Types and Fields

Metadata types and fields were modified or added in version 30.0.

Standard Apps Support

You can now deploy and retrieve standard apps using the CustomApplication type. If you’ve made customizations to portions of standard apps, you can now expose and access these customizations. Previously, CustomApplication represented only custom apps. Now, CustomApplication represents both standard and custom 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>

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>

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>
    <tab>standard-Chatter</tab>
    <tab>standard-UserProfile</tab>
    <tab>standard-OtherUserProfile</tab>
    <tab>standard-CollaborationGroup</tab>
    <tab>standard-File</tab>
</CustomApplication>

New Metadata Types

AppMenu
Represents the Force.com app menu or the Salesforce1 navigation menu.
OrderSettings
Represents order settings.
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.
SiteDotCom

Represents a site for deployment. It extends the MetadataWithContent type and inherits its fullName and content fields.

WorkflowFlowAction
Represents a flow trigger, which is a workflow action that launches a flow.

Flow trigger workflow actions are currently available through a pilot program. For information on enabling this feature in your organization, contact salesforce.com.

Updated Metadata Types and Fields

These metadata fields have been added or changed in API version 30.0.

AuthProvider
The following fields have been added:
idTokenIssuer
Only available if providerType is OpenIdConnect. This value identifies the source of the authentication token in the form https: URI . Used only with OpenID Connect authentication providers. If provided, Salesforce validates the returned id_token value. The OpenID Connect specification requires an id_token value to be returned with the access_token value. Available in API version 30.0 and later.
sendAccessTokenInHeader
Required only if providerType is OpenIdConnect. When true, the access token is sent to the userInfoUrl in a header instead of a query string. Used only with OpenID Connect authentication providers. Available in API version 30.0 and later.
sendClientCredentialsInHeader
Required only if providerType is OpenIdConnect. When true, the client credentials are sent in a header, instead of a query string, to the tokenUrl. The credentials are in the standard OpenID Connect Basic Credentials header form, which is Basic <token>, where <token> is the base64-encoded string "clientkey:clientsecret". Used only with OpenID Connect authentication providers. Available in API version 30.0 and later.
ConnectedApp
options
If you use Force.com Canvas, this field indicates if you want to hide the Share button and header in the publisher for your canvas app. Valid values are:
  • HideShare—The Share button is hidden in the publisher for the related canvas app.
  • HideHeader—The header is hidden in the publisher for the related canvas app.
In the ConnectedAppOauthConfig subtype, the scopes field has new enumeration values.
Note

Note

The new values Address, Email, OfflineAccess, OpenID, Phone, and Profile will not be available until March 2014.

When deploying metadata, the values (all of them, including the legacy ones) are:

Address
Allows access to the logged-in user’s street address (the same behavior as deploying Basic).
Api
Allows access to the logged-in user’s account over the APIs.
Basic
Allows access to your identity URL service (the same behavior as deploying Address, Email, Phone, and Profile).
Chatter
Allows access to only the Chatter REST API resources.
CustomApplications
Provides access to custom applications, such as those using Visualforce.
Email
Allows access to the logged-in user’s email address (the same behavior as deploying Basic).
Full
Allows access to all data accessible by the logged-in user.
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).
OpenID
Allows access to the logged-in user’s unique identifier for OpenID Connect apps.
Phone
Allows access to the logged-in user’s unique identifier for OpenID Connect apps (the same behavior as deploying Basic).
Profile
Allows access to the logged-in user’s profile (the same behavior as deploying Basic).
RefreshToken
Allows a refresh token to be returned if you’re eligible to receive one (the same behavior as deploying OfflineAccess).
Web
Allows the ability to use the access_token on the Web. This also includes visualforce, allowing access to Visualforce pages.
When retrieving metadata, valid values are:
Api
Allows access to the logged-in user’s account over the APIs.
Basic
Allows access to your identity URL service, and includes Address, Email, Phone, and Profile.
Chatter
Allows access to only the Chatter REST API resources.
CustomApplications
Provides access to custom applications, such as those using Visualforce.
Full
Allows access to all data accessible by the logged-in user.
OpenID
Allows access to the logged-in user’s unique identifier for OpenID Connect apps.
RefreshToken
Allows a refresh token to be returned if you are eligible to receive one, and is synonymous with allowing OfflineAccess.
Web
Allows the ability to use the access_token on the Web. This also includes visualforce, allowing access to Visualforce pages.
In the ConnectedAppSamlConfig subtype, the following field has been added:
encryptionCertificate
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.
encryptionType
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:
  • AES_128—128–bit key.
  • AES_256—256–bit key.
  • Triple_Des—Triple Data Encryption Algorithm.
CustomApplication
The following field has been added:
enableMultiMonitorComponents
Indicates if a Salesforce console app has multi-monitor components enabled, which let users move portions of a console from their browsers to locations on their screens. This field is required if isServiceCloudConsole is true.
CustomField
The following field has been added:
lookupFilter
Represents the metadata associated with a lookup filter. Use this metadata type to create, update, or delete lookup filter definitions. Replaces the NamedFilter component, which has been removed. The filter now appears in its source field instead of in the target object. Both custom fields and standard fields can now have lookup filters deployable through the Metadata API.
The following field has changed:
trackHistory
Now available for standard objects (picklist and lookup fields only), as well as custom objects.
Indicates whether history tracking is enabled for the field (true) or not (false).
CustomObject
The following field has changed:
enableHistory
Now available for standard objects, as well as custom objects.
Indicates whether the object is enabled for audit history (true) or not (false).
sharingModel
This field is no longer read-only. You can now set a value for this field to update the organization-wide default for internal users.
For activity objects, the organization-wide default can be retrieved, but is currently read-only.
The following field has been removed:
namedFilter
The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.
CustomObjectTranslation
The following field has been added to the CustomFieldTranslation subtype:
lookupFilter
Represents the translation metadata associated with a lookup filter.
The following field has been removed:
namedFilters
The translation metadata associated with a lookup filter is now represented by the lookupFilter field.
CustomSite
The following field has been added:
clickjackProtectionLevel
Required. Sets the clickjack protection level. The options are:
  • AllowAllFraming — Allow framing by any page (no protection)
  • SameOriginOnly — Allow framing by the same origin only (recommended)
  • NoFraming — Don’t allow framing by any page (most protection)
DeployMessage
The following fields have been added:
componentType
The metadata type of the component in this deployment.
createdDate
The date and time when the component was created as a result of this deployment.
DeployResult
The following fields have been added:
canceledBy
The ID of the user who canceled the deployment.
canceledByName
The full name of the user who canceled the deployment.
createdBy
The ID of the user who created the deployment.
createdByName
The full name of the user who created the deployment.
runTestsEnabled
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() call.
Flow
The following field has been added:
loops
An array of nodes for iterating through collections.
FlowCondition
The following operator has been added to the FlowComparisonOperator enumeration::
WasSet
Used to check that the item being compared against was previously set to a value or null.
FlowElementReferenceOrValue
The following field has been added:
dateTime
Used to specify a dateTime value.
FlowRecordLookup
The following field has been added:
assignNullValuesIfNoRecordFound
Specifies that all values will be set to null if the record is not found.
FlowVariable
The following value has been added to the FlowDataType enumeration:
DateTime
A timestamp value for the flow variable.
ForecastingSettings
The following subtype has been removed:
DataSourceSettings
The data sources available in Forecasts. Choices include quantity, revenue, or both.
The following subtype has been added:
ForecastingTypeSettings
Represents the Forecasts settings for an individual forecast type. Some fields that were previously children of the ForecastingSettings type are now children of the new ForecastingTypeSettings subtype. These include:
  • adjustmentSettings
  • forecastRangeSettings
  • opportunityListFieldsSelectedSettings
  • quotasSettings
Warning

Warning

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.

The following field has been added to the ForecastingTypeSettings subtype:
active
Boolean. Indicates whether the forecast type is active in the organization.
The following field has been added to the ForecastingTypeSettings subtype:
name
String. This field indicates the name of the forecast type being configured in the forecastingTypeSettings. Valid values include:
  • OpportunityRevenue : Opportunities - Revenue
  • OpportunityQuantity : Opportunities - Quantity
  • OpportunitySplitRevenue : Opportunity Revenue Splits - Revenue
  • OpportunityLineItemRevenue : Product Families - Revenue
  • OpportunityLineItemQuantity : Product Families - Quantity
The following fields have been moved from the ForecastingSettings type to the ForecastingTypeSettings subtype:
  • adjustmentsSettings—This field enables or disables the Forecasts adjustments option in Forecasts. All forecast types must contain the same adjustmentSettings value. Setting this field to false deletes all adjustment data.
  • forecastRangeSettings—The default periods and range selections in Forecasts. All forecast types must contain the same forecastRangeSettings values.
  • opportunityListFieldsSelectedSettings—The fields selected to appear in the opportunity pane of the forecast page for the forecast type. Opportunity Name is required. You can select up to 15 fields.
  • quotasSettings—This field enables or disables the Show Quotas option in Forecasts. All forecast types must contain the same quotasSettings value. Setting this field to false hides quotas from the Forecasts tab, but does not delete any quota data.
Layout
The following fields have been added:
component
Reference to a component in the Mobile Cards section of a page layout.
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, and custom objects. They include a feed view and a detail view. This field is of type FeedLayout.
In the PrimaryTabComponents subtype, the following field and subtype have been added:
containers
Represents a location and style in which 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).
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).
In the PrimaryTabComponents subtype, the following field has been removed:
component
Represents a custom console component (Visualforce page or lookup field; Force.com Canvas apps not available) on a section of a page layout. Custom console components only display in the Salesforce console. This field was replaced by containers.
In the SubtabComponents subtype, the following field has been added:
containers
Represents a location and style in which 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).
In the SubtabComponents subtype, the following field has been removed:
component
Represents a custom console component (Visualforce page or lookup field; Force.com Canvas apps not available) on a section of a page layout. Custom console components only display in the Salesforce console. This field was replaced by containers.
LiveChatButton
The following fields have been added:
numberOfReroutingAttempts
Specifies the number of times a chat request can be rerouted to available agents if all agents reject the chat request.
optionsCustomRoutingIsEnabled
Indicates whether custom routing is enabled for incoming chat requests (true) or not false).
optionHasRerouteDeclinedRequest
Indicates whether a chat request, which has been rejected by all available agents, should be rerouted to available agents again (true) or not (false).
optionsIsAutoAccept
Indicates whether a chat request should be automatically accepted by the agent it’s assigned to (true) or not false). For chat buttons and automated chat invitations with routingType set to MostAvailable or LeastActive.
PermissionSet
The following fields have changed:
applicationVisibilities
Standard as well as custom apps are now supported. (In API version 29.0, only custom apps are supported.)
fieldPermissions
fieldPermissions for required fields can no longer be retrieved or deployed.
Profile
The following fields have been added:
custom
Indicates whether the profile is a custom (true) or standard (false) profile.
description
The profile description. Limit: 255 characters.
The following fields have changed:
applicationVisibilities
Standard as well as custom apps are now supported. (In API version 29.0 and earlier, only custom apps are supported.)
fieldPermissions
fieldPermissions for required fields can no longer be retrieved or deployed.
When deploying a new custom field, the default values for the editable and readable fields are false. To override the default values, include field permissions for the new field in your profiles.
Report
The following fields have been added to the ReportGrouping subtype:
aggregateType
The type of aggregate value to sort by.Valid values are:
  • Sum
  • Average
  • Maximum
  • Minimum
  • RowCount
sortByName
Specifies the API name of the column, aggregate or custom summary field used to order the grouping.
sortType
Indicates if the grouping is sorted by a column, aggregate or custom summary field. Valid values are:
  • Column
  • Aggregate
  • CustomSummaryFormula
EntitlementProcess
The following field has been added:
businessHours
The business hours that apply to the entitlement process.
EntitlementProcessMilestoneItem
The following fields have been added:
businessHours
The business hours that apply to the milestone.
minutesCustomClass
The name of the Apex class that is used to calculate the trigger time.
NamedFilter
This component has been removed. The metadata associated with a lookup filter is now represented by the lookupFilter field in the CustomField component. The filter now appears in its source field instead of in the target object.
Network
The following fields have been added:
enableKnowledgeable
Determines if community members can see who’s knowledgeable on topics and endorse people for their knowledge on a topic.
enablePrivateMessages
Determines if community members can send and receive private messages.
picassoSite
Name of the Site.com site linked to the community.
SamlSsoConfig
The following field has been added:
decryptionCertificate
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.
SecuritySettings
The following field has been added to the PasswordPolicies subtype:
obscureSecretAnswer
Hides the secret answer associated with a password (true) or not (false).
Note

Note

If your organization uses the Microsoft Input Method Editor (IME) with the input mode set to Hiragana, when you type ASCII characters they’re converted into Japanese characters in normal text fields. However, the IME does not work properly in fields with obscured text. If your organization’s users cannot properly enter their passwords or other values after enabling this feature, disable the feature.

Workflow
The following field has been added:
flowActions
An array of flow triggers for the object associated with the workflow.

Flow trigger workflow actions are currently available through a pilot program. For information on enabling this feature in your organization, contact salesforce.com.

WorkflowActionType
This enumeration field has the following new value:
FlowAction
Specifies that the referenced workflow action is a flow trigger.

Flow trigger workflow actions are currently available through a pilot program. For information on enabling this feature in your organization, contact salesforce.com.