Custom Address Fields (beta) Developer Guide

Custom Address Fields (Beta)
Custom Address Fields (Beta) Requirements and Limitations
Configure State and Country/Territory Picklists
Enable Custom Address Fields (Beta)
Apex Examples (Beta)
Metadata API Example (Beta)
REST API Examples (Beta)
SOAP API Examples (Beta)
Tooling API Examples (Beta)
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Custom Address Fields (Beta) Requirements and Limitations

Before you enable Custom Address Fields (beta), configure State and Country/Territory picklists and review the limitations of this beta feature.
Available in: all editions.

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.

To discuss the feature and ask questions, join the Custom Address Fields Beta Program group on the Trailblazer Community.

Note

Custom Address Fields (Beta) Requirement: State and Country/Territory Picklists

Custom Address Fields (beta) uses picklists for the State and Country address fields. For more information, see Configure State and Country/Territory Picklists.

Custom Address Fields (Beta) Requirement: Package Deployment

If a package contains a custom field with the Address field type, package deployment requires that Custom Address Fields (beta) is enabled in the target org.

Custom Address Fields and Org Limits

For custom compound fields, each component counts as one custom field toward your org’s allocations. Thus each custom address field counts as nine custom fields: one each for street, city, postal code, country code, state code, geocode accuracy level, longitude, and latitude, plus one for internal use. For more information on the allocations for your org, see Salesforce Features and Edition Allocations in Salesforce Help.

Limitations for Custom Address Fields (Beta)

Before you enable Custom Address Fields (beta) or add a custom address field, understand the limitations of this feature.

These items aren’t supported with custom address fields.
Salesforce hasn’t validated custom address fields with these items.
This functionality is either unavailable or limited with Custom Address Fields (beta).
  • You can’t mark a custom address field as required.
  • You can’t use the DISTANCE function with a custom address field.
  • To export data stored in custom fields of type Address, use API or SOQL queries. Bulk API doesn’t support the export of custom compound fields.
  • The error message when you attempt to export a custom address field with Bulk API incorrectly states that the functionality isn’t enabled. Bulk API doesn’t support the export of custom compound fields.
  • To populate a custom address field with imported data, use REST API or Bulk API 2.0.
  • Search queries only support the data stored within the Street component of custom fields of type Address. The State, City, Postal Code, and Country components aren’t supported for search.
  • In Skinny Tables, you can’t select a component of a custom address field as partition column.
  • When configuring search results for an object, custom address fields aren’t supported in Search Filter Fields (only available in Salesforce Classic). If you specify a custom address field as a Search Filter Field in a search layout, package installation and Metadata deploy() fails.
  • Compound address fields aren’t supported in reports. To include a custom address field in a report, add the individual address components, such as street, city, state, and zip.
  • You can experience slow load times when running reports that contain a custom address field.
  • When using a custom address field in a Data Integration Rule, the Country and State components are unavailable for field mapping.
  • If you add a state in the State and Country picklist with a name and code that match the name and code of an existing state in another country, an error is thrown when you create a record that contains a custom address field.
  • You can’t rename the labels for the individual components of a custom address field.
  • The labels for the components of a custom address field are always displayed in English (US), regardless of the org default language and user’s personal language.
  • You can localize the label of a custom address field. However, you can’t localize the labels of the individual components within a custom address field.
  • The word “Address” isn’t appended to the section label for a custom address field. If you include the word “Address” in the field label, it’s included in the label for every component. For example, “Warehouse Address (State)” instead of “Warehouse (State)”. These labels are inconsistent with the label behavior for standard address fields.
  • The length of the GeoCodeAccuracy field for custom fields of data type Address isn’t consistent with Standard field of type Address.