Extend Salesforce with Clicks,

Not Code
Salesforce, Summer ’23

@salesforcedocs
Last updated: July 27, 2023
© Copyright 2000–2023 Salesforce, Inc. All rights reserved. Salesforce is a registered trademark of Salesforce, Inc., as are other

names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS

Extend Salesforce with Clicks, Not Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Lightning Platform Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Customize Your Salesforce Org . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Set Up Your Data Your Way . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Build Your Own Salesforce App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Lightning App Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Manage Your Notifications with Notification Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Custom Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Extend the Reach of Your Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Build Your Own Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
Resources for the Point & Click Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1266

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
EXTEND SALESFORCE WITH CLICKS, NOT CODE

Ready to go beyond the basics of Salesforce administration? Want to customize your org, push its boundaries, and enhance its functionality?
You can do that and so much more without writing a single line of code. All you need is your mouse and a sense of adventure. Enhance
your objects, data, and fields, customize your org’s look and feel, augment your business processes, create websites, and even create
apps—all using point-and-click tools.

Lightning Platform Home Page

The Lightning Platform Home page in Setup is the jumping off point for customizing your org, finding important setup tools and
information, and building and managing applications.
Customize Your Salesforce Org
You can customize each of the standard tabs and types of records, including adding custom fields and setting page layouts. You
can also customize search, tagging, and user interface options for your org. In addition, every Contact Manager, Group, Professional,
Enterprise, Unlimited, and Performance Edition user can customize various personal display options.
Set Up Your Data Your Way
Optimize your Salesforce data to fit the unique needs of your users. You can create your own objects with data that fits together in
the ways that make the most sense for you.
Build Your Own Salesforce App
An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic and
Lightning. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning
Experience. You can customize both types of app to match the way your users work.
Manage Your Notifications with Notification Builder
Keep your users in the know with timely notifications, whether they’re at their desks or on the go. Create custom notifications to
give your users new information and reminders. Choose whether Salesforce notifications appear on desktop, mobile, Slack, or at all.
Custom Domains
Provide a branded experience for users who access your external-facing Salesforce content by serving your Digital Experiences or
Salesforce Sites on a domain that you own, such as https://www.example.com.
Extend the Reach of Your Organization
Sometimes your users need to work with data and services that are outside your Salesforce org. There’s a variety of ways you can
provide seamless access across org boundaries.
Build Your Own Web Site
Site.com and Salesforce Sites are legacy systems to create sites using Salesforce.
Resources for the Point & Click Administrator
In addition to online help, Salesforce creates guides and tip sheets to help you learn about our features and successfully administer
Salesforce.

1
Extend Salesforce with Clicks, Not Code Lightning Platform Home Page

Lightning Platform Home Page

The Lightning Platform Home page in Setup is the jumping off point for customizing your org,
EDITIONS
finding important setup tools and information, and building and managing applications.
You access the Lightning Platform Home page from Setup. Available in: both Salesforce
Classic (not available in all
In Lightning Experience:
orgs) and Lightning
• The left sidebar, which you can browse or search, provides access to all setup actions, tasks, Experience
and tools.
Available in: all editions
• The Quick Find lets you quickly navigate to any node using a keyword. Quick Find is the best except Database.com
way to find what you’re looking for if you know its name.
• The Create menu gives you quick access to common Setup creation functions—including users,
custom objects, custom tabs, apps, email templates, and processes—without having to drill USER PERMISSIONS
down through the Setup tree to get the page. You can get to the Create menu from any page To access the Lightning
in Setup. Platform Home page:
• A carousel of quick-access tiles gives you instant access to important setup tools and information, • Customize Application
as well as the release notes. There’s a link to download SalesforceA—which lets you do Salesforce
administration from a mobile app—and a link to the System Status screen so you can view
your org’s performance and usage data.
• The Most Recently Used list shows your most recently used records or customization features in Setup. You can quickly link back to
what you were working on by clicking its name.
• The Object Manager provides a one-stop shop for managing all objects in your org, both standard and custom.
In Salesforce Classic:
• The left sidebar, which you can browse or search, provides access to all setup actions, tasks, and tools.
• The Getting Started box contains a tool for generating a basic app in a single step and links to information about extending and
managing apps. This box doesn’t appear if you’ve previously dismissed it.
• The Recent Items list shows recent metadata items that you’ve viewed, edited, or created and their related objects.
• The System Overview messages box displays messages to remind you when your org reaches its usage limits. The System Overview
messages box isn’t enabled by default.
• The Quick Links box provides links for managing tools, users, apps, security, and data.
• The Community box showcases available resources. If you’ve previously dismissed this box, it reappears with each new release.
• The right pane includes external links that are useful for developers and administrators.

Configure System Overview Messages

Add system overview usage messages to the Salesforce Home page to remind you when your org approaches its limits. You can
expand, collapse, and dismiss the system overview messages that appear on the Home page. By default, the system overview home
page messages are enabled.
Select Which Fields Appear in the Recently Viewed List
As a Salesforce admin, you can customize the Recently Viewed list that appears on the Setup home page for most standard and
custom objects. Choose and order the fields to display so that your users see the information that’s most important for your company.
Recent Items List (Beta)
The Recent Items list in Salesforce Classic shows recent metadata items that you’ve viewed, edited, or created and their related
objects.

2
Extend Salesforce with Clicks, Not Code Configure System Overview Messages

Quick Access Menu

The quick access menu offers handy shortcuts to customization features.

Configure System Overview Messages

Add system overview usage messages to the Salesforce Home page to remind you when your org
EDITIONS
approaches its limits. You can expand, collapse, and dismiss the system overview messages that
appear on the Home page. By default, the system overview home page messages are enabled. Available in: both Salesforce
Note: The system overview page shows only the items enabled for your org. For example, Classic (not available in all
orgs) and Lightning
your system overview page shows workflow rules only if workflow is enabled for your org.
Experience
1. From Setup, enter System Overview in the Quick Find box, then select System Overview.
Available in: All Editions
2. Click Configure Messages. except Personal and
3. Select or deselect the types of system overview messages to show or hide on the Home page. Database.com
4. Click OK.
USER PERMISSIONS
Important: System overview messages only appear on the Salesforce Home page when
your org approaches its limits. To configure system
When you enable or dismiss system overview messages, it only impacts your individual view of the messages:
messages. • Customize Application

Select Which Fields Appear in the Recently Viewed List

As a Salesforce admin, you can customize the Recently Viewed list that appears on the Setup home
EDITIONS
page for most standard and custom objects. Choose and order the fields to display so that your
users see the information that’s most important for your company. Available in: Lightning
Experience
Note: These steps work in Lightning Experience. If you see the App Launcher icon ( ) on
the left side of the navigation bar at the top of your screen, you're in Lightning Experience. If Available in: Essentials,
not, you're in Salesforce Classic. Group, Professional,
Enterprise, Performance,
For most list views, your users can select which fields to display and how to order the view columns.
Unlimited, and Developer
However, they can’t edit the recent records quick list on object home pages. Only Salesforce admins
Editions
can select and order the fields to display for the recent records quick list. Admins can’t make any
other changes to this default list.
1. From Setup, at the top of the page, select Object Manager.
USER PERMISSIONS

2. Click the label name of the object for the Recently Viewed list you want to modify. To customize recent records
list
3. From the menu of links at the top of the page, click Search Layouts.
• Customize Application
4. In the far right of the Search Results row, click and select Edit.
Recently viewed lists use the Search Results search layout in Lightning. In Classic, recently
viewed lists use the Tab search layout.

5. To add columns to the Recently Viewed list, select one or more fields from Available Fields and click Add. To remove columns, select
one or more fields from Selected Fields and click Remove.
6. Order columns by selecting one or more fields from Selected Fields and clicking Up or Down.
7. Click Save.

3
Extend Salesforce with Clicks, Not Code Recent Items List (Beta)

Example: Your users collaborate on opportunities. To make it easy to see who worked on a recent opportunity last, select Last
Modified By from the Available Fields list. Click Add to move it to Selected Fields. Now this information appears on the Recently
Viewed list on the Opportunities home page.
In the Salesforce mobile app, the Recently Viewed list is the same list view as the desktop list view, with a few differences.
• The Recently Viewed list shows up to two fields for each record. To see more than two fields, tap .
• The fields shown come from the search results layout for the object. Any user with the Edit user permission for an object can add
up to 10 fields. On desktop, go to Setup > Customize > {Object Name} > Search Layouts > Search Results. A user’s changes
also affect which fields are shown on the search results page.

Note: In the Salesforce mobile app, a Recent list appears below the list views on an object’s home page. It’s an automatically
generated list of recently accessed records. It isn’t a list view and can’t be modified.

Recent Items List (Beta)

The Recent Items list in Salesforce Classic shows recent metadata items that you’ve viewed, edited,
EDITIONS
or created and their related objects.

Note: The Recent Items list is in beta. It’s production quality but has known limitations. Available in: Salesforce
Classic (not available in all
The Recent Items list includes: orgs)
• Apex classes Available in: all editions
• Apex triggers except Database.com
• Approval processes
• Apps
• Custom report types
• Email templates
• Fields
• Lightning pages
• Objects
• Page layouts
• Permission sets
• Profiles
• Record types
• Static resources
• Tabs
• Users
• Validation rules
• Visualforce pages
• Visualforce components
• Workflow email alerts
• Workflow field updates
• Workflow outbound messages
• Workflow rules

4
Extend Salesforce with Clicks, Not Code Quick Access Menu

• Workflow tasks

Note: The Recent Items list in Salesforce Classic Setup is independent of the Recent Items section in the sidebar column of many
Salesforce pages. The list in Setup shows items that administrators use, while the Recent Items section in the sidebar displays
records with which end users have worked.

Quick Access Menu

The quick access menu offers handy shortcuts to customization features.
EDITIONS
When you're working on apps or objects, use this menu to jump to relevant app customization
features. It's available from object list view pages and record detail pages. Available in: Salesforce
Classic (not available in all
Note: If drag-and-drop scheduling on list views is enabled, the quick access menu isn't visible orgs)
for list views on accounts, contacts, and custom objects.
Available in: Contact
• To expand or collapse the menu, click (or press ALT+;).
Manager, Group,
• To scroll down the list of the menu, press TAB. Professional, Enterprise,
• To select an option on the menu, press ENTER. Performance, Unlimited,
and Developer Editions
• To remove the menu from all list views and record pages, click Turn off menu.
To restore the quick access menu:
USER PERMISSIONS
1. From your personal settings, enter Advanced User Details in the Quick Find box,
then select Advanced User Details. No results? Enter Personal Information in the To view the quick access
Quick Find box, then select Personal Information. menu:
• Customize Application
2. Click Edit.
3. Select the Quick Access Menu checkbox.
4. Click Save.

SEE ALSO:
Personalize Your Salesforce Experience

5
Extend Salesforce with Clicks, Not Code Customize Your Salesforce Org

Customize Your Salesforce Org

You can customize each of the standard tabs and types of records, including adding custom fields
EDITIONS
and setting page layouts. You can also customize search, tagging, and user interface options for
your org. In addition, every Contact Manager, Group, Professional, Enterprise, Unlimited, and Available in: both Salesforce
Performance Edition user can customize various personal display options. Classic and Lightning
Watch a Demo: Creating a Workflow Rule (Salesforce Classic) Experience

Quick demo of how to customize the way Salesforce looks for your organization. The available customization
options vary according to
To tailor Salesforce for your org, you can customize the display of the various tabs and other items.
which Salesforce Edition you
Select a link to get started on any task.
have.

Find Object Management Settings

USER PERMISSIONS
Salesforce lets you personalize your object model with features like custom fields, page layouts,
and validation rules. Depending on which experience of Salesforce you have enabled, these To view setup options:
customizations are located in different areas of Setup. • View Setup and
Control User Access to Fields Configuration
Use field-level security to control user access to fields. Use page layouts to control the layout To customize your org:
and organization of detail and edit pages in Salesforce, the Self-Service Portal, and the Salesforce • Customize Application
Customer Portal.
Set Page Layouts and Field-Level Security
Page Layouts
Page layouts control the layout and organization of buttons, fields, s-controls, Visualforce, custom links, and related lists on object
record pages. They also help determine which fields are visible, read only, and required. Use page layouts to customize the content
of record pages for your users.
Compact Layouts
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.
Custom Help Content
Tailor help so that users understand how to work within your unique implementation of Salesforce. You can add learning in the flow
of work in several ways. Add custom help for a page, app, object, or org level, or provide links to help in the Utility Bar, Path, or as a
text box on the page. Show users custom resources in a Lightning Experience welcome mat when they first log in. Or, to reach users
with important news, training, and on-boarding information, add micro-learning prompts and walkthroughs to your app.
Tailor Business Processes to Different Record Types Users
Record types let you offer different business processes, picklist values, and page layouts to different users. You can create record
types to differentiate your regular sales deals from your professional services engagements, offering different picklist values for each.
Or you can display different page layouts for your customer support cases versus your billing cases.
Manage Your Translations
If your Salesforce org has multiple languages enabled, manage translations so that your global users can use Salesforce in their
language.

Find Object Management Settings

Salesforce lets you personalize your object model with features like custom fields, page layouts, and validation rules. Depending on
which experience of Salesforce you have enabled, these customizations are located in different areas of Setup.

6
Extend Salesforce with Clicks, Not Code Find Object Management Settings

Find Object Management Settings in Lightning Experience

Salesforce lets you customize your object model with features like custom fields, page layouts, and validation rules. Most objects are
available from the Object Manager in Setup.
Find Object Management Settings in Salesforce Classic
Salesforce lets you personalize your object model with features like custom fields, page layouts, and validation rules. Depending on
which type of object you want to find, these customizations are located in different areas of Setup.
Standard Object Limits
Standard object limits include usage details for object customizations, such as the custom fields you’ve added or sharing rules you’ve
applied to an object.
App Setup Overview

Find Object Management Settings in Lightning Experience

Salesforce lets you customize your object model with features like custom fields, page layouts, and
EDITIONS
validation rules. Most objects are available from the Object Manager in Setup.
Standard Objects and Custom Objects Available in: Lightning
A standard object, such as Account or Contact, comes out of the box with your Salesforce Experience
organization. A custom object is an object that you or another administrator created.
Available in: All editions
From Setup, at the top of the page, select Object Manager. Select one of the objects in the
list, and then select a specific customization from the left pane.

7
Extend Salesforce with Clicks, Not Code Find Object Management Settings

For example, to add a custom field to the Account object, select Object Manager from the top of the Setup page. Next, select
Account, and then Fields & Relationships. Select New.

Note: If you’ve renamed any objects or fields, the Object Manager uses their assigned custom names.

Other Standard Objects

Some standard objects aren’t housed in the Object Manager. Standard objects with more specific purposes and customizations can
be found in Setup using the Quick Find box.
From Setup, enter the object name in the Quick Find box, then select the customization.
Custom Objects
You can also create custom objects from the Object Manager. From Setup, at the top of the page, select Object Manager. Then
select New Object.

External Objects
An external object is similar to custom objects, except that it maps to data that’s stored outside your Salesforce organization.
From Setup, enter External Objects in the Quick Find box, then select External Objects. Next, click one of the external
objects in the list. Then scroll to the section for the specific customization.
For example, to add a custom field to the Orders external object, enter External Objects in the Quick Find box, then select
External Objects. Click Orders, and then scroll to Custom Fields and Relationships.

SEE ALSO:
Point-and-Click Customization: What’s Different or Not Available in Lightning Experience

8
Extend Salesforce with Clicks, Not Code Find Object Management Settings

Find Object Management Settings in Salesforce Classic

Salesforce lets you personalize your object model with features like custom fields, page layouts,
EDITIONS
and validation rules. Depending on which type of object you want to find, these customizations
are located in different areas of Setup. Available in: Salesforce
Standard Objects Classic
A standard object, such as Account or Contact, comes out of the box with your Salesforce
Available in: All editions
organization.
From Setup, enter the name of the appropriate object in the Quick Find box, then select
the specific customization.
For example, to add a custom field to the Case object, enter Case in the Quick Find box, then select Fields under Cases.
Custom Objects
A custom object is an object that you or another administrator created.
From Setup, enter Objects in the Quick Find box and select Objects. Next, click one of the custom objects in the list. Then
scroll to the section for the specific customization.
For example, to add a custom field to the Job Applications object, enter Objects in the Quick Find box, then select Objects.
Click Job Applications, and then scroll to Custom Fields and Relationships.
External Objects
An external object is similar to custom objects, except that it maps to data that’s stored outside your Salesforce organization.
From Setup, enter External Objects in the Quick Find box, then select External Objects. Next, click one of the external
objects in the list. The scroll to the section for the specific customization.
For example, to add a custom field to the Orders external object, enter External Objects in the Quick Find box, then select
External Objects. Click Orders, and then scroll to Custom Fields and Relationships.

Standard Object Limits

Standard object limits include usage details for object customizations, such as the custom fields
EDITIONS
you’ve added or sharing rules you’ve applied to an object.
The list varies depending on the object. When a customization exceeds the allowed limit for the Available in: both Salesforce
object, or reaches 75% of the limit, a tip displays that suggests what you can do next. Classic and Lightning
Experience
Refer to the standard object limits page when you’re planning to customize a particular standard
object or to monitor the usage and limits of customizations on that object. Available in: All Editions
To see an object’s usage: except Database.com

• If you’re using Lightning Experience, from Setup, open the Object Manager, click the name of
the object you want to see the usage for, and then go to Object Limits.
• If you’re using Salesforce Classic, from Setup, enter the object name in the Quick Find box, and then select Limits under that object.

Note: The object limit percentages are truncated, not rounded. For example, if your org uses 95.55% of the limit for a particular
customization, the object limit displays 95%.

9
Extend Salesforce with Clicks, Not Code Rename Object, Tab, and Field Labels

Rename Object, Tab, and Field Labels

You can change the name of almost any object, field, or tab in Salesforce. This simple adjustment
EDITIONS
lets you continue using the terminology your users already know and helps them transition to using
Salesforce. However, Salesforce Help and most pages in Setup always display the original names Available in: both Salesforce
for standard objects, fields, and tabs. Classic and Lightning
For example, you can change the name label for the "Accounts" object and related "Accounts" tab Experience
to "Companies", and change the field "Account Name" to "Company Name." When you rename an
Available in: Essentials,
object, tab, or field, the new name appears on all pages the user sees, in Salesforce for Outlook, and Professional, Enterprise,
in Connect Offline. Performance, Unlimited,
Before renaming tabs, objects, fields, and other related labels, review the implementation tips for and Developer Editions
administrators.
If you use person accounts in your Salesforce org, see Renaming Person Account Labels. USER PERMISSIONS
1. From Setup, enter Rename Tabs and Labels in the Quick Find box, then select Rename
To rename a tab and field:
Tabs and Labels. • Customize Application
2. Select your default language from the Select Language dropdown list at the top of the page. OR
Note: In Hebrew, we recommend keeping tab renaming to a minimum because variable Manage Translation
gender in verbs isn’t supported and verbs can lose gender agreement. OR
If you’re designated as
3. Click Edit next to the tab you want to rename. Click Reset to revert to a tab’s original name.
a translator, you need:
Note: You can’t reset custom object tab names. View Setup and
Configuration
4. Enter the singular and plural forms of the new tab name. Also, if applicable for the language,
To reset renamed tabs:
select Starts with a vowel sound for labels that start with a vowel to ensure that Salesforce
• Customize Application
uses the proper article (such as “a” or “an”). Then click Next.
OR
When you rename a tab or an object, you can’t use the name of another standard tab, custom
object, external object, or custom tab. When you rename an object, a field, or a tab, you can’t Manage Translation
use include these characters: #, $, %, ;, <, =, >, [, ], ^, `, |, and ~. OR
If you’re designated as
5. Enter your labels for the standard field labels and other user interface elements. Be sure to enter a translator, you need:
both a singular and plural form for each label that requires it. Select Starts with a vowel sound
View Setup and
for labels that start with a vowel. Configuration
Note: Some standard fields, such as Created By and Last Modified By, are purposely
omitted from renaming because they track system information.
EDITIONS
6. Click Save.
Repeat this procedure to translate labels into all other languages used in your organization. Available in: Salesforce
Classic (not available in all
Tip: After renaming a tab or object, rename any custom reports, dashboards, profiles, orgs)
permission sets, custom fields, and list views that contain the original name. You can modify
labels using the Translation Workbench. To rename a standard report, click Save As and save Person accounts available
it to a folder designed for your new name. in: Enterprise, Performance,
Unlimited, and Developer
Other tab customization options include: Editions
• Individual users can control which tabs and related lists display for their own logins.
• In addition to the standard tabs provided by Salesforce, users can create entirely new custom
tabs depending on their Edition. For more information, see Custom Tabs.

10
Extend Salesforce with Clicks, Not Code Rename Object, Tab, and Field Labels

• In Enterprise, Unlimited, Performance, and Developer Edition organizations, you can override the tab home page that is displayed
when a user clicks a standard, custom, or external object tab. For more information, see Override Standard Buttons and Tab Home
Pages on page 744.

Renaming Person Account Labels

If your org uses person accounts, you can rename these standard fields.

Field Tab Description

Business Account Accounts An account that isn’t a person account because it doesn’t have a
record type specific to person accounts. This label is primarily used
to clarify the type of accounts you’re importing.

Person Account Accounts A person account.

Business Contact Contacts A contact that is associated with a business account. This label is
primarily used to clarify the type of accounts you’re importing.

When you rename the Person Account field label, the renamed label appears in Salesforce:
• As a prefix to differentiate person account fields such as Birthdate and Home Phone from business account fields. For example,
Person Account: Birthdate is available as an account column in opportunity reports.
• In the name of the Is Person Account field and icon. For example, if you rename the Person Account field to “Consumer,” then Is
Person Account becomes Is Consumer.

Note: The Person Account and Business Account field labels are independent from actual record type names.
• To customize person account record types, from the object management settings for person accounts, go to Record Types.
• To customize business account record types, from the object management settings for accounts, go to Record Types.

SEE ALSO:
Considerations for Renaming Tab and Field Labels
Rename the Chatter Tab
Find Object Management Settings

11
Extend Salesforce with Clicks, Not Code Rename Object, Tab, and Field Labels

Considerations for Renaming Tab and Field Labels

Before renaming standard and custom tabs and fields, learn how those changes affect your users.
EDITIONS
• Most standard tabs and objects can be renamed but not all. For example, the Forecasts tab isn’t
available for renaming. From Setup, enter Rename Tabs and Labels in the Quick Find Available in: both Salesforce
box, then select Rename Tabs and Labels to view a list of the tabs and objects you can rename. Classic (not available in all
orgs) and Lightning
• The renamed labels appear on all user pages in Salesforce, including Personal Setup. In Lightning
Experience
Experience, all pages in the Setup area use the renamed labels. In Salesforce Classic, the Setup
pages in the Setup area use the default, original labels. Available in: Professional,
• Some standard fields, such as Created By and Last Modified By, are purposely omitted from Enterprise, Performance,
renaming because they track system information. Unlimited, and Developer
Editions
• When you rename a tab or an object, you can’t use the name of another standard tab, custom
object, external object, or custom tab.
• When you rename a tab, a field, or an object, you can’t use include these characters: #, $, %, USER PERMISSIONS
;, <, =, >, [, ], ^, `, |, and ~.
To rename tab and field
• After renaming tabs, objects, or fields, check the following additional items to determine which labels:
items need manual updates: • Customize Application
– Review all list view names. List view names continue to display the original object name To reset renamed tabs:
until you change them manually. • Customize Application
– Check standard report names and descriptions for the objects you renamed.
– Update the titles and descriptions of any email templates that contain the original object or field name.
– Manually change any other items you customized with the new object or field name. For example, change any custom fields,
page layouts, and record types that contain the original tab or field name.

• Connect Offline, the Outlook integration, the Gmail integration, and Salesforce for Outlook use your new names.
• When you rename custom tabs for custom objects, the tab label normally appears in the requested language. If there’s no translation
for the requested language, the tab label appears in the default language of the custom object. The custom object default language
is the default language of the org when the object was created.
• If you have renamed tabs, objects, or fields, you can also replace Salesforce Help with another URL. Users can view this URL whenever
they click any context-sensitive help link on an end-user page or within their personal settings. After you replace the help, the Help
& Training link at the top of every page and all Setup pages will continue to display Salesforce Help. For more information, see Define
Org-Level Help in Salesforce Classic on page 113.
• In Hebrew, we recommend keeping tab renaming to a minimum because variable gender in verbs isn’t supported and verbs can
lose gender agreement.

SEE ALSO:
Rename Object, Tab, and Field Labels

12
Extend Salesforce with Clicks, Not Code Control User Access to Fields

Control User Access to Fields

Use field-level security to control user access to fields. Use page layouts to control the layout and
EDITIONS
organization of detail and edit pages in Salesforce, the Self-Service Portal, and the Salesforce
Customer Portal. Available in: both Salesforce
Important: When you use page layouts to hide fields from detail and edit pages, users can Classic and Lightning
Experience
still see these fields via reports, search results, list views, and the API. To restrict field access,
use field-level security. Search doesn’t return results for records with fields protected by field Page layouts and search
level security. In some rare situations, when search terms match field values protected by layouts available in: All
field-level security, the associated records are returned but without the protected fields and Editions
their values. Don’t use page layouts to secure data. For example, removing the Edit button
Field-level security available
from a page layout doesn’t prevent users from using inline editing. To prevent users from
in: Enterprise, Performance,
editing data, use sharing rules, field-level security, page layout field properties, validation
Unlimited, Developer, and
rules, object permissions, and Visualforce pages.
Database.com Editions

Field-Level Security
• Restrict users’ access to view and edit fields. For example, restrict access in reports, search results, list views, related lists, email, and
mail merge templates, custom links, Connect Offline. Also restrict API access and when synchronizing data or importing personal
data.
• Override less-restrictive field access settings in page layouts and mini page layouts. For example, if a page layout requires a field
that’s read-only in field-level security settings, the field remains read-only for the user.
• Override less-restrictive field settings in search layouts. For example, if a field is visible in the search layout but hidden via field-level
security settings, the field remains hidden.

Page Layouts
• Control the layout and organization of detail and edit pages.
• Control which fields, related lists, and custom links users see, on detail and edit pages only.
• Control which standard and custom buttons display on detail pages and related lists.
• Determine whether fields are visible, read only, or required, on detail and edit pages only.
• Determine the fields that users can import data into.
• In Personal, Contact Manager, Group, and Professional Editions, page layouts control which fields users can access in:
– related lists and list views
– reports
– Connect Offline
– email and mail merge templates
– custom links
Page layouts also control field access when synchronizing data.
• In Professional, Enterprise, Unlimited, Performance, and Developer Editions, determine aspects of mini page layouts, including:
– record type
– profile associations
– related lists
– fields and field access settings

13
Extend Salesforce with Clicks, Not Code Set Page Layouts and Field-Level Security

The visible fields and related lists of the mini page layout can be further customized. But other items inherited from the associated
page layout can’t be changed on the mini page layout. Mini page layouts display selected fields and related lists of records in the
mini view of the console.

Tip: To automatically add a field to all page layouts and make it visible and required everywhere regardless of field-level security,
make it a universally required field.

SEE ALSO:
Page Layouts
Customize Search Layouts to Show Results Users Want

Set Page Layouts and Field-Level Security

Use field-level security as the means to restrict users’ access to fields; then use page layouts primarily
EDITIONS
to organize detail and edit pages within tabs. This reduces the number of page layouts for you to
maintain. For example, if a field is required in the page layout and read only in the field-level security Available in: both Salesforce
settings, the field-level security overrides the page layout and the field will be read only for the user. Classic and Lightning
Experience
For Personal, Contact Manager, and Group Editions Page layouts and search
layouts available in: All
1. Create custom fields.
Editions
2. Create any custom buttons or links.
Field-level security available
3. Create any custom s-controls. in: Professional, Enterprise,
4. Define page layouts. All users automatically use the same page layout for each object. Performance, Unlimited,
and Developer Editions
5. Set the related objects and the mini page layouts that display in the console.
6. Define search layouts. All users use the same search layouts.

For Professional, Enterprise, Unlimited, Performance, and Developer Editions

1. Create custom fields.
2. Create any custom buttons or links.
3. Create any custom s-controls.
4. Create any custom profiles.
5. Create record types for different business scenarios.
6. Assign which record types are available to users with different profiles.
7. Set the field-level security for each profile to restrict users’ access to specific fields.
8. Define page layouts to organize your pages.
9. Set the related objects and the mini page layouts that display in the console.
10. Assign page layouts to users based on profiles and record types.
11. To verify that all field access settings are correct, check the field accessibility grid.
12. Define search layouts. All users use the same search layouts.

14
Extend Salesforce with Clicks, Not Code Page Layouts

Tip: Click Preview while editing a page layout to see how the page will look for users with different profiles. This preview includes
any extra security that is set in field-level security.

SEE ALSO:
Field-Level Security

Page Layouts
Page layouts control the layout and organization of buttons, fields, s-controls, Visualforce, custom
EDITIONS
links, and related lists on object record pages. They also help determine which fields are visible,
read only, and required. Use page layouts to customize the content of record pages for your users. Available in: both Salesforce
Page layouts can include s-controls and Visualforce pages that are rendered within a field section Classic and Lightning
when the page displays. You can control the size of the s-controls and Visualforce pages, and Experience
determine whether a label and scroll bars display.
Page layouts available in: all
Salesforce has two drag-and-drop tools for editing page layouts: the original page layout editor editions
and an enhanced page layout editor. The enhanced page layout editor is enabled by default, and
Creation and deletion of
provides all the functionality of the original editor, as well as additional functionality and an
page layouts available in:
easier-to-use interface.
Professional, Enterprise,
You can enable the original page layout editor in the User Interface settings. Your Salesforce org Performance, Unlimited,
can use only one page layout editor at a time. and Developer Editions
From within a page layout, you can access a mini page layout. The mini page layout defines the
hover details that display when you mouse over a field on an object’s detail page in the Agent
console or in the Recent Items section of the sidebar in Salesforce Classic.
Salesforce automatically creates a default page layout when you create a custom object. If you don’t use any page layout with your
custom object, you can still interact with it by using the Lightning Platform API to manage custom data or build a custom user interface.

Create Page Layouts

With the enhanced page layout editor, you can tailor record page layouts to the needs of your users.
The Enhanced Page Layout Editor
The enhanced page layout editor is a tool for customizing your page layouts in Salesforce, the Self-Service Portal, and the Salesforce
Customer Portal. The enhanced page layout editor has all the functionality of the original page layout editor, but has more features
and an easier-to-use interface.
Assign Page Layouts to Profiles or Record Types
After defining page layouts, assign which page layouts users see. A user’s profile determines which page layout he or she sees. In
addition, if your organization is using record types for a particular object, the combination of the user’s profile and the record type
determine which page layout is displayed when a user views records for that object.
Edit Multi-Line Layouts for Opportunity Products
Customize the columns that display when users add or edit items in the Products related list of an opportunity detail page.
Customize Related Lists
You can customize the buttons, columns displayed, column order, and record sort order of related lists on record detail pages in
Salesforce and the Salesforce Customer Portal.
Customize Standard and Custom Buttons on Page Layouts
When customizing page layouts, you can control which standard and custom buttons are displayed and the order in which the
custom buttons appear.

15
Extend Salesforce with Clicks, Not Code Page Layouts

How Page Layout Elements Display in Lightning Experience

When you customize your page layouts in Salesforce Classic, those changes can affect the content of object record pages in Lightning
Experience. However, in Lightning Experience, the page elements display differently and some aren’t supported.
Page Layout Tips
Here are a few tips to keep your page layouts organized and easy to use.
Page Layout Considerations
Keep these considerations in mind when working with page layouts in the enhanced page layout editor.
Page Layout Limitations
Keep these limitations in mind when working with page layouts in the enhanced page layout editor.
How Page Layouts Work in the Salesforce Mobile App
Use the enhanced page layout editor to customize the layout of an object’s record detail pages, configure actions, and adjust which
fields and related lists appear in the Salesforce mobile app.
Manage Mobile Cards in the Enhanced Page Layout Editor
Add expanded lookups, components, and Visualforce pages to the Mobile Cards section of your page layout to have them show up
as mobile cards in the Salesforce mobile app.
Feed-Based Layouts in Salesforce Classic
Feed-based page layouts make it easier to work with records by providing two separate views: one for the record’s feed, and one
for its details, including related lists.
Salesforce Classic Home Tab Page Layouts
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. A dashboard snapshot is a clipping of the top row of a dashboard’s components.
Just like other tabs, you can also assign different home page layouts to different users based on profile.
Customize Page Layouts with the Original Page Layout Editor
Use the original page layout editor to customize page layouts in Salesforce, the Self-Service Portal, and the Salesforce Customer
Portal.

SEE ALSO:
Control User Access to Fields
Customize Search Layouts
Trailhead: Customize Record Details with Page Layouts

16
Extend Salesforce with Clicks, Not Code Page Layouts

Create Page Layouts

With the enhanced page layout editor, you can tailor record page layouts to the needs of your users.
EDITIONS
1. From the management settings for the object that you want to edit, go to Page Layouts.
Available in: Salesforce
2. Create a page layout in one of these ways.
Classic (not available in all
• Click New from the Page Layouts list page. orgs) and Lightning
• Clone an existing layout by clicking New from the Page layouts list page, then selecting a Experience
layout from the Existing Page Layout menu that you want to base the new layout on.
Available in: Enterprise,
• Clone an existing layout by using Save As inside the enhanced page layout editor. Performance, Unlimited,
and Developer Editions
3. Give the layout a name.
4. Click Save.
USER PERMISSIONS

SEE ALSO: To create page layouts:

• Customize Application
Customize Page Layouts with the Enhanced Page Layout Editor
Assign Page Layouts to Profiles or Record Types

The Enhanced Page Layout Editor

The enhanced page layout editor is a tool for customizing your page layouts in Salesforce, the
EDITIONS
Self-Service Portal, and the Salesforce Customer Portal. The enhanced page layout editor has all the
functionality of the original page layout editor, but has more features and an easier-to-use interface. Available in: both Salesforce
The enhanced page layout editor has two parts: a palette on the upper portion of the screen and Classic (not available in all
the page layout on the lower portion of the screen. The palette contains the user interface elements orgs) and Lightning
that you can add to your page layout, such as fields, actions, buttons, links, and related lists. Experience

Available in: All Editions

17
Extend Salesforce with Clicks, Not Code Page Layouts

With the enhanced page layout editor you can:

• Add custom console components, customize the Mini-Page Layout for record pages in Salesforce Classic, configure Multi-Line layouts
(on supported objects), and choose which objects appear in the mini view of the console.
• Customize the highlights panel on Salesforce Classic pages (2). This section isn’t used in Lightning Experience.
• Manage the quick actions that appear in the Salesforce Classic publisher (3) and in Lightning Experience and the Salesforce mobile
app (4). See Quick Actions.
• Add, remove, and reorder:
– Custom and standard buttons on the record page (5).
– Fields in the record details (6).
– Custom links.

18
Extend Salesforce with Clicks, Not Code Page Layouts

– Report charts.

• Customize the related lists that appear on record pages, including configuring related list buttons and selecting which fields display
on a related list. See Customize Related Lists.

Customize Page Layouts with the Enhanced Page Layout Editor

Tailor your page layouts to the needs of your users with the enhanced page layout editor. Add, remove, or reorder actions, buttons,
fields, and sections on a record’s detail page.
User Interface Elements for the Enhanced Page Layout Editor
This list describes the enhanced page layout editor user interface elements and how you can use them in your page layout. To add
elements, drag them from the palette to the layout. Valid drop locations show up in green. To remove elements, drag them off the
layout and back to the palette.
Standard Object Record Page Save Options on Page Layouts
With save options, you can make object-specific checkboxes appear on the edit pages for certain standard objects. Save options
trigger additional processes when a record is saved. You can also set the checkboxes to be selected by default.
Tips for Using the Enhanced Page Layout Editor
Keep these tips in mind when customizing page layouts in the enhanced page layout editor.

SEE ALSO:
Page Layouts

Customize Page Layouts with the Enhanced Page Layout Editor

Tailor your page layouts to the needs of your users with the enhanced page layout editor. Add,
EDITIONS
remove, or reorder actions, buttons, fields, and sections on a record’s detail page.
1. From the management settings for the object that you want to edit, go to Page Layouts. Available in: Salesforce
Classic (not available in all
2. Click on a layout’s row, and select Edit, or simply click the name of the layout.
orgs) and Lightning
3. Add items to the layout by clicking the element type in the palette and dragging an item in Experience
that category onto the layout.
Available in: Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create page layouts:

• Customize Application

19
Extend Salesforce with Clicks, Not Code Page Layouts

4. Remove an item by dragging it from the layout back to the palette, or hover over it and click the remove icon ( ).
5. Make a field ready-only or required by double-clicking it in the page layout and selecting the appropriate checkbox.
6. Save the layout.

SEE ALSO:
User Interface Elements for the Enhanced Page Layout Editor
Page Layout Tips

User Interface Elements for the Enhanced Page Layout Editor

This list describes the enhanced page layout editor user interface elements and how you can use
EDITIONS
them in your page layout. To add elements, drag them from the palette to the layout. Valid drop
locations show up in green. To remove elements, drag them off the layout and back to the palette. Available in: both Salesforce
Important: The Mobile Cards section of the page layout editor is no longer supported as of Classic and Lightning
Experience
Spring ’20. Items in the Mobile Cards section, such as components and expanded lookups,
no longer display in the Salesforce mobile app. For more information, see Mobile Cards Are Available in: All Editions
Not Available in the New Salesforce Mobile App in the Salesforce Spring ’20 release notes.

Analytics Assets
You can add and move an Analytics dashboard to any section on the page layout, except Mobile Cards.
For an Analytics dashboard element, use field mapping to map 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. For more about field mapping or filtering Analytics dashboards, see
Embed Analytics Dashboards in Lightning Pages or Embed Analytics Dashboards in Salesforce Classic Pages.

20
Extend Salesforce with Clicks, Not Code Page Layouts

Blank Spaces
You can add and move blank spaces to any section on the page layout, except Mobile Cards. Use blank spaces to visually align and
distinguish elements on the page.

Note: If you use the original page layout editor to view a page layout that was created in the enhanced page layout editor, the
original page layout editor shows the blank spaces that you added. You can’t move or add blank spaces in the original page layout
editor, but you can remove them by dragging them to the box on the right.

Buttons
You can control which standard and custom buttons are displayed and the order in which the custom buttons appear. You can’t rearrange
standard buttons.
Standard and custom buttons are available as actions in the Salesforce mobile app and Lightning Experience.

Canvas Apps
For the Canvas Apps category to appear in the palette, set the canvas app location to Visualforce Page when you create the canvas app
in Salesforce.
If you add a canvas app to any section other than the Mobile Cards section, the canvas app appears in the page layout in the full Salesforce
site.
Canvas apps added as mobile cards don’t appear in the Salesforce mobile app. To have a canvas app appear on a mobile record page,
add it to the page as a component using the Lightning App Builder.

Components and Expanded Lookups

Components and expanded lookups added as mobile cards don’t appear in the Salesforce mobile app. Expanded lookups are no longer
supported in mobile as of Spring ’20.
To have a News or Twitter component appear on a mobile record page, add it to a Lightning page using the Lightning App Builder.

Fields
A field can display one or more of these icons:
• The field must have a value to save the record, but isn’t required on the page layout itself.
• The field must be included on the page layout because an administrator configured the field as universally required or Salesforce
automatically requires the field. Although you can’t remove such fields, you can move them to different locations.
• The field is a controlling field.
• The field is a dependent field.
• The field is read-only.
To set which fields are required and read-only, select one or more fields and click on any selected field.
• You can’t change the field properties of some standard fields. You can change custom fields only if they aren’t universally required
fields.
• Administrators and users with the Edit Read Only Fields permission can always edit fields marked as read-only.
• If you make a picklist field read-only, all new records contain the default value for that picklist.
• Auto-number fields are always read-only.
• If you mark the opportunity Probability field as read-only, the Probability value is still updated when a user changes the Stage value
of an opportunity.

21
Extend Salesforce with Clicks, Not Code Page Layouts

When working with fields:

• In Personal, Contact Manager, and Group Editions, page layouts control which fields users can access in related lists, list views, reports,
Connect Offline, email and mail merge templates, custom links, and when synchronizing data. In Professional, Enterprise, Unlimited,
Performance, and Developer Editions, field-level security controls this access. Field-level security settings override field properties
that you set on the page layout if the field-level security is more restrictive than the page layout setting.
• Users can import values into a field only if they have read and edit access. User permissions, page layout assignments, and field-level
security settings determine field access.

Quick Actions
In Salesforce Classic, quick actions appear in the Chatter publisher when Chatter Settings are enabled. In Lightning Experience, they
appear in different areas of the user interface, depending on the action’s type. In the Salesforce mobile app, actions of all types appear
in the action bar, the action bar’s action menu, and as list-item actions. See Actions in Lightning Experience and How Page Layouts Work
in the Salesforce Mobile App.
Mobile smart actions appear as a single action element in the page layout editor. In the Salesforce mobile app, the Mobile Smart Actions
element expands to distinct create actions that enable users to create records directly from the action bar. The create actions included
in the set of mobile smart actions vary depending on the page layout’s object.

Note: If you delete an action, the action is removed from all layouts that it’s assigned to.

Related Lists
A page layout can have up to 100 related lists. You can place related lists at the bottom of the page layout. To move a related list on the
page layout, drag the handle located above the related list.
To customize a related list, double-click the related list handle or click inside the handle. Use the related list properties to:
• Specify which fields display as columns on the related list, the order in which they appear, and the sort order of the records in the
related list. In Professional, Enterprise, Unlimited, and Performance Editions, you can also opt to apply the column information to
other page layouts for the same type of object.
• Specify which standard and custom buttons appear on the related list.
When working with related lists on page layouts, note the following:
• Some related lists aren’t customizable because they link to data rather than store it. Related lists that aren’t customizable are indicated
on the page layout.
• You can’t add related lists to the page layouts for the User object.
• In Professional, Enterprise, Unlimited, Performance, and Developer Edition, individual users can customize which related lists display
for their personal use. Administrators can overwrite these user customizations and apply the related list configuration in the page
layout to all users, even if they already customized their display. To overwrite users' related list customizations, click Yes on the
Overwrite Users’ Customized Related Lists window, which appears when saving a page layout if you moved or added a related list.

Report Charts
Report charts are supported in both Salesforce Classic and Lightning Experience.

S-Controls
A page layout can have up to 20 s-controls.
To change the properties of an s-control, double-click the s-control or click its wrench icon ( ) and set the following attributes:

22
Extend Salesforce with Clicks, Not Code Page Layouts

• Width sets the horizontal size in pixels or a percent.

• Height sets the vertical size in pixels.
• Show scrollbars determines whether the iFrame in which the s-control displays contains scroll bars when necessary.
• Show label determines whether the page layout includes the Label of the custom s-control. Remove the label to display the s-control
in a wider area.
S-controls aren’t supported in Lightning Experience.

Sections
You can add and move sections anywhere above the related lists on the page layout. The sections you add can contain fields, s-controls,
and blank spaces. In addition, each page layout has a default section that can only contain custom links and blank spaces. You can
change the location of the custom link section, but you can’t remove it from the page.
The Section user interface element is the second option in the palette when you select the Fields or Custom S-Controls category on the
palette.
To change the attributes of a section, double-click the section or select its associated wrench icon ( ). You can:
• Enter a name for the section. Names of some standard page sections can’t be changed.
• Specify whether the section has one or two columns.
• Specify the order in which users can tab through the items in that section.
• Specify whether the section heading is shown on the detail and edit pages.

Tags
If tags are enabled, click Layout Properties and configure personal and public tags in the header section of the page layout. Users can’t
tag a record if personal or public tags aren’t included in the header section. Also, the positioning of personal and public tags in the header
can’t be modified.
Tags aren’t supported in Lightning Experience.

Visualforce Pages
You can add Visualforce pages to any section on the page layout, except for sections reserved for custom links and related lists. A page
layout can have up to 20 Visualforce pages.
You can add a Visualforce page to a page layout only if the standard controller on the Visualforce page is set to the object for which
you’re creating the page layout. If you don’t have any Visualforce pages with a standard controller set to that object, the Visualforce
Pages category doesn’t appear in the palette.
Visualforce pages added as mobile cards in the page layout editor don’t appear in the Salesforce mobile app. To have a Visualforce page
appear on a mobile record page, add it to the page as a Visualforce component using the Lightning App Builder.

SEE ALSO:
Page Layout Considerations
Page Layout Limitations
The Enhanced Page Layout Editor

23
Extend Salesforce with Clicks, Not Code Page Layouts

Standard Object Record Page Save Options on Page Layouts

With save options, you can make object-specific checkboxes appear on the edit pages for certain
EDITIONS
standard objects. Save options trigger additional processes when a record is saved. You can also
set the checkboxes to be selected by default. Available in: Salesforce
To configure how Salesforce displays the checkboxes, when customizing the page layout in the Classic and Lightning
enhanced page layout editor, click Layout Properties. Experience

Use the Select by default option associated with a checkbox if you want Salesforce to automatically Available in: All Editions
select the option when a user accesses the edit window.
If both Show on edit page and Select by default are selected, the save option checkbox is selected
by default, but users can deselect it to disable the option.

Object Available Save Options

Account “Evaluate this account against territory rules on save” checkbox —Displays the Evaluate
this account against territory rules on save checkbox on account edit pages. Available
only if Enterprise Territory Management is enabled for your org.
Territory assignment rules run automatically when the Default checkbox is selected.

Case • Case Assignment Checkbox— Displays the Assign using active assignment rules
checkbox on case edit pages.
Case assignment rules run automatically when the Default checkbox is selected.

• Email Notification Checkbox — Displays the Send notification email to contact

checkbox on case edit pages.

Case Close • Solution information section — Displays the solution information section on the case
close edit pages.
• Notify contact checkbox — Displays the Notify Contact checkbox on case close edit
pages.

Lead Lead Assignment Checkbox— Displays the Assign using active assignment rule checkbox
on the lead edit page.
Lead assignment rules run automatically when the Default checkbox is selected.

Person Account Evaluate this account against territory rules on save — Displays the Evaluate this account
against territory rules on save checkbox on person account edit pages.
Territory assignment rules run automatically when the Default checkbox is selected.

Task Email notification — Displays the Send Notification Email checkbox on the task edit page.

Note: A user’s personal preference for defaulting the state of the checkbox takes
precedence over the org-wide setting.

24
Extend Salesforce with Clicks, Not Code Page Layouts

Example: The save options from page layouts appear in the footer of the edit window in Lightning Experience. In this case, the
“Evaluate this account against territory rules on save” checkbox option was enabled on the account page layout. When
users edit an account record, they now see the checkbox in the edit window.

SEE ALSO:
Customize Page Layouts with the Enhanced Page Layout Editor
The Enhanced Page Layout Editor
Page Layouts

Tips for Using the Enhanced Page Layout Editor

Keep these tips in mind when customizing page layouts in the enhanced page layout editor.
EDITIONS
• To select multiple elements individually, use Ctrl+click. To select multiple elements as a group,
use Shift+click. Available in: Salesforce
• To change the properties of an element on the page layout, double-click the element or click Classic and Lightning
the wrench icon ( ) next to it. You can’t change the properties of elements in the palette. Experience

• To make a field read-only or required, double-click the field in the page layout and select the Available in: All Editions
appropriate checkbox.
• To access the other layouts for an object with multiple page layouts, click the page layout name
at the top of the page and select another layout to view.
• To change the name of the page layout, add personal and public tags if available, and display standard object checkboxes, click
Layout Properties.

Note: You can’t rename a page layout if you’re using Salesforce Professional Edition.

25
Extend Salesforce with Clicks, Not Code Page Layouts

• In Enterprise, Unlimited, Performance, and Developer Editions, you can select a profile to preview how the pages will look for users
with that profile. Most related lists’ columns preview without data.
• If you’re working with a feed-based page layout, click Feed View to customize the tools and components that appear when users
are working in the feed on a record.
• To choose which fields display on the record detail page and the order in which they appear, click Edit Multi-Line Layout.
• The mini page layout defines the hover details that display when you mouse over a field on an object’s detail page, in the Agent
console, or in the Recent Items section of the sidebar in Salesforce Classic.
• When you’re done customizing the page layout, save it. If you navigate away from your page layout before saving, you lose your
changes.

SEE ALSO:
Page Layout Considerations
Page Layout Limitations
Tips for Optimizing Page Layouts for the Salesforce Mobile App
The Enhanced Page Layout Editor

Assign Page Layouts to Profiles or Record Types

After defining page layouts, assign which page layouts users see. A user’s profile determines which
EDITIONS
page layout he or she sees. In addition, if your organization is using record types for a particular
object, the combination of the user’s profile and the record type determine which page layout is Available in: Salesforce
displayed when a user views records for that object. Classic and Lightning
You can assign page layouts from: Experience

• The object's customize page layout or record type page Page layouts are available
• The original or enhanced profile user interface. in: All Editions

1. From the management settings for the appropriate object, go to Page Layouts or Record Types. Record types are available
in: Professional, Enterprise,
2. Click Page Layout Assignment.
Performance, Unlimited,
3. Click Edit Assignment. and Developer Editions
4. Use the table to specify the page layout for each profile.
The table displays the page layout assignments for each profile. If your organization uses record USER PERMISSIONS
types, a matrix displays a page layout selector for each profile and record type.
To assign page layouts:
When selecting page layout assignments: • Manage Profiles and
• Click a cell, column, or row heading to select all the table cells in that column or row. Permission Sets
• Press SHIFT+click to select multiple adjacent table cells, columns, or rows.
• Press CTRL+click to select multiple nonadjacent table cells, columns, or rows.
• Click any cell and drag to select a range of cells.
• Click Next or Prev to view another set of record types.
Selected page layout assignments are highlighted. Page layout assignments you change are italicized until you save your changes.

5. If necessary, select another page layout to assign from the Page Layout To Use drop-down list and repeat the previous step for the
new page layout.
6. Click Save.

26
Extend Salesforce with Clicks, Not Code Page Layouts

Note: To verify that users have the correct access to fields based on the page layout and field-level security, you can check the
field accessibility grid. From Setup, enter Field Accessibility in the Quick Find box, then select Field Accessibility.
From this page, choose a particular object to view and then select whether you want to check access by profiles, record types, or
fields.

SEE ALSO:
Page Layouts
Assign Page Layouts in the Original Profile User Interface
Assign Record Types and Page Layouts in the Enhanced Profile User Interface
Tailor Business Processes to Different Record Types Users
Control User Access to Fields

Edit Multi-Line Layouts for Opportunity Products

Customize the columns that display when users add or edit items in the Products related list of an
EDITIONS
opportunity detail page.
In Salesforce Classic, the Multi-Line Layout columns appear when you click Edit All from the Products Available in: Lightning
related list on an opportunity detail page. Experience and Salesforce
Classic (not available in all
In Lightning Experience, the Multi-Line Layout columns appear on the Edit All Products window
orgs)
that appears when you click Edit Products or Add Products > Next from the Products related
list on an opportunity record page. Available in: Professional,
Enterprise, Performance,
1. From the object management settings for opportunity products, go to Page Layouts.
Unlimited, and Developer
2. Next to the name of an opportunity product page layout, click Edit. Editions
3. Click Edit Multi-Line Layout.
4. Move fields between Available Fields and Selected Fields. USER PERMISSIONS
Note: Product and Quantity fields are required and can’t be removed from the layout. To edit multi-line layouts for
opportunity products:
5. Click Save. • Customize Application

SEE ALSO:
The Enhanced Page Layout Editor
Page Layouts

27
Extend Salesforce with Clicks, Not Code Page Layouts

Customize Related Lists

You can customize the buttons, columns displayed, column order, and record sort order of related
EDITIONS
lists on record detail pages in Salesforce and the Salesforce Customer Portal.
1. From the management settings for the object you want to edit, go to Page Layouts. Available in: both Salesforce
Classic and Lightning
2. Click on a layout’s row in the list view, and select Edit, or click the name of the layout.
Experience
3. To edit a related list, double-click its tab. If you’re using the enhanced page layout editor, you
can also click the wrench icon ( ). Available in: All Editions
except Database.com
A related list configuration window appears.

USER PERMISSIONS

To customize related lists:

• Customize Application

Note: You can’t customize the History related list because it links to data stored elsewhere.

4. Select the fields to include in the related list, define the order to display the fields, and select the record sort order.

28
Extend Salesforce with Clicks, Not Code Page Layouts

The default sort order is by record ID. You can include up to 10 fields per related list. To display more than four fields in Lightning
Experience, edit the related list component in the Lightning App Builder and choose Enhanced List as the related list type.

5. If desired, select other page layouts to apply your related list customizations to.
Only layouts that include this related list appear in the list. Layouts that include related lists with the same customizations as the
current layout had when you opened it are selected by default.

6. If you have custom list buttons configured for the related list’s object, from the Buttons section header, click + to customize which
standard and custom buttons appear on the related list.

The custom button must be defined for the object contained in the related list, not the parent object, and the button Type must be
List Button. For example, to display a custom button on the Contacts related list of an account, define the custom button for contacts,
not accounts.

7. If you have Create a Record or Update a Record quick actions configured for the related list’s object, you can also add these quick
actions on the related list.

Note: The Quick Actions on Related Lists feature is a Beta Service. Customers 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.

8. If necessary, click Revert to Defaults to undo any customizations and use the default Salesforce settings in the related list.
9. To store your customizations, click OK.
The related list changes aren’t saved until you save the page layout.

10. Save the page layout.

If you add, move, or remove related lists from the layout, then click to save the page layout, you have the option to apply those
related list changes to all users, even if they’ve already customized their display. This action isn’t reversible.

29
Extend Salesforce with Clicks, Not Code Page Layouts

To update the related list type, move the related list on the record page, and more, select the related list on the record page in the
Lightning App Builder. To further customize the list or to reorder the list’s actions from the Lightning App Builder, upgrade to the Dynamic
Related List - single component.

Note: From the User Interface settings in Setup, you can also enable related list hover links so that record detail pages include
links for each related list at the top of the page. Users can hover over the link to display the corresponding related list in an interactive
overlay to view and manage the related list items. Users can also click the link to jump to the content of the related list without
scrolling down the page.

SEE ALSO:
Page Layout Limitations
Page Layout Tips
Control User Access to Fields
Knowledge Article: Unable to Edit a Related List

Customize Standard and Custom Buttons on Page Layouts

When customizing page layouts, you can control which standard and custom buttons are displayed
EDITIONS
and the order in which the custom buttons appear.
1. From the management settings for the object whose page layout you want to customize, go Available in: both Salesforce
to Page Layouts. Classic and Lightning
Experience
2. Click Edit next to the page layout you want to customize.
3. Add, remove, or reorder the buttons on the layout. Available in: All Editions

This process is different depending on which editor you’re using.

• In the enhanced page layout editor, select the Buttons category on the palette and drag
USER PERMISSIONS
one or more buttons from the palette to the buttons section on the page layout. To remove To customize detail page
a button, drag it from the layout back to the palette. buttons:
• In the original page layout editor, double-click the Detail Page Buttons item in the Button • Customize Application
Section.
– To hide any standard button, deselect the checkbox next to the button name.
– To add or remove a custom button, select the button in the Available Buttons list, and click Add or Remove.
– Sort custom buttons by selecting them and clicking Up or Down.
– To undo your customizations and restore default settings, click Revert to Defaults.
– To close the window when you’re done, click OK.

4. Save the page layout.

30
Extend Salesforce with Clicks, Not Code Page Layouts

Note: Standard and custom buttons are also considered actions. In Lightning Experience, buttons are displayed along with quick
actions in different places on a record page depending on the button type. See Actions in Lightning Experience.

SEE ALSO:
Customize Page Layouts with the Enhanced Page Layout Editor
Provide Actions, Buttons, and Links
Override Standard Buttons and Tab Home Pages
Define Custom Buttons and Links

How Page Layout Elements Display in Lightning Experience

When you customize your page layouts in Salesforce Classic, those changes can affect the content
EDITIONS
of object record pages in Lightning Experience. However, in Lightning Experience, the page elements
display differently and some aren’t supported. Available in: Lightning
Here’s a sample contact record in Lightning Experience. The highlights panel (1) contains key record Experience
fields and is the only part of a record page that you can’t customize using the page layout editor.
Page layouts are available
The fields in the highlights panel are customized using a compact layout.
in: All Editions

Creation and deletion of

page layouts is available in:
Enterprise, Performance,
Unlimited, and Developer
Editions

These page layout elements are supported in Lightning Experience.

31
Extend Salesforce with Clicks, Not Code Page Layouts

Actions
Actions display in different places, such as the highlights panel (1), Activity tab (2), and the Chatter tab (3). The actions are derived
from the list of actions in the Salesforce Mobile and Lightning Experience Actions section of the page layout. Some actions aren’t
supported in Lightning Experience.
For more information, see Actions in Lightning Experience.
Blank Spaces
Blank spaces are supported in Lightning Experience.
Canvas Apps
Canvas apps are supported in Lightning Experience.
Custom Links
Custom links display under the Details tab (4).
Fields
On pages that don’t use Dynamic Forms, fields from the page layout display in a block under the Details tab (4). You can remove or
reorder fields on a page layout only via the page layout editor.
On Dynamic Forms-enabled pages, fields can be put almost anywhere on the page, using the Lightning App Builder. A page layout
defines which fields are available for use on the page, but the organization of the fields is done in the Lightning App Builder. See
Break Up Your Record Details with Dynamic Forms.
The top-down tab-key order, which allows users viewing a record detail page to move through a column of fields from top to bottom
before moving focus to the top of the next column of fields, isn’t supported in Lightning Experience. Even if a page layout is configured
for a top-down tab-key order, tabbing moves from left-to-right through field columns in Lightning Experience.
Related Lists
Related lists are included as Lightning components in Lightning Experience, and they appear in the Related tab (5). Not all related
lists are supported in Lightning Experience.
In Lightning Experience, the related list type determines how many fields are displayed in a related list. The Basic List related list type
displays only the first four fields of a related list. The Enhanced List type shows up to 10 fields, lets you resize and sort columns,
perform mass actions, and wrap text. To change the related list type, customize the Related List–Single component or the Related
Lists component in the Lightning App Builder.
Report Charts
Report charts that you add to a page layout appear under the Details tab (4) in Lightning Experience. When you add a report chart
to a page layout, it can take a few moments before the chart appears on Lightning record pages.
Sections
On pages that don’t use Dynamic Forms, sections appear along with fields under the Details tab (4). A section with no header is
incorporated into the section above it.
On Dynamic Forms-enabled pages, sections can be put almost anywhere on the page using the Lightning App Builder. See Break
Up Your Record Details with Dynamic Forms.
A section with no header is incorporated into the section above it.
The Detail Page visibility setting controls whether the section header appears for both the detail page and the edit page. If the section
header is set to display (or hide) on the detail page, the header also displays (or hides) on the edit page.
Standard and Custom Buttons
Standard and custom buttons are treated as actions in Lightning Experience, just like in the Salesforce mobile app. Buttons can
appear in various places on a Lightning page, depending on the button type and the page type. See Actions in Lightning Experience.

Important: Custom buttons that call JavaScript aren’t supported in Lightning Experience.

32
Extend Salesforce with Clicks, Not Code Page Layouts

Visualforce Pages
Visualforce pages that you added to the page layout appear under the Details tab (4). Only Visualforce pages with Available for
Lightning Experience, Experience Builder sites, and the mobile app enabled display in Lightning Experience on Lightning
pages, utility bars, and the Salesforce mobile app.
These page layout elements aren’t supported in Lightning Experience.
• Expanded lookups
• Mobile cards
• S-controls
• Section header visibility for Edit Page
• Tags

Note: The Lightning App Builder is used to customize the layout of Lightning Experience record home pages, not the enhanced
page layout editor.

SEE ALSO:
User Interface Elements for the Enhanced Page Layout Editor
Customize Buttons on the Tabbed Activity Composer
Custom Record Page Settings

Page Layout Tips

Here are a few tips to keep your page layouts organized and easy to use.
EDITIONS
• Use field-level security to restrict users’ access to fields; then use page layouts to organize detail
and edit pages within tabs. This reduces the number of page layouts for you to maintain. Available in: both Salesforce
Field-level security settings override the visible and read-only settings on the page layout if the Classic and Lightning
field-level security has a more restrictive setting than the page layout. Experience
• Remove unnecessary fields. Page layouts available in: all
• Keep the number of required fields to a minimum. editions
• Group similar fields with sections. Creation and deletion of
• Think about the right TAB key order for each section. page layouts available in:
Professional, Enterprise,
• Check your layouts in Read and Edit modes.
Performance, Unlimited,
• Add help and description text to custom fields. Use it to explain to users what data you’re and Developer Editions
looking for in the field.
• In Professional, Enterprise, Performance, Unlimited, and Developer Editions, use record types
to provide unique layouts for different records.
• Optimize related lists—adjust their overall order, the sorting of the records, and display of relevant columns and buttons.
• If you want to customize the user profile layout in the Salesforce mobile app, create a new layout or edit an existing layout in the
User Profile Page Layouts section.
• If a dependent lookup is above its controlling field on a page layout, make its lookup filter optional or redesign the page layout.
Placing a required dependent lookup above its controlling field on a page layout could confuse users who typically start from the
top of the page when entering data.
• A background process periodically runs that cleans up metadata associated with deleted custom fields. This process will affect the
Last Modified Date and Last Modified By fields on page layouts, record types, and custom objects.

33
Extend Salesforce with Clicks, Not Code Page Layouts

• Salesforce recommends creating no more than 200 page layouts. Although there is no limit, it can be difficult to manage your page
layouts if you have more than 200.

Page Layout Considerations

Keep these considerations in mind when working with page layouts in the enhanced page layout
EDITIONS
editor.
Available in: both Salesforce
Usage Considerations Classic and Lightning
Experience
Layout changes made by administrators for record pages don't appear immediately in Lightning
Experience. The record page displays the updated layout about 15 minutes later when you reload Page layouts available in: all
the page. editions

To see your changes immediately, log out and log back in. Other users don't see the change until Creation and deletion of
up to one hour later when they reload the page. This behavior applies to record pages for these page layouts available in:
objects. Professional, Enterprise,
Performance, Unlimited,
• Account and Developer Editions
• Case
• Contact
• Lead
• Opportunity
• Custom objects
This behavior also applies to record layouts updated through the page layout editor, compact layouts, and Lightning pages. For example,
the layout is changed when you add a custom field to an object and add that field to the page layout.
For changes to a Lightning page, such as via the Lightning App Builder, administrators continue to see their changes immediately after
a page reload. However, other users and other browsers don’t see the change up to one hour later when they reload the page. To see
the changes immediately, users can log out and log back in.

Page Layouts
• For Personal, Contact Manager, Essentials, and Group Edition orgs, every user views the same layout. Professional, Enterprise, Unlimited,
Performance, and Developer Edition orgs can create different page layouts for use by different profiles and record types and set
field-level security settings to further restrict users’ access to specific fields.
• In Professional, Enterprise, Performance, Unlimited, and Developer Editions, you can set the mini page layouts and related objects
that appear in the Console tab.
• Elements that are already on the page layout still appear on the palette but are inactive. When you click an inactive element on the
palette, Salesforce highlights the element on the page layout.
• Removing a field from a page layout doesn’t remove it from the object’s compact layout. The two layout types are independent.
• If the original page layout editor is enabled, users can click the page layout name to access the detail page of the page layout. The
enhanced page layout editor doesn’t have detail pages, as all the detail page functionality is always available on the enhanced editor.
Salesforce displays a read-only version of the enhanced page layout editor to users with the “View Setup and Configuration” permission.

Note: The read-only view of the page layout doesn’t display field types and lengths in hover details.

• The Custom Links, Custom S-Controls, and Visualforce Pages categories appear in the palette only if you’ve defined those types of
elements for the object for which you’re defining a page layout. When you create a custom link for an object, you add it to the

34
Extend Salesforce with Clicks, Not Code Page Layouts

Custom Links section on that object’s page layout. In non-English Salesforce orgs, the “Custom Links” section title isn’t translated
from English automatically for the Territory and Territory Model objects, but you can edit the section title.
• The Canvas Apps category appears in the palette only if you defined at least one canvas app with a location of Visualforce Page.
• The Components category appears in the palette only if the available components are supported by the object for which you’re
defining a page layout. For example, the Twitter component is supported only on account, contact, and lead page layouts.
• When you edit an account page layout for use in Salesforce Classic, the following applies:
– On business accounts, you can display a Copy Billing Address to Shipping Address link. On the page layout, in the Address
Information section, select the option to display the section header on the Edit page. Next to the Billing Address field, add the
Shipping Address field.
– You can also display a link on person accounts. On the page layout, in the Address Information section, select the option to
display the section header on the Edit page. Next to the Billing Address field, add the Shipping Address or the Mailing Address
field. The link says Copy Billing Address to Shipping (or Mailing) Address.
– Contact fields and related lists are available on person account page layouts, but contact custom links and custom buttons aren’t.

• Currently, you can't change the location of Chatter feeds. However, in Salesforce Classic, users can click the Hide Chatter link
in a Chatter feed to hide the feed, and the Show Chatter link to show the feed.
• Changes to user layouts override the global publisher layout on user profile pages and the Chatter home page.

Mini Page Layouts

• In Professional, Enterprise, Performance, Unlimited, and Developer Editions, you can set the mini page layouts and related objects
that appear in the Console tab.
• Field properties on the page layout determine field properties on the mini page layout. For example, if a field is read-only on the
page layout, that same field is read-only on the mini page layout. To change the field properties of fields on the mini page layout,
you must change the field properties of fields on the page layout.
• Overrides for the Edit and View buttons for an object don’t affect the Edit and View buttons in mini page layouts.
• Fields marked Always Displayed or Always on Layout on page layouts are automatically included on the mini page
layout and can’t be removed unless they’re removed from the page layout.

Knowledge Layouts
• Authoring actions that you add to the Salesforce Mobile and Lightning Experience Actions section of the page layout appear in the
highlights panel on record pages in Lightning Experience and the Salesforce mobile app.
• To use inline edit with Knowledge, add the Publication Status field to your standard page layout. The Publication Status field must
be in the standard page layout, not in a compact layout. However, the field can appear in both the standard and compact layouts.

Tip: If the Publication Status field is in a collapsed layout section, you must expand the section to load the edit icons before
you can use inline editing. To increase the accessibility of inline editing, add the Publication Status field to a layout section
that is likely to always be open.

• The Title and URL Name standard fields are required. You can’t remove them from the layout.

35
Extend Salesforce with Clicks, Not Code Page Layouts

• To control which audiences can view an article, add these fields to the page layout: Visible in Internal App; Visible to Customer; Visible
to Partner; and Visible in Public Knowledge base. The fields appear as checkboxes in the record.

SEE ALSO:
Tips for Using the Enhanced Page Layout Editor
Page Layout Limitations
User Interface Elements for the Enhanced Page Layout Editor

Page Layout Limitations

Keep these limitations in mind when working with page layouts in the enhanced page layout editor.
EDITIONS

Page Layouts Available in: both Salesforce

Classic and Lightning
• If you’re using Salesforce Professional Edition, you can’t rename a page layout. Experience
• You can drag up to 20 s-controls, 20 Visualforce pages, 20 expanded lookups, and 100 related
Page layouts available in: all
lists onto a page layout. There are no limits on custom links.
editions
Note: You can’t place a Visualforce page more than one time on a page layout.
Creation and deletion of
page layouts available in:
• In Lightning Experience, page layouts support up to 55 lookup fields. In Salesforce Classic, page
Professional, Enterprise,
layouts support up to 40 lookup fields. Performance, Unlimited,
• Don’t add more than four external lookup fields to your page layout. On Lightning Experience and Developer Editions
record pages, a Record Detail component that contains more than four external lookup fields
breaks the page at runtime.
• You can add one dashboard per page layout.
• Page layouts for the user object only include custom fields, custom links, s-controls, and Visualforce pages. Tagging, related lists,
custom buttons, and standard field customizations aren’t included on page layouts for the user object. Also, field-level security is
only available for custom fields on the user object. Only standard Chatter actions appear on the user profile page, regardless of which
actions are assigned to the User Page Layout or the global publisher layout.
• You can edit only certain attributes when you’re working with a page layout that was installed from a managed app. Some changes
that you make to managed page layouts, such as adding components, work when you’re editing the page layout but aren’t reflected
on the record detail page.
• Chatter group layout changes affect the Salesforce mobile app only. Changes to the group publisher (actions and layout) reflect in
both the full Salesforce site and the Salesforce mobile app.

• Custom fields installed from a managed package aren’t translated when they appear in the page layout editor.

Related Lists
• A page layout can have up to 100 related lists.
• The View All button only displays up to 2,000 items in a related list.
• You can’t add related lists to the page layouts for the User object.
• You can include up to 10 fields per related list.
• In Lightning Experience, the related list type determines how many fields are displayed in a related list. The Basic List related list type
displays only the first four fields of a related list. The Enhanced List type shows up to 10 fields, lets you resize and sort columns,

36
Extend Salesforce with Clicks, Not Code Page Layouts

perform mass actions, and wrap text. To change the related list type, customize the Related List–Single component or the Related
Lists component in the Lightning App Builder.
• Users can’t drag documents to add them to Files or Notes & Attachments related lists when the related list type is Basic List.
• You can’t move the first field of a related list, because it’s a unique identifier for the record.
• You can add custom fields of the long text area type to a related list. However, you can’t add some standard fields of the long text
area type. For example, you can’t add the Description field on an Opportunity to a related list.
• The default sort order varies per record. The Sort By dropdown isn’t available for activities and opportunity products.
• Lookup fields aren’t available for display on their corresponding lookup related list. For example, the case lookup field on an account
page layout isn’t available when editing the cases related list.
• You can’t customize the History related list because it links to data stored elsewhere.

Mini Page Layouts

• You can’t choose Mini Console View for the Close Case layout, Log a Case page, or View Cases page layouts on the Self-Service Portal.
You can’t choose Mini Console View for opportunity team page layouts.
• You can’t define mini page layouts for the Close Case layout, Log a Case page, or View Cases page layouts on the Self-Service Portal.
You can’t define mini page layouts for opportunity team page layouts.
• You can define mini page layouts for the user object; however, you can’t add standard fields or related lists. Also, a customized mini
page layout won’t display in the Agent console.

SEE ALSO:
Tips for Using the Enhanced Page Layout Editor
Page Layout Considerations

How Page Layouts Work in the Salesforce Mobile App

Use the enhanced page layout editor to customize the layout of an object’s record detail pages,
EDITIONS
configure actions, and adjust which fields and related lists appear in the Salesforce mobile app.
In the Salesforce mobile app, page layouts drive these areas of the mobile experience. Available in: both Salesforce
Classic and Lightning
Record Related Information and Detail Pages
Experience
When you view a record in the mobile app, you see the fields, Visualforce pages, and related
lists that are based on the record type and the user’s profile. Related lists show up as single-line Available in: All editions
cards containing the name of the page or related list. Tapping the related list card displays its except Database.com
details.
Actions
Actions in the Salesforce Mobile and Lightning Experience Actions section of a page layout appear in the action bar and action menu
on the object’s record pages.

Example: Here are the record details, related lists, and action menu for a sample account, Edge Communications:

37
Extend Salesforce with Clicks, Not Code Page Layouts

Tips for Optimizing Page Layouts for the Salesforce Mobile App
Here are some tips and tricks for making your existing page layouts more mobile-friendly.

Tips for Optimizing Page Layouts for the Salesforce Mobile App
Here are some tips and tricks for making your existing page layouts more mobile-friendly.
EDITIONS
Page layouts containing dozens of fields and lots of related lists might be manageable when viewing
records on a computer screen, but on a small mobile device, viewing that same record can be Available in: both Salesforce
overwhelming. People accessing information using a mobile device are looking for a quick way to Classic and Lightning
get what they need, and making your users sift through hundreds of fields and related lists just Experience
doesn’t make sense.
Available in: All editions
When optimizing a page layout, consider: except Database.com
• What are the important things to see at a glance?
• What are the important moments for your users when they’re working in the Salesforce mobile app?
• What actions or processes can you automate so that your users don’t have to manually do them?

The Key: Organize and Minimize Fields

• Use sections to organize information logically, putting the most important things at the top of the page so they show up first. Your
users don’t want to search for fields individually. Organizing similar fields in sections will help your users find what they need. They
can then easily scroll down the page to the section they care about.

38
Extend Salesforce with Clicks, Not Code Page Layouts

• For accounts, contacts, and leads, you don’t need to put phone or email fields near the top. They’re already quickly accessible via
the and icons on each record page’s action bar.
• You don't need to keep fields in one column, as the page renders dynamically. Salesforce for iOS or Android will reorder the fields
into a single column, while web browsers can show two columns.
• Put the most important fields into the compact layout—which drives record highlights and record preview cards in the mobile
app—so they’re available right up front, and so your mobile users don’t have to drill into the record detail.
• Keep the number of required fields to a minimum. Setting a field to required means it must appear on the detail page of all page
layouts, so consider whether each field is truly required. You might have to convince stakeholders that a field isn’t actually necessary
for a record to be saved.
• If available in your org, think about using record types so that fields that aren’t common to all records don’t have to appear on all
records.
• To reduce the number of fields on a screen, consider using default values for new records instead of having the user enter the data.

SEE ALSO:
How Page Layouts Work in the Salesforce Mobile App

Manage Mobile Cards in the Enhanced Page Layout Editor

Add expanded lookups, components, and Visualforce pages to the Mobile Cards section of your
EDITIONS
page layout to have them show up as mobile cards in the Salesforce mobile app.

Important: The Mobile Cards section of the page layout editor is no longer supported as of Available in: both Salesforce
Spring ’20. Items in the Mobile Cards section, such as components and expanded lookups, Classic and Lightning
Experience
no longer display in the Salesforce mobile app. For more information, see Mobile Cards Are
Not Available in the New Salesforce Mobile App in the Salesforce Spring ’20 release notes. Available in: All editions
except Database.com

Feed-Based Layouts in Salesforce Classic

USER PERMISSIONS
Feed-based page layouts make it easier to work with records by providing two separate views: one
for the record’s feed, and one for its details, including related lists. To create and edit page
layouts:
Available in: Enterprise, Performance, Unlimited, and Developer Editions • Customize Application

Feed-based layouts offer a more streamlined way of working with records, and don’t require users to scroll through information they’re
not interested in to find what they’re looking for. Users can easily switch back and forth between the feed view, which includes the
publisher and important events on the record, shown in chronological order, and the details view, which shows in-depth information
about the record, including related lists.
Unlike standard page layouts, which include all of a record’s information—the feed, details, and related lists—on one page, feed-based
layouts let you switch between the feed view and the details view so you can focus on the type of information you need at any given
moment. For example, to see comments others have made about a record or to create a record that’s related to it, you’d use the feed
view. To delve into the record’s related lists, attachments, and other in-depth information, you’d use the details view.
Feed-based layouts are available on account, asset, case, contact, lead, opportunity, custom, and external objects. To create feed-based
layouts for cases, use Case Feed.

39
Extend Salesforce with Clicks, Not Code Page Layouts

The feed view in these layouts includes:

• Tabs or, if you’re working in the Salesforce console, toggle buttons ( ) to switch between the feed view and the detail view.
(1)
• The publisher, which might include actions that let you do things like create related records or log calls, depending on how your
administrator has set up your organization. (2)
• The record feed, which shows activity on the record, such as comments others have made about it. (3)
• Any custom buttons and links your administrator has added. (4)
• A follow button ( ) or following indicator ( ) and a list of people who follow the record. (5)
Depending on how your administrator has set up the page, these might appear on the left side or on the right side.

• Feed filters, which let you choose which information from the feed you see. (6)
Depending on how your administrator has set up the page, the filters might appear on the left side of the page, in the center, or on
the right.

Detail views show in-depth information about the record, including related lists.

40
Extend Salesforce with Clicks, Not Code Page Layouts

Create Feed-Based Page Layouts in Salesforce Classic

Make it easier for your users to work with account, contact, lead, opportunity, custom, and external object records by creating
feed-based layouts. These layouts include two separate views: one for the record’s feed and one for its details.

Create Feed-Based Page Layouts in Salesforce Classic

Make it easier for your users to work with account, contact, lead, opportunity, custom, and external
EDITIONS
object records by creating feed-based layouts. These layouts include two separate views: one for
the record’s feed and one for its details. Available in: Salesforce
Before you begin, ensure that feed tracking is enabled for the object on which you want to create Classic (not available in all
a feed-based layout. To enable feed tracking, from Setup, enter Feed Tracking in the Quick orgs)
Find box, then select Feed Tracking. Available in: Group,
1. Create a new page layout and select Feed-Based Layout. Professional, Enterprise,
Performance, Unlimited,
Note: Only new page layouts can be feed-based; you can’t change an existing standard Contact Manager, and
layout to a feed-based layout. Developer Editions
2. Click Edit next to your layout and use the enhanced page layout editor to configure it.
You can’t configure feed-based layouts with the original page layout editor. USER PERMISSIONS

3. On the main page layout editor page, customize the publisher to include the actions you want To create, edit, and delete
to make available to users, and add any custom buttons or links. page layouts:
• Customize Application
4. Click Feed View in the page layout editor header to customize what appears on the feed page.
You can:
• Enable full-width feed so the feed expands horizontally when users view records in Salesforce console tabs or subtabs.

41
Extend Salesforce with Clicks, Not Code Page Layouts

• Turn on compact feed so users see a cleaner, more streamlined feed view when working with records in Salesforce console tabs
or subtabs.
• Choose to automatically collapse the publisher when it’s not in use so users can see more of the information below it on the
page.
• Add custom components, which are Visualforce pages with functionality you define.
• Choose where on the page custom buttons and links and standard components like the Follow button and followers list appear.
• Hide the standard sidebar.
• Choose which feed filters are available, and where they appear.

5. Assign the page layout to user profiles.

SEE ALSO:
Feed-Based Layouts in Salesforce Classic
Use Case Feed in Salesforce Classic
Feed Tracking
Enable Feed Updates for Related Records

Salesforce Classic Home Tab Page Layouts

You can customize the Home tab in Salesforce Classic to include components such as sidebar links,
EDITIONS
a company logo, a dashboard snapshot, or custom components that you create. A dashboard
snapshot is a clipping of the top row of a dashboard’s components. Just like other tabs, you can Available in: Salesforce
also assign different home page layouts to different users based on profile. Classic
You can add components to the sidebar or the main panel. You can also determine if custom sidebar
Available in: All Editions
components appear only on the Home tab or on all Salesforce pages.

USER PERMISSIONS
Create Custom Home Page Components
Use custom components to configure the Salesforce Classic home page for your users. Add To view home page layouts:
HTML, images, links, and more to enhance your users’ productivity. • Customize Application
Design Home Page Layouts in Salesforce Classic To create or change home
After creating the components you want displayed on the Home tab, design your home page page layouts:
layouts. You can design your layouts based on your unique organizational and user needs. • Customize Application

Visualforce Area Home Page Components

Use Visualforce Area home page components to add dynamic content to your home page. For example, you can present content
from partner apps, display charts with the Reports and Dashboards REST API, or add a canvas app to the home page.
Home Page Components Tips and Considerations
Keep these considerations in mind when creating custom components that you want displayed on the Salesforce Classic Home tab.
Assign Home Tab Page Layouts to Profiles
Your home page layouts are only visible to users after you assign them to a user profile.

42
Extend Salesforce with Clicks, Not Code Page Layouts

Create Custom Home Page Components

Use custom components to configure the Salesforce Classic home page for your users. Add HTML,
EDITIONS
images, links, and more to enhance your users’ productivity.
Before you begin: Available in: Salesforce
Classic
• If you’re creating custom link components, define your Home tab custom links first. See Custom
Buttons and Links on page 733. Available in: All Editions
• If you’re creating an image component, upload your image to the Documents tab first.
• If you’re creating a Visualforce Area component, create your Visualforce page first. USER PERMISSIONS
1. From Setup, enter Home Page Components in the Quick Find box, then select
To create or change home
Home Page Components. page layouts:
2. Click New. • Customize Application
3. Enter a name for the component. For custom links, this name is displayed as the section heading
in the sidebar on the Home tab.
4. Choose the type of component.
5. Click Next, and then complete one or more of these steps.
• For links, select the appropriate custom links, and then click Add.
• For images, click Insert an image, choose the document folder, and then select the image file. The image file must be in a public
folder and Externally Available must be enabled on the document’s properties so that users can view the image.

Tip: Keep your image size smaller than 20 KB for optimum performance.

• For an HTML Area component, choose where to display it—in the wide or narrow column—and then enter your content in the
box below.

Note: HTML Area home page components don’t support JavaScript, CSS, iframes, and some other advanced markup. To
use JavaScript or other advanced HTML elements in your home page component, we recommend that you use a Visualforce
Area component instead.

• For a Visualforce Area component, choose where to display it—in the wide or narrow column—then select the Visualforce page,
and assign it a height.

6. Click Save.
After creating the home page component, you need to add it to a home page layout. See Design Home Page Layouts in Salesforce
Classic on page 44.

Note: Components in the narrow column are displayed in the sidebar. They aren’t displayed in the sidebar on other pages in
Salesforce unless you specify that in your user interface settings or by assigning the “Show Custom Sidebar On All Pages” permission.

SEE ALSO:
Visualforce Area Home Page Components
Home Page Components Tips and Considerations

43
Extend Salesforce with Clicks, Not Code Page Layouts

Design Home Page Layouts in Salesforce Classic

After creating the components you want displayed on the Home tab, design your home page
EDITIONS
layouts. You can design your layouts based on your unique organizational and user needs.
1. From Setup, enter Home Page Layouts in the Quick Find box, then select Home Available in: Salesforce
Page Layouts. Classic
2. Click to edit an existing layout or create one. Alternately, select a layout to copy and click Clone. Available in: All Editions
3. If you create a layout, give it a name and then click Save.
4. Select the components to display on the layout. USER PERMISSIONS
To add the Find Articles component, select Article Search. This component is only available To view home page layouts:
for Salesforce Knowledge users. • View Setup and
To add the Customer Portal component, select Customer Portal Welcome. If the My Profile Configuration
site Visualforce page has been enabled, this component contains a personalized welcome To create or change home
message and a link to the portal user’s profile. The My Profile page enables users logged into page layouts:
either your Salesforce site, or your Customer Portal from Salesforce sites, to update their own • Customize Application
contact information. When they change this page, the corresponding portal user and contact
records are updated.
To allow your users to resume flow interviews that they’ve paused, select Paused Flow Interviews. This component displays only
flow interviews that the user has paused.

Note: You can add up to 20 components to a home page layout.

5. Click Next.
6. Customize the order in which the narrow and wide components appear. Move a component by selecting it and using the arrow
buttons.
7. Click Save.

SEE ALSO:
Assign Home Tab Page Layouts to Profiles
Salesforce Classic Home Tab Page Layouts

Visualforce Area Home Page Components

Use Visualforce Area home page components to add dynamic content to your home page. For
EDITIONS
example, you can present content from partner apps, display charts with the Reports and Dashboards
REST API, or add a canvas app to the home page. Available in: Salesforce
The Visualforce page that you choose for the component can use a standard or custom controller. Classic (not available in all
You can include JavaScript in your Visualforce page, but because the component is rendered in an orgs)
iframe on the home page layout, the JavaScript can’t interact with the page that contains the
Available in: All Editions
component.

Sample Usage
If your Visualforce Area home page component displays in the sidebar, you can dynamically get the record ID and top-level URL of the
page that the component is being displayed on by using the $CurrentPage global variable in your Visualforce markup.

44
Extend Salesforce with Clicks, Not Code Page Layouts

Using $CurrentPage, you can access the query string parameters for the page by specifying the parameters attribute, after
which you can access each individual parameter:

$CurrentPage.parameters.parameter_name

The parameters for record ID and top-level page URL are, respectively, id and sfdcIFrameOrigin. For more information, see
“Getting Query String Parameters” in the Visualforce Developer's Guide.

Home Page Components Tips and Considerations

Keep these considerations in mind when creating custom components that you want displayed
EDITIONS
on the Salesforce Classic Home tab.
• Standard components without an Edit link are read only. Available in: Salesforce
• The components that you select for the narrow column display in the sidebar. They don’t display Classic
in the sidebar on other pages within Salesforce unless you specify that in your user interface Available in: All Editions
settings. If you only want certain users to view sidebar components on all pages, grant those
users the “Show Custom Sidebar On All Pages” permission.
• When editing the standard Messages & Alerts component, enter the text that you want to display to users. If entering HTML code
for your message, make sure that it’s self-contained, well-formed HTML.

Note: Standard Messages & Alerts home page components don’t support JavaScript, CSS, iframes, and some other advanced
markup.

• When editing the standard Custom Links home page component, enter the link text to display to users in the Bookmark field. In
the URL field, enter the complete website address, such as http://www.yahoo.com. To link to a Salesforce page, enter only
the part of the URL after salesforce.com, for example, /00Ox0000000esq4. These links always open within the main
Salesforce window, not in a popup window.
• The standard Custom Links home page component is a quick way to add links to the sidebar, but it doesn’t support merge fields,
functions (such as URLFOR), executing JavaScript, or customizable window opening properties. If you need this additional functionality:
1. From Setup, enter Home in the Quick Find box, then select Custom Links, and then create your home page custom links
on that page.
2. From Setup, enter Home in the Quick Find box, then select Home Page Components, and then create a custom home
page component of type Links on that page that includes the custom links that you created in the first step. Creating a custom
home page component for your links doesn’t change the visual styling for your end users.

• The Dashboard Snapshot component displays the top three components of the last dashboard the user accessed. Users can
view a dashboard snapshot on their Home tab if they have access to at least one dashboard.
• When designing home page layouts for your Customer Portal, we recommend adding the following components: Search, Solution
Search, Recent Items, Customer Portal Welcome, and a custom HTML Area component that includes your corporate branding in the
wide column.
• You can add up to 20 components to a home page layout.

SEE ALSO:
Create Custom Home Page Components

45
Extend Salesforce with Clicks, Not Code Page Layouts

Assign Home Tab Page Layouts to Profiles

Your home page layouts are only visible to users after you assign them to a user profile.
EDITIONS
1. From Setup, enter Home Page Layouts in the Quick Find box, then select Home
Page Layouts. Available in: Salesforce
Classic
2. Click Page Layout Assignment.
3. Click Edit Assignment. Available in: All Editions

4. Choose the appropriate page layout for each profile.

Initially, all users, including Customer Portal users, are assigned to the Home Page Default layout. USER PERMISSIONS

5. Click Save. To assign home page

layouts:
Tip: Users can customize the dashboard settings on their Home tab in their personal settings. • Customize Application

Customize Page Layouts with the Original Page Layout Editor

Use the original page layout editor to customize page layouts in Salesforce, the Self-Service Portal,
EDITIONS
and the Salesforce Customer Portal.

Note: We recommend using the enhanced page layout editor instead of the original page Available in: Salesforce
layout editor because it offers more features and an easier-to-use interface. Classic

1. From the management settings for the object that you want to edit, go to Page Layouts. Available in: All Editions

2. If tags are enabled, specify whether personal and public tags should be included in the header
section of the page layout. Users can tag a record only if personal or public tags are included USER PERMISSIONS
here.
To customize page layouts:
• To add personal or public tags, select Header Items from the View dropdown list and then • Customize Application
drag the Personal Tags or Public Tags items to the header section. You can’t change the
order in which personal and public tags appear when both are in the header section at the
same time.
• To remove tags, drag the Personal Tags and Public Tags items from the header section to the area under the View dropdown
list.

3. To customize buttons, double-click Detail Page Buttons in the Button section.

4. To arrange fields, custom s-controls, Visualforce pages, custom links, and related lists on the layout, select one or more items from
the box on the right and drag them to the desired location. You can drag up to 20 s-controls, 20 Visualforce pages, 20 expanded
lookups, and 100 related lists onto a page layout. There are no limits on custom links.

Note: You can add a Visualforce page to a page layout only if the standard controller on the Visualforce page is set to the
object for which you’re creating the page layout. If you don’t have any Visualforce pages with a standard controller set to that
object, the Visualforce Pages category doesn’t appear in the palette.

5. To set which fields are required and read only, select one or more fields and click Edit Properties.
• You can change custom fields only if they aren’t universally required fields.
• Fields marked as read only are always editable by administrators and users with the Edit Read Only Fields permission.
• If you make a picklist field read only, all new records contain the default value for that picklist.
• Auto-number fields are always read only.

46
Extend Salesforce with Clicks, Not Code Page Layouts

• If you make the opportunity Probability field read only, the Probability value still updates automatically when a user changes
the Stage value of an opportunity.
• In Professional, Enterprise, Unlimited, Performance, and Developer Editions, field-level security settings override the field properties
you set here if the field-level security is more restrictive than the page layout setting.

6. To change the properties of an s-control or Visualforce page, double-click it and set the following attributes.
• Width sets the horizontal size in pixels or a percent.
• Height sets the vertical size in pixels.
• Show scrollbars determines whether the iFrame in which the s-control displays contains scrollbars when necessary.
• Show label determines whether the page layout includes the label of the custom s-control. Remove the label to display the
custom s-control in a wider area.

7. To organize the page using sections, click Edit next to an existing page section, or click Create New Section.
8. To customize related lists on the page layout, double-click a related list in the Related List section.
Some related lists aren’t customizable because they link to data rather than store it. You can move your cursor over any related list
section to see if it’s customizable. Also, lookup fields aren’t available for display on their corresponding lookup related list. For example,
the case lookup field on an account page layout isn’t available when editing the cases related list.

9. To apply the related lists in the page layout to all users, even if they’ve already customized their display, select Overwrite users’
customized related lists.
10. To review the page layout, click Preview. From the preview in Enterprise, Unlimited, Performance, and Developer Editions, select a
profile to see how the pages look for users with different profiles. Most related lists’ columns preview without data.
11. Click Save to finish. Alternatively, click Quick Save to save and continue editing the page layout.
In Professional, Enterprise, Unlimited, Performance, and Developer Editions:
• To choose which related records display in the Console tab’s mini view, click Mini Console View.
• To define the mini page layouts of the records that appear in the Console tab’s mini view, click Mini Page Layout.

Note: You can’t define mini console views or mini page layouts for the Close Case Layout or the Log a Case Page and View Cases
Page layouts on the Self-Service Portal.
In Enterprise, Unlimited, Performance, and Developer Editions:
• You can assign page layouts for different profile and record type combinations.
• You can set field-level security to restrict field access further.

Notes on Using the Original Page Layout Editor

SEE ALSO:
Notes on Using the Original Page Layout Editor
Customize Related Lists
Page Layouts

47
Extend Salesforce with Clicks, Not Code Page Layouts

Notes on Using the Original Page Layout Editor

• When customizing page layouts for tasks, you can select the following checkboxes. (These
EDITIONS
options are unavailable when user control over task assignment notifications is enabled.)
– Show Task Email Notification checkbox displays the Send Available in: Salesforce
Notification Email checkbox when users create or edit a task. Classic
– Select Task Email Notification checkbox by default selects the Available in: All Editions
Send Notification Email checkbox by default when users create or edit a task.
Note that a user's personal preference for defaulting the state of the checkbox takes
precedence over the organization-wide setting.

• When customizing page layouts for cases, you can select the following checkboxes. (These options are unavailable when user control
over task assignment notifications is enabled.)
– Show on edit page Case Assignment checkbox displays the Assign using active assignment
rules checkbox when users create or edit a case.
– Default Case Assignment checkbox automatically runs case assignment rules.
If both Show on edit page and Select by default are selected, the assignment checkbox is selected by default,
but users can deselect it to override the assignment rule.

– Show Case Email Notification checkbox displays the Send Notification Email checkbox when
users create or edit a case.
– Select Case Email Notification checkbox by default selects the Send Notification Email
checkbox by default when users create or edit a case.

• Page layouts for the user object only include custom fields, custom links, s-controls, and Visualforce pages. Tagging, related lists,
custom buttons, and standard field customizations are not included on page layouts for the user object. Also, field-level security is
available only for custom fields on the user object.
• You can define mini page layouts for the user object; however, you cannot add standard fields or related lists. Also, a customized
mini page layout won’t display in the Agent console.
• Users can import values into a field only if they have read and edit access. User permissions, page layout assignments, and field-level
security settings determine field access.
• In Personal, Contact Manager, and Group Editions, page layouts control which fields users can access in related lists, list views, reports,
Connect Offline, email and mail merge templates, custom links, and when synchronizing data. In Professional, Enterprise, Unlimited,
Performance, and Developer Editions, this access is controlled by field-level security.
• In Professional, Enterprise, Unlimited, Performance, and Developer Edition, individual users can customize which tabs and related
lists display for their personal use.
• When editing a person account page layout, if you add Shipping Address next to Billing Address in the Address
Information section, a link will display on the person account edit page that allows you to copy the billing address to the shipping
address. Also, an equivalent link appears if you add Other Address to the Address Information section.
• Some items can only be moved to certain sections on the page layout. For example, you can drag a custom s-control to any field
section on the page layout but not a related list section or button section.
• Create the appropriate buttons before editing your page layout. For example, create an account custom button for the detail page
and a contact custom list button before putting them both on an account page layout.

48
Extend Salesforce with Clicks, Not Code Compact Layouts

• If you use the original page layout editor to view a page layout that was created in the new page layout editor, the original page
layout editor will show any blank spaces you added. You cannot move or add blank spaces in the original page layout editor, but
you can remove them by dragging them to the box on the right.

SEE ALSO:
Customize Page Layouts with the Original Page Layout Editor

Compact Layouts
A compact layout displays a record’s key fields at a glance in the Salesforce mobile app, Lightning
EDITIONS
Experience, and in the Outlook and Gmail integrations.
Creating and customizing compact layouts for objects isn't required, because system defaults are Available in: Salesforce
provided out of the box. However, we recommend using compact layouts to put important fields Classic (not available in all
into object record headers—and elsewhere—to help your users get the information they need orgs) and Lightning
quickly. Experience

In the Salesforce mobile app, the fields that you assign to a compact layout appear in: Available in: All editions
except Database.com
• An object record’s highlights area (shows up to ten fields)
• Expanded lookup cards on a record’s related information page (shows the first four fields)
In Lightning Experience, up to the first seven fields in a compact layout appear in the highlights panel of an object record. (On smaller
screens, the highlights panel displays fewer fields.) When a user hovers over a lookup relationship field on the object record page, a
highlights panel for that field also displays the first seven fields from the compact layout. Highlights panels display the first field from
the compact layout at the top in an accented font.

49
Extend Salesforce with Clicks, Not Code Compact Layouts

In the Outlook and Gmail integrations, up to the first three fields in a compact layout appear for records related to an email or event.
As with page layouts, there are separate compact layouts for each object. By default, each object derives its record highlight fields,
preview cards, and action-related feed items from the predefined set of fields in the object’s read-only, system default compact layout.
You can create custom compact layouts on an object-by-object basis. After you create one or more custom compact layouts, you set
one as the primary compact layout for the object. The primary compact layout is then used as the new default for that object.
If you have record types associated with an object, you can override the object’s primary compact layout and assign different compact
layouts to some or all the record types. Each record type can have only one compact layout assigned to it.
Event and task compact layouts determine the fields that appear in the details section when you expand an activity in the activity timeline
in Lightning Experience. When you change the compact layout for tasks in the activity timeline, you also impact the fields that show up
in the highlights area on tasks, in tasks lists, and everywhere else the compact layout is used.

Create Compact Layouts

Use compact layouts to customize the fields that display for object records when viewed in the Salesforce mobile app and Lightning
Experience.
Assign Compact Layouts to Record Types
As with page layouts, there are separate compact layouts for each object. By default, each object derives its record highlight fields,
preview cards, and action-related feed items from the predefined set of fields in the object’s read-only, system default compact
layout. You can create custom compact layouts on an object-by-object basis. After you create one or more custom compact layouts,
you set one as the primary compact layout for the object. The primary compact layout is then used as the new default for that object.

50
Extend Salesforce with Clicks, Not Code Compact Layouts

Compact Layout Limitations and Considerations

Keep these limitations and considerations in mind when using compact layouts.

SEE ALSO:
Activity Timeline Customization Considerations

Create Compact Layouts

Use compact layouts to customize the fields that display for object records when viewed in the
EDITIONS
Salesforce mobile app and Lightning Experience.
1. From the management settings for the object that you want to edit, go to Compact Layouts. Available in: both Salesforce
Classic and Lightning
2. Create a new compact layout and give it a label.
Experience
3. Add up to 10 fields.
Available in: All editions
Tip: Put the object’s Name field first to provide context for your users when they view a except Database.com
record.

4. Sort the fields by selecting them and clicking Up or Down. USER PERMISSIONS
The order you assign to the fields determines the order in which they display. To customize compact
layouts:
5. Save the layout.
• Customize Application
6. To set the compact layout as the primary compact layout for the object, click Compact Layout
To view compact layouts:
Assignment.
• View Setup and
Example: Here’s a sample compact layout edit page for the Account object. It shows the Configuration
name of the layout and a list of fields to display.

51
Extend Salesforce with Clicks, Not Code Compact Layouts

Here’s the related page for the same account object in Lightning Experience, displaying six of the eight fields assigned to the
compact layout. You can see the account’s name, phone number, business hours, website, owner, and type at the top of the page.

And here’s what that same account record looks like in the mobile app.

Note: Up to ten fields on your compact layout populate the record highlights section at the top of each record view in the
Salesforce mobile app. The record highlights section in Lightning Experience uses the first seven fields on the compact
layout. However, the number of fields that display can vary based on the width of your screen, which record page is being
viewed, and the permissions of the user.

SEE ALSO:
Compact Layouts
Customize Case Hovers in Lightning Experience

52
Extend Salesforce with Clicks, Not Code Compact Layouts

Assign Compact Layouts to Record Types

As with page layouts, there are separate compact layouts for each object. By default, each object
EDITIONS
derives its record highlight fields, preview cards, and action-related feed items from the predefined
set of fields in the object’s read-only, system default compact layout. You can create custom compact Available in: both Salesforce
layouts on an object-by-object basis. After you create one or more custom compact layouts, you Classic and Lightning
set one as the primary compact layout for the object. The primary compact layout is then used as Experience
the new default for that object.
Compact layouts are
If you have record types associated with an object, you can override the object’s primary compact available in: All editions
layout and assign different compact layouts to some or all the record types. Each record type can except Database.com
have only one compact layout assigned to it.
Record types are available
1. From the management settings for the object that you want to edit, go to Compact Layouts.
in: Professional, Enterprise,
Tip: For Salesforce Knowledge articles, from Setup, enter Knowledge Article Performance, Unlimited,
Types in the Quick Find box, then select Knowledge Article Types, click the name of and Developer Editions
an article type, then scroll down to the Compact Layouts related list.
USER PERMISSIONS
2. Click Compact Layout Assignment.
3. Select a compact layout to use as the primary compact layout for this object. To customize compact
layouts:
4. In the Record Type Overrides section, select one or more record types to which you want to • Customize Application
assign a compact layout.
To view compact layouts:
If you don’t have record types set for the object, you won’t see this section. If you don’t set any • View Setup and
record type overrides, all record types use the object’s primary compact layout by default. Configuration
Some record types in the list might be inactive. You can assign a compact layout to an inactive
record type.

5. Select a compact layout from the Compact Layout To Use drop-down list to assign it to the selected cells.
6. Click Save.

SEE ALSO:
Compact Layouts
Find Object Management Settings

Compact Layout Limitations and Considerations

Keep these limitations and considerations in mind when using compact layouts.
EDITIONS

Considerations Available in: Salesforce

Classic (not available in all
• Up to ten fields on your compact layout populate the record highlights section at the top of orgs) and Lightning
each record view in the Salesforce mobile app. The record highlights section in Lightning Experience
Experience uses the first seven fields on the compact layout. However, the number of fields
that display can vary based on the width of your screen, which record page is being viewed, Available in: All editions
and the permissions of the user. except Database.com

• Changes you make to a compact layout are reflected in both Lightning Experience and the
Salesforce mobile app.

53
Extend Salesforce with Clicks, Not Code Compact Layouts

• Each record type can have only one compact layout assigned to it. However, the same compact layout can be associated with
multiple record types.
• Compact layouts aren’t assigned to profiles or individual users. To display different sets of fields in records by use case or role, create
record types for the object, then assign the appropriate custom compact layout to each record type.
• If a user doesn’t have access to one of the fields that you assign to a compact layout, the next field on the layout is used.
• A compact layout must contain at least one field.
• Don’t make the primary field a lookup field. Doing this could result in navigation issues in Lightning Experience and the Salesforce
mobile app.
• Removing a field from a page layout doesn’t remove it from the object’s compact layout. The two layout types are independent.
• If you change a field on a compact layout to an unsupported type, the field is removed from the compact layout.
• Before you can delete a compact layout that’s set as the primary compact layout for the object, you must choose another compact
layout to replace it.
• In the Salesforce mobile app, tasks automatically show whether a task is open or closed and the due date (depending on a user’s
access to activity dates). When customizing a task compact layout, you don’t have to add these fields to the Selected Fields list.
• Compact layouts installed from a managed package are editable. However, we recommend against editing compact layouts installed
from a package, as doing so can cause destructive changes to your org. Instead, clone the installed compact layout and make your
changes to the clone.
• Compact layout assignments are subscriber controlled. If a user installs a managed package that contains a compact layout and
then changes the compact layout’s assignment in their org, the compact layout’s assignment isn’t overridden when they later
upgrade the package.
• These considerations apply to Chatter:
– In the full Salesforce site, a compact layout determines which fields appear in the Chatter feed item that appears after a user
creates a record with a quick action.

– To avoid inadvertent sharing of information through the feed, the Task page layout determines the fields shown in the Chatter
feed items for tasks created using a quick action.
– Primary compact layouts determine which fields are shown in Chatter personal digest emails.

Limitations
• A compact layout can only contain fields from its object, including a formula field that is a cross-object reference to another object.
• Fields that aren’t available in SOAP API don’t show up on compact layouts in the Salesforce mobile app.
• Compact layouts support all field types except:
– text area
– long text area
– rich text area
– multi-select picklist

SEE ALSO:
Create Compact Layouts
Compact Layouts
Customize Case Hovers in Lightning Experience

54
Extend Salesforce with Clicks, Not Code Custom Tabs

Custom Tabs
Custom tabs let you display custom object data or other web content in Salesforce. When you add
EDITIONS
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 Available in: both Salesforce
Launcher. Classic (not available in all
Custom tabs show custom object data or other web content embedded in the app. You can create orgs) and Lightning
any of these types of custom tabs. Experience

Custom Object Tabs Custom Object Tabs and

Custom object tabs (available only at an app level and not on subtab apps) show the data of Web Tabs available in:
your custom object. Custom object tabs look and function just like standard tabs. Contact Manager, Group,
Professional, Enterprise,
Web Tabs
Performance, Unlimited,
Custom web tabs show any external web-based application or web page. You can design web
and Developer Editions
tabs to include the sidebar or span the page without the sidebar.
Visualforce Tabs available
Visualforce Tabs in: Contact Manager,
Visualforce tabs show data from a Visualforce page. Visualforce tabs look and function just like Group, Professional,
standard tabs. Enterprise, Performance,
Lightning Component Tabs Unlimited, and Developer
Lightning component tabs make Lightning components available in the Salesforce mobile Editions
apps and in Lightning Experience. Lightning components aren’t supported in Salesforce Classic. Lightning Page Tabs
available in: All Editions
Note: To expose Lightning components via Lightning component tabs, you must enable except Database.com
and deploy My Domain.
Lightning Page Tabs
Lightning page tabs let you add Lightning app pages to the Salesforce mobile app and Lightning USER PERMISSIONS
Experience navigation bars.
To create and edit custom
In Salesforce Classic, Lightning page tabs don’t appear on the All Tabs page when you click . tabs:
Lightning page tabs also don’t appear in the Available Tabs list when you customize the tabs • Customize Application
for your apps.
Subtab apps support only web tabs and Visualforce tabs.
Delegated administrators who can manage specified custom objects can also create and customize tabs for those custom objects.
In Lightning Experience, Lightning page tabs, Visualforce tabs, and Lightning component tabs have a fixed, friendly URL structure of
/lightning/n/customTabDevName.

SEE ALSO:
Create Custom Apps for Salesforce Classic
Subtab Apps in Salesforce Classic

55
Extend Salesforce with Clicks, Not Code Custom Tabs

Create Web Tabs

Build web tabs so that your users can use your web applications or other websites from within the
EDITIONS
application.
1. From Setup, enter Tabs in the Quick Find box, then select Tabs. Available in: both Salesforce
Classic (not available in all
2. Click New in the Web Tabs related list.
orgs) and Lightning
3. Choose a layout for the new tab. The full page width spans across the entire page without the Experience
sidebar, while the column style allows users to view the sidebar.
Custom Object Tabs and
4. Click Next. Web Tabs available in:
5. Enter a label to display on the tab. Contact Manager, Group,
Professional, Enterprise,
6. Click the Tab Style lookup icon to display the Tab Style Selector.
Performance, Unlimited,
If a tab style is already in use, a number enclosed in brackets [] appears next to the tab style and Developer Editions
name. Hover your mouse over the style name to view the tabs that use the style. Click Hide Visualforce Tabs available
styles which are used on other tabs to filter this list. in: Contact Manager,
Group, Professional,
7. Click a tab style to select the color scheme and icon for the custom tab. Optionally, click Create
Enterprise, Performance,
your own style on the Tab Style Selector dialog to create a custom tab style if your org has
Unlimited, and Developer
access to the Documents tab. To create your own tab style: Editions
a. Click the Color lookup icon to display the color selection dialog and click a color to select Lightning Page Tabs
it. available in: All Editions
b. Click Insert an Image, select the document folder, and select the image you want to use. except Database.com

c. Select a file and click OK. The New Custom Tab wizard reappears.

8. Change the content frame height if necessary. USER PERMISSIONS

9. Enter a description of the tab, if desired, and click Next. To create and edit custom
tabs:
10. Enter the URL or choose the custom s-control that you want to display in the tab. Optionally,
• Customize Application
copy and paste any merge fields for data that you want dynamically replaced in the link. Click
Preview Web Tab to display your web tab.

Note: Only User, organization, and API merge fields are supported for web tabs.

11. For a URL, choose an encoding setting and click Next.

12. Add the web tab to the appropriate profiles. Choose Default On, Default Off, or Tab Hidden to determine whether the custom tab
is visible to users with that profile. You can change this setting later.
13. Click Next.
14. Specify the custom apps that should include the new tab.
15. Select Append tab to users' existing personal customizations to apply the tab visibility settings to all users.
16. Save the tab.

56
Extend Salesforce with Clicks, Not Code Custom Tabs

Create a Custom Object Tab

Give your users access to custom object data and records in an app. Custom object tabs are available
EDITIONS
only at the app level, not on subtab apps, and function like standard tabs.
When you add a custom object tab to an app in Salesforce Classic, it appears as a tab. When you Available in: both Salesforce
add a custom object tab to an app in Lightning Experience, it appears as an item in the app’s Classic (not available in all
navigation bar and in the App Launcher. orgs) and Lightning
Experience
• From Setup, in the Quick Find box, enter Tabs, and then select Tabs.
• Click New in the Custom Object Tabs related list. Custom Object Tabs and
Web Tabs available in:
• Select the custom object to appear in the custom tab. If you haven’t created the custom object,
Contact Manager, Group,
click create a new custom object now and see Create a Custom Object on page 160. Professional, Enterprise,
The label of the new tab is the same as the plural version of the custom object label. Performance, Unlimited,
and Developer Editions
• To show Tab Style Selector, click the Tab Style lookup icon.
Visualforce Tabs available
If a tab style is already in use, a number enclosed in brackets [] appears next to the tab style in: Contact Manager,
name. To view the tabs that use that style, hover over the style name. To filter this list, click Hide Group, Professional,
styles which are used on other tabs. Enterprise, Performance,
Unlimited, and Developer
• To select the color scheme and icon for your custom tab, select a tab style.
Editions
If your org has access to the Documents tab, click Create your own style on the Tab Style
Lightning Page Tabs
Selector dialog to create a custom tab style. available in: all editions
– To access the color selection dialog, click the Color lookup icon and select a color. except Database.com
– Click Insert an Image, select the document folder, and select the image you want to use.
You can also click Search in Documents, enter a search term, and click Go! to find a USER PERMISSIONS
document file name that includes your search term.
To create and edit custom
Note: This dialog only lists files in document folders that are under 20 KB and have tabs:
the Externally Available checkbox selected in the document property settings. If the • Customize Application
document used for the icon is later deleted, Salesforce replaces it with a default
multicolor block icon ( ).

– Select a file and click OK. The New Custom Tab wizard reappears.

• You have the option to choose a custom link to use as the introductory splash page when users initially click the tab.
• Enter a description of the tab, if desired, and click Next.
• Choose the user profiles that you want to have access to the new custom tab.
For Professional Edition users and Salesforce Platform One license users, tab visibility is set to Default On.

Note: A custom object is searchable with or without a custom tab. Go to Search Manager to make your custom object
searchable in your org.

• Specify the custom apps that you want to include in the new tCRMab.
• To add the tab to your users’ customized display settings if they’ve customized their personal display, select Append tab to users'
existing personal customizations.
• Save the tab.
Depending on the visibility settings you selected, you see the tab right away.

57
Extend Salesforce with Clicks, Not Code Custom Tabs

SEE ALSO:
Custom Tabs
Make Search Faster

Create Lightning Page Tabs

Before you can include a Lightning app page in the Salesforce mobile apps or in a Lightning app,
EDITIONS
you must create a custom tab for it.
When you first activate an app page in the Lightning App Builder, a tab is created for the page as Available in: both Salesforce
part of the activation process. You can also create a tab for the page manually in Setup before you Classic (not available in all
activate it. orgs) and Lightning
Experience
You can create a custom tab only for an App Page type of Lightning page.
1. From Setup, enter Tabs in the Quick Find box, then select Tabs. Available in: All editions

2. Click New in the Lightning Page Tabs related list.

USER PERMISSIONS
3. Choose a Lightning page for the tab.
4. Enter a label. To create and edit custom
tabs:
This text is used as the display name for the Lightning page.
• Customize Application
5. Select a tab style to set a color scheme and icon for the Lightning page tab.
6. Enter a description of the tab, if desired, and click Next.
7. Choose the user profiles the new custom tab is available for.

Note: In Salesforce Classic, the Default On and Default Off options for Lightning page tabs don’t work the same way as for
other custom tabs. The Lightning page menu item appears for the selected profiles in Salesforce for Android and Salesforce
for iOS whether you choose Default On or Default Off. Select the Tab Hidden option to hide the Lightning page for the selected
profiles.

8. Click Save.

Tip: When creating a custom icon for your Lightning page tab, follow these image guidelines. The icon should:
• Be less than 10k in size
• Be 120 x 120 pixels
• Be a PNG with a transparent background
• Have a resolution of 72 dpi

58
Extend Salesforce with Clicks, Not Code Custom Help Content

• Not include a color background

• Not include outer shadows on the inner icon graphic

Custom Tab Considerations

When working with custom tabs, keep these considerations in mind.
EDITIONS
• The custom tabs limit is a fixed number based on edition and can’t be increased. For more
information, contact Salesforce. Available in: both Salesforce
• If you choose Default On or Default Off when setting custom object tab visibility, an option is Classic (not available in all
added to the Create New dropdown list in the Salesforce Classic sidebar so that users with the orgs) and Lightning
Experience
Create permission can quickly create a record. For example, if the custom object displayed in
the custom tab is named Expenses, an Expense option appears in this list. Custom Object Tabs and
• A custom object that’s associated with a custom tab is searchable by default, even if users don’t Web Tabs available in:
add the tab for display. Contact Manager, Group,
Professional, Enterprise,
• A Web tab or custom link could display a blank page if the embedded site:
Performance, Unlimited,
– Has been set to deny the loading of its content in a frame. and Developer Editions
– Has been set to allow the loading of its content in a frame only if the same site is delivering Visualforce Tabs available
the content. in: Contact Manager,
– Contains a mix of secure and unsecure content, and the user’s browser has been configured Group, Professional,
to block mixed active content. Enterprise, Performance,
Unlimited, and Developer
To resolve this issue, try these workarounds. Editions
– Set your custom link to either open in a new window or display in the existing window Lightning Page Tabs
without the sidebar or header. available in: All Editions
– Move the URL from a Web tab into a custom link instead, and set the URL to either open except Database.com
in a new window or display in the existing window without the sidebar or header.
– If the site you’re embedding has an HTTP prefix and mixed active content, try changing the
prefix to HTTPS. If the embedded site has a valid security certificate and it hasn’t blocked itself from being displayed in frames,
using HTTPS as the prefix allows the site to display.

• In Salesforce Classic, Lightning page tabs don’t display on the All Tabs page when you click . Lightning page tabs also don’t appear
in the Available Tabs list when you customize the tabs for your apps.
• In Salesforce Classic, the Default On and Default Off options for Lightning page tabs don’t work the same way as for other custom
tabs. The Lightning page menu item appears for the selected profiles in Salesforce for Android and Salesforce for iOS whether you
choose Default On or Default Off. Select the Tab Hidden option to hide the Lightning page for the selected profiles.

Custom Help Content

Tailor help so that users understand how to work within your unique implementation of Salesforce. You can add learning in the flow of
work in several ways. Add custom help for a page, app, object, or org level, or provide links to help in the Utility Bar, Path, or as a text
box on the page. Show users custom resources in a Lightning Experience welcome mat when they first log in. Or, to reach users with
important news, training, and on-boarding information, add micro-learning prompts and walkthroughs to your app.

59
Extend Salesforce with Clicks, Not Code Custom Help Content

Help Salesforce Classic Lightning Experience

Field-Level Help—Detail the purpose and
function of a standard or custom field.

Object-Level Help in Salesforce See Learning Paths

Classic—Help your users by providing
object-level help for all custom objects and
external objects.

Learning Paths—Create a personalized and

always-available learning experience for
your users.

Customize Content in the Guidance

Center—Direct users to a globally available
menu of suggested resources from
Salesforce or links to custom help assigned
with Learning Paths.

Customize the Help Menu in Lightning

Experience—Supplement the
recommended resources by adding a
section with links to your own content.

In-App Guidance—Use prompts to reach

users directly with news, training, and
onboarding messages.

Welcome Mat—Provide resources the first

time that users log in to Lightning
Experience.

Utility Bar—Use the Notes component to

add links to custom help.

Rich Text Component—Add simple HTML

to your Lightning page.

Guidance for Success on Path—Give key

coaching details to support users.

In-Dashboard Videos for Einstein Not applicable - cloud-based platform Not applicable - cloud-based platform
Analytics—Provide customized instruction
that helps users get the most out of
dashboards.

Custom Notification from a Process—Alert

an account owner if a new support case is
logged while trying to close a deal, or send
a notification for a workflow built entirely
with custom objects.

60
Extend Salesforce with Clicks, Not Code Custom Help Content

Help Salesforce Classic Lightning Experience

Sales Enablement (myTrailhead)—Your Not applicable Not applicable
company’s unique enablement content in
a branded experience powered by the
Trailhead online learning platform.

Field-Level Help
Field-level help lets you provide help text detailing the purpose and function of any standard or custom field. Before defining
field-level help, review these implementation tips and best practices.
Custom Help in Lightning Experience
In Lightning Experience, In-App Guidance allows you to add prompts and walkthroughs to reach users directly with feature updates,
record help, and onboarding tips. Find help from anywhere in the app by opening the Guidance Center, which shows learning items
assigned with Learning Paths and suggestions from Salesforce. All Trailhead modules and custom help assignments can be found
on Learning Home.
Custom Help in Salesforce Classic
In Salesforce Classic, object-level help replaces the links for a custom object or external object page. Replace built-in Salesforce Help
with documentation that’s customized for your users.

Field-Level Help
Field-level help lets you provide help text detailing the purpose and function of any standard or custom field. Before defining field-level
help, review these implementation tips and best practices.

Implementation Tips
• Field-level help is enabled by default for all editions.
• Field-level help isn’t available for some standard fields, including fields on the User object, system read-only fields, auto-number
fields, multi-currency fields, Ideas fields, and Experience Cloud site fields.
• The help text for a field is automatically added to a package when you add the associated field to any AppExchange package.
• In a managed package, the help text is locked to the developer, giving installers full capabilities to change it.

Best Practices
• Because your custom help text displays on both edit and detail pages, avoid instructions for entering data. Instead, construct help
text that defines the field's purpose, such as:
The maximum discount allowed for this account.

• Provide information in your help text about the attributes of the field, such as:
A detailed description of the purpose for the expense report. Up to 32 KB of data
are allowed. Only the first 255 characters display in reports.

• Provide examples in your help text that help users understand the field's meaning clearly, such as:
The four-digit promotional code used to determine the amount charged to the customer,
for example, 4PLT (for level-four platinum pricing).

• If your org uses more than one language, provide translations for your Help Text using the Translation Workbench.

61
Extend Salesforce with Clicks, Not Code Custom Help Content

Define Field-Level Help

Define custom help text for your organization’s fields to provide users with a helpful description. Help text can be defined for standard
and custom fields on all detail and edit pages where the field displays. Users can view the field-level help text by hovering over the
Info icon next to the field.

SEE ALSO:
Custom Help Content

Define Field-Level Help

Define custom help text for your organization’s fields to provide users with a helpful description.
EDITIONS
Help text can be defined for standard and custom fields on all detail and edit pages where the field
displays. Users can view the field-level help text by hovering over the Info icon next to the field. Available in: both Salesforce
1. From the management settings for the field’s object, go to Fields. Classic and Lightning
Experience
2. Click Edit next to the field.
3. In the Help Text field, enter the text you want displayed. The text displays when a user Available in: All Editions
hovers the mouse over the Info icon that appears next to the field on a detail or edit page. You except Database.com
can enter up to 510 characters.
4. Click Save. USER PERMISSIONS

Note: If the object you’re modifying is exposed in an Experience Cloud site, field-level help To define or change
is visible to site members, including unlicensed users, partners, and customers. Make sure field-level help:
the information you provide in field-level help accounts for all audiences and doesn’t contain • Customize Application
business-sensitive information.

SEE ALSO:
Custom Help Content
Field-Level Help
Find Object Management Settings

Custom Help in Lightning Experience

In Lightning Experience, In-App Guidance allows you to add prompts and walkthroughs to reach users directly with feature updates,
record help, and onboarding tips. Find help from anywhere in the app by opening the Guidance Center, which shows learning items
assigned with Learning Paths and suggestions from Salesforce. All Trailhead modules and custom help assignments can be found on
Learning Home.

Understand the Benefits

Easily accessible resources within the app are crucial to help users do their jobs efficiently and effectively inside their workspace. Learn
more about the onboarding and troubleshooting stages of the in-app journey by taking the User Engagement and the User Training
and Enablement Trailhead modules. Without training, end-user productivity declines, as can trust and feature adoption. With sufficient
training and on-demand troubleshooting resources, users quickly find answers to their questions so they can get unblocked and back
to work. These resources are also a time saver for admins because they can prevent them from repeatedly fielding the same questions
from their users.

62
Extend Salesforce with Clicks, Not Code Custom Help Content

Because apps are so often customized, sometimes Salesforce resources don’t reflect the actual user experience. As a result, many admins
help their users by adding links to resources that reflect the company’s unique processes and guidelines. There are several ways to
integrate custom help inside the app, but the Guidance Center, Learning Paths, and In-App Guidance are great additions to your admin
toolbox.

Decide When to Use the Guidance Center or In-App Guidance

If you... Then consider...

Have important resources to share with your users. Guidance Center and Learning Paths assignments
Require users to complete training by a certain date. Manage, assign, and track all your longform in-depth learning
Have training created for specific pages or specific users. resources.
Display public Trailhead and enablement site (myTrailhead)
modules or URLs to resources in specific locations for specific
users in the Guidance Center.
Apply a due date.
Centralize all learning resources on the Learning homepage.
Earn Trailhead and enablement site badges inside the app.

Want to nudge, prompt, or remind users of important In-App Guidance

announcements or features. Provide targeted, micro-learning moments to boost feature
adoption.
Pick from targeted, floating, and docked prompts or
walkthroughs.
Design the guidance, select the target audience, and specify
where it appears and for how long.
Add links to internal wikis, training, or PDFs for a custom call
to action.
Use built-in engagement tracking.

Decide When to Use the Guidance Center or Help Menu

Guidance Center and the Help Menu are accessible from the global header. The Help Menu offers Salesforce-suggested resources and
a section for admins to add links to their own content that their users can see anywhere in the app. Guidance Center customized with
Learning Paths offer admins not only a panel to add contextual help per page, but also a way to assign required learning to users. Users
see all their assignments on Learning Home. For more details about Guidance Center, check outFind Help in Lightning Experience.
This table lists the main differences between Guidance Center customized with Learning Paths and the Help Menu.

Feature Guidance Center and Learning Paths Help Menu

Hide completely No, you can’t hide the Guidance Center. Yes, from the Help Menu Setup page

Hide individual sections Yes, hide suggestions from Salesforce or Yes, from the Help Menu Setup page
Learning Home from the Guidance Center
Setup page.

63
Extend Salesforce with Clicks, Not Code Custom Help Content

Add URLs as learning items Add up to 1,000 learning items with Add up to 30 URLs
Learning Paths, and up to four learning
items appear in the Guidance Center at a
time.

Add help for a specific page, app, or org Up to two resources for the object home or Resources for an org appear in the global
record appear under Help for This Page. The custom resource section at the top of the
Selected for You section includes up to two Help Menu. Admins can’t specify per page
resources assigned to all objects for all apps or per app.
or for a specific app with a due date.

Specify a required due date to complete Yes No

Specify user-level visibility Yes, either specify by users or by public No

groups

View Trailhead modules inside the app Yes, users can read and earn badges for No, all URLs open in a new tab. Links to
multiple choice challenges inside the app. Salesforce documentation under Help for
This Page do show inside the app.

View suggestions from Salesforce Salesforce suggestions appear under Suggestions appear under Help for This
Selected for You and Related to This Page. Page for most pages in the app, including
Setup. Global links for search, support,
keyboard shortcuts, and release notes are
under More Resources.

In-App Guidance in Lightning Experience

In Lightning Experience, add prompts and walkthroughs to your app to share information, train, or onboard users. Write the content,
select the target audience, and specify where it appears and for how long. You can add multiple items to the same page, but they
don’t appear at the same time. By default, a user sees only one item per 24 hours, per app. Salesforce shows it again or cancels
scheduled recurrences based on whether the user interacts with or ignores the prompt or walkthrough.
Learning Paths
Create a personalized and always-available learning experience for your users. When you customize Learning Paths, you can choose
whom to assign a learning item to—individuals, public groups, or all users. The Guidance Center icon in the global header opens a
panel where users can see suggestions from Salesforce and your Learning Paths assignments. Associate the learning item with a
particular app or page, and optionally apply a due date. Choose modules from Trailhead or an enablement site (myTrailhead), and
add links to other training resources for the ultimate custom training experience. Admins can let other stakeholders, such as trainers
or sales team managers, assign and manage learning items.
Guidance Center
The Guidance Center panel in Lightning Experience provides a convenient location for showing content that's assigned to or
recommended for the current user. The Guidance Center includes not only suggested content that's authored by Salesforce but also
custom content that you manage. With Learning Paths, you can manage the learning items—custom links, videos, and Trailhead
modules—that are available in the Guidance Center and assign those items to specific users with optional due dates.
Customize the Help Menu in Lightning Experience
The question mark icon in the global header opens a menu of related resources for a page, Trailhead modules, videos, and more
items suggested by Salesforce. The Help Menu offers a default in-app help experience for companies that don’t have custom guidance
or training available to users. You can supplement the recommended resources by adding a global section with links to your own
content.

64
Extend Salesforce with Clicks, Not Code Custom Help Content

In-App Guidance in Lightning Experience

In Lightning Experience, add prompts and walkthroughs to your app to share information, train, or onboard users. Write the content,
select the target audience, and specify where it appears and for how long. You can add multiple items to the same page, but they don’t
appear at the same time. By default, a user sees only one item per 24 hours, per app. Salesforce shows it again or cancels scheduled
recurrences based on whether the user interacts with or ignores the prompt or walkthrough.
Watch the video to learn how to navigate the In-App Guidance Setup page and builder. Get Started with In-App Guidance in Lightning
Experience

Types of In-App Guidance

Select the appropriate type of in-app guidance depending on how you want to support your users.
Considerations for In-App Guidance in Lightning Experience
Before creating prompts and walkthroughs for your users, review the options available in the In-App Guidance Builder and In-App
Guidance Settings window that determine in-app guidance behavior.
Tips for Writing Effective In-App Guidance
Create more effective prompts and walkthroughs with engaging titles and appropriate resources.
Define Walkthroughs in Lightning Experience
Create a hands-on interactive tour to guide users through onboarding or feature introduction with a series of step-by-step prompts.
Define Prompts in Lightning Experience
Reach users inside the app with small windows displaying news, training, feature adoption, and onboarding messages.
Test In-App Guidance in Lightning Experience
Testing lets you log in as specific users to verify that they see the correct prompt or walkthrough. While in test mode, Salesforce
ignores the schedule settings and timed delay so you can test more than one item at a time. User interactions aren’t logged, so
metrics aren’t affected.
Monitor In-App Guidance in Lightning Experience
To help you fine-tune and iterate on the in-app guidance you created, evaluate how users engage with and complete prompts and
walkthroughs.
Resolve Errors and Warnings in In-App Guidance
Errors or warnings can sometimes appear when you’re writing or editing in-app guidance. An error or warning can appear on the
In-App Guidance page in the Setup, the In-App Guidance Builder, and the In-App Guidance Settings window. Usually, these errors
and warnings are related to issues with creating in-app guidance, not errors that users encountered. For example, errors and warnings
occur when a page doesn’t support a prompt, a page with a prompt is deleted, or a field-level error occurs.
Disable Salesforce Standard In-App Guidance in Lightning Experience
If in-app content authored by Salesforce isn’t suitable for your users, you can turn it off from the In-App Guidance page in Setup.
Guidelines for In-App Guidance in Managed Packages
You can include prompts and walkthroughs in a managed package, with some limitations.

65
Extend Salesforce with Clicks, Not Code Custom Help Content

Limits for In-App Guidance

The number of prompts and walkthroughs you can create in your org is limited. The number of prompts and walkthroughs you can
install from AppExchange isn’t limited but we recommend a maximum number that you can have at one time.

SEE ALSO:
Video: Get Started with In-App Guidance
Video: Create Prompts
Video: Create Walkthroughs
Trailhead: User Engagement
Knowledge Article: In-App Guidance Prompts FAQ

Types of In-App Guidance

Select the appropriate type of in-app guidance depending on how you want to support your users.
EDITIONS

Floating Prompt Available in: Lightning

Experience
Promote feature discovery and adoption with a short message that users can quickly read and
dismiss. Place the prompt at one of nine different locations on a page. Available in: Essentials,
Group, Professional,
Benefits Caveats Enterprise, Performance,
Unlimited, and Developer
• Supports rich text. • Disappears when a user navigates away Editions
• Supports an optional image. from the page. Not available for: Chatter
• Supports an optional action button. • Takes up a small area of the page, which External and Chatter Free
users sometimes ignore. To make sure that user licenses
• Supports an optional dismiss button.
your users see the prompt again, set up a
• Includes a snooze icon. Available with Enablement,
schedule in the In-App Guidance Settings
which is available with Sales
window.
Cloud, Service Cloud,
Financial Services Cloud,
Health Cloud, and
For example, show a prompt to let users know they can pin a favorite list view, which helps boost Salesforce Platform for an
their productivity. additional cost in:
Enterprise, Performance,
and Unlimited Editions

Available with Sales

Enablement (myTrailhead),
which is available in:
Enterprise, Performance,
and Unlimited Editions

66
Extend Salesforce with Clicks, Not Code Custom Help Content

Targeted Prompt
Highlight a specific element on a page by pointing to the element with an arrow and graying out the rest of the page. Select the specific
element that you want to target and position the prompt relative to the element.

Benefits Caveats

• Supports 12 positions for placing the prompt by the targeted • Disappears when a user navigates away from the page.
element. Or, Salesforce can determine the best location for the • Takes up a small area of the page, which users sometimes
prompt depending on the current page configuration. ignore.
• Supports an optional image. • Changes to a floating prompt if the targeted element is
• Supports rich text. removed from the page.
• Supports an optional action button. • Changes to a different position if the selected position is near
• Supports an optional dismiss button. the edge of the page or doesn’t entirely appear on the page.
• Includes a snooze icon. • Shows a warning on the In-App Guidance page in Setup and
in In-App Guidance Builder when the user doesn’t have access
to the targeted element on the page.

For example, show a targeted prompt on the Details tab of the contact record page.

Docked Prompt
Drive feature adoption and help guide users through more complicated tasks. Embed images, videos, and step-by-step directions in a
larger-sized prompt that stays available for users.

67
Extend Salesforce with Clicks, Not Code Custom Help Content

Benefits Caveats

• Remains available to users as they navigate from page to page. • Doesn’t support a dismiss button.
Users can maximize or minimize the prompt, and leave the • Allows for more content than some users want or need. Too
prompt open. much information can overwhelm users and cause them to
• Supports an optional image or embedded video. not complete your call to action. To help keep users focused
• Supports more rich text options than floating and targeted and engaged, write concise body text and consider embedding
prompts, including color, links, and lists formatting. a video or adding an image. Review the writing tips in Tips for
Writing Effective In-App Guidance.
• Supports an optional action button.
• Includes a snooze icon.

For example, show a docked prompt that includes a video to let users know about changes to the layout of the account page.

Walkthrough
Provide guided, in-context training and onboarding on a single page or across multiple pages. Connect up to 10 floating, targeted, or
docked prompts in a step-by-step, guided experience.

68
Extend Salesforce with Clicks, Not Code Custom Help Content

Benefits Caveats

• Provides a friendly way to introduce new users to Salesforce • Allows for more content than some users want or need.
by showing steps in the user’s own environment, which can Although you can include up to 10 steps, we recommend that
be more immersive than reading instructions. you limit a walkthrough to 5 steps for higher completion rates.
• Shows progress as the user navigates through each prompt, Consider breaking up a longer walkthrough into two shorter
such as Step 1/4. walkthroughs.
• Supports showing steps across multiple pages, such as a step • Defines slightly different behavior for prompts in a walkthrough
on a new page after the user completes an action on another compared to standard prompts.
page or in a window. For example, create a walkthrough that – Each step includes progress button, labeled Next, except
shows users how to create a lead. Add steps that highlight for the final step, labeled Finish.
fields in the New Lead window. Then, show a final step that – The final step provides an optional action link instead of
only appears on the lead record page after the user completes an action button.
all the fields in the New Lead window and saves.

Note: In this example, the Next button is unavailable

in the final prompt that's associated with the window
until the user completes a required action in the
window. This pattern ensures that users complete a
requirement before the walkthrough advances to the
next prompt on a different page.

Tip: For most walkthrough steps, we recommend floating and targeted prompts. We recommend docked prompts only for the
final step so that you can include more information and calls to action.
For example, show a walkthrough that introduces new sales team members to Path.

69
Extend Salesforce with Clicks, Not Code Custom Help Content

SEE ALSO:
Considerations for In-App Guidance in Lightning Experience
Tips for Writing Effective In-App Guidance

70
Extend Salesforce with Clicks, Not Code Custom Help Content

Considerations for In-App Guidance in Lightning Experience

Before creating prompts and walkthroughs for your users, review the options available in the In-App
EDITIONS
Guidance Builder and In-App Guidance Settings window that determine in-app guidance behavior.
In-App Guidance isn’t supported in the Salesforce mobile app. Available in: Lightning
Experience

Types of In-App Guidance Available in: Essentials,

Group, Professional,
For use cases, benefits, and caveats of each type of prompt and walkthrough, see Types of In-App
Enterprise, Performance,
Guidance.
Unlimited, and Developer
Editions
Prompt Location
Not available for: Chatter
To ensure that a prompt reaches your users where they need it, select the best combination of External and Chatter Free
page and app from the Prompt Location dropdown. user licenses

Available with Enablement,

Option Description
which is available with Sales
This Page, This App The prompt appears on the app and page users navigate to in the builder Cloud, Service Cloud,
canvas. This option is the default. Financial Services Cloud,
Health Cloud, and
This Page, Any App The prompt appears for the page that users navigate to in the builder Salesforce Platform for an
canvas, but the page appears to users in any app that contains the page, additional cost in:
regardless of the app. Enterprise, Performance,
and Unlimited Editions
Any Page, Any App The prompt appears anywhere in the org. A user sees the prompt when
they first log in. Available with Sales
Enablement (myTrailhead),
Any Page, This App The prompt appears on any page in any app that users navigate to in which is available in:
the builder canvas. Enterprise, Performance,
and Unlimited Editions

If a prompt’s location is set to one of the Any App options, then it counts for the user’s delay for
that app, which you configure in the Schedule step of the In-App Guidance Settings window.

Custom Theme Color

Align your in-app guidance with your org or app’s theme color. Salesforce suggests up to four colors to choose from. The colors are
derived from your org’s current settings, which can be changed from the Themes and Branding Setup page or Lightning App Builder.
• Org brand color
• Page background color
• Header background color
• App brand color (if the app has a custom theme)
Salesforce ensures that the colors are accessible by darkening the color or by increasing the contrast color ratio. We recommend
previewing the prompt to ensure that the copy is visible.
There are a few other considerations about how theme color is applied.
• In a walkthrough, specify the custom theme only on the first step. Your selections apply to all steps.
• The custom theme color doesn’t affect in-app content created by Salesforce.
• Microsoft® Internet Explorer® 11 doesn’t support a custom theme color.

71
Extend Salesforce with Clicks, Not Code Custom Help Content

Images
Images make prompts more engaging for users. Upload or link to a .jpg, .jpeg, .png, or .gif file, or further articulate the guidance in a
prompt by adding an animated .gif file.

Note: Animated .png files aren’t supported and don’t include a play or pause button.

Keep these tips in mind when adding images to in-app guidance.

Type Supported Image Positions, Relative to the Prompt Text

Above Below Left Right
Floating prompt

Targeted prompt

Docked prompt

• For images above or below text, the maximum size is 324 px × 132 px. For images to the right or left of the text, the maximum size
is 148 px × 148 px.
• Images are resized to fit and maintain their aspect ratio.
• Maximum file size is 5 MB.
• To represent the image to visually impaired or low-vision users, include alt text.

Tip: To ensure that linked images appear correctly, use trusted sites. Add the CSP Trusted Site in Setup, and select Allow site for
connect-src and Allow site for img-src. Allow cross-origin content on your host server as needed by providing the
Access-Control-Allow-Origin response header with the image. For more information, see Create CSP Trusted Sites to Access
Third-Party APIs in Salesforce Help.

Video
In a docked prompt, you can explain more complex ideas with an embedded video. Users can watch the video within the docked prompt,
in the expanded docked prompt, or in full screen.

Note: You can include an image or an embedded video. If you first include an embedded video and then include an image, the
image replaces the video in the docked prompt. If a video doesn’t load, check your browser privacy settings. For example, YouTube
provides the Privacy-Enhanced Mode.
The video player actions vary depending on the video host. When adding a video to a docked prompt, enter the URL specified in the
src attribute listed in the embed code from the video host.
To find the embed code for a video, follow the instructions from the video host site. Usually you can find the steps by searching for the
name of the site and “embed video.” For example, here’s what the embed code looks like for YouTube.
<iframe width="560" height="315" src="https://www.youtube.com/embed/di6iwHhrH6"
frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope;
picture-in-picture" allowfullscreen></iframe>

Then, you enter the URL found in the src attribute. For the example used, enter
https://www.youtube.com/embed/di6iwHhrH6.

72
Extend Salesforce with Clicks, Not Code Custom Help Content

Tip: To ensure that videos embed properly, use trusted sites. YouTube, Vidyard, and Vimeo are trusted websites for In-App
Guidance. If videos from others sites don’t appear correctly, try adding those sites as trusted sites. For more information, see Create
CSP Trusted Sites to Access Third-Party APIs in Salesforce Help.

Action Button and Link

In all prompt types, action buttons are optional. In a walkthrough, an action link is optional.
When adding an action button or link, you can enter a relative URL or a fully qualified URL with an http:// or https:// prefix.
Usually, clicking the action button or link opens a new tab. But if you add a URL for a flow, clicking the action button or link refreshes
the current tab the user is on.

Schedule
The In-App Guidance Settings window, which appears after you select a type of in-app guidance and specify its content and position,
includes a Schedule step. Use the Date Range options to specify the start and end date you want the in-app guidance to be visible.
To ensure that users understand or take a desired action on the content, you can show the same prompt or walkthrough multiple times.
Use the Frequency section of the Schedule step to specify the number of times to show the in-app guidance and the days in between
occurrences. You can show the same in-app guidance up to 30 times, with up to 30 days in between. Consider the date range when
deciding how many days between each repeat.
By default, a 24-hour delay between instances ensures that a user sees only one prompt or walkthrough per day per app. If a prompt’s
location is set to one of the Any App options, then it counts for the user’s delay for that app. Change the amount of time for the delay
between all in-app guidance, even in-app content created by Salesforce, under Settings on the In-App Guidance Setup page. Choose
a value 0–99 hours and 0–59 minutes.
Or, choose to ignore the delay for a single in-app guidance by selecting Show when the page loads in the Frequency section of the
Schedule step. The specified Schedule still applies, including the start date, times to show, and days in between. A single prompt or
walkthrough appears no more than one time every 24 hours, even when you adjust the global time delay or show the in-app guidance
when the page loads.
Salesforce detects how users interact with in-app guidance, and continues to show or hide the in-app guidance depending on how the
user interacts.

User Interaction Floating and Targeted Docked Prompt Walkthrough

Prompts
User didn’t acknowledge or Show the prompt again. Show the prompt again. Show the walkthrough again.
interact with prompt.

User clicked the X to close the Not applicable. This type of • If there’s no action button Show the walkthrough again.
prompt. prompt doesn’t have an X. tied to the prompt, stop
showing the prompt.
• If there’s an action button
tied to the prompt, show
the prompt again.

User selected a snooze option. Show the prompt again after the Show the prompt again after the Show the walkthrough again
snooze time expires, the next snooze time expires, the next after the snooze time expires,
time the user navigates to the time the user navigates to the the next time the user navigates
page. page. to the page.

73
Extend Salesforce with Clicks, Not Code Custom Help Content

User Interaction Floating and Targeted Docked Prompt Walkthrough

Prompts
User clicked the dismiss button. • If there’s only a dismiss Not applicable. This type of Show the walkthrough again.
button, stop showing the prompt doesn’t have a dismiss
prompt even if there are button.
more scheduled
occurrences.
• If there’s a dismiss button
and an action button, show
the prompt again.

User clicked the action button Stop showing the prompt even Stop showing the prompt even Stop showing the walkthrough
(prompt) or action link if there are more scheduled if there are more scheduled even if there are more scheduled
(walkthrough). occurrences. occurrences. occurrences.

User clicked the finish button. Not applicable for prompts. Not applicable for prompts. Stop showing the walkthrough
even if there are more scheduled
occurrences.

Note: Watching a video doesn’t register as a user interaction.

Profile and Permission Restrictions

You can specify whether your in-app guidance is visible for everyone or only a specific group of users. In the In-App Guidance Settings
window, use the Profiles or Permissions steps to specify any restrictions.
By default, in-app guidance has no profile or permission restrictions, but you can select standard and custom profiles and permissions
that you want to apply. Applied profiles and permissions work a bit differently.
• If you apply multiple profiles, the in-app guidance is visible to a user who has any of the specified profiles.
• If you apply multiple permissions, the in-app guidance is visible to a user who has all the specified permissions.
• If you apply multiple profiles and multiple permissions, the in-app guidance is visible to a user who has any of the specified profiles
and all of the specified permissions.
You can select up to 10 combined profiles and permissions for each in-app guidance.

Note: If any applied profile or permission is deleted, a warning appears. Review the selected profiles or permissions to ensure
that the correct users see the in-app guidance. If all applied profiles or permissions are deleted, an error appears. To save your
in-app guidance, update the profile or permission selections.

Shareable URL
Create a link to a single in-app guidance that you can share with users. In the In-App Guidance Settings window, use the Details step to
set up the link. Or, from the In-App Guidance page in Setup, select Copy URL from the row-level action menu.
You can also string multiple walkthroughs together by using the URL for one walkthrough as the destination for an action link from the
final step of another walkthrough. If you use the URL as the action button or link, the prompt opens in a new tab and the walkthrough
refreshes the page.

74
Extend Salesforce with Clicks, Not Code Custom Help Content

When you edit the API Name or delete a record that the in-app guidance was added to, the URL changes. When you make any other
change to the in-app guidance, the URL remains the same.
The URL opens the in-app guidance on a record that the prompt or walkthrough was added to. If the user doesn’t have access to that
specific record, the in-app guidance opens on a record of the same object type and record type, if a specific record type was defined.
The URL opens even if the user previously viewed or closed the in-app guidance, clicked the action button, or isn’t a part of the profile
or permission set. The URL also ignores all schedule settings, such as the start date, end date, number of times to show, and days to wait
in between occurrences. If the in-app guidance is inactive, the URL doesn’t open.

Note: If you deselect Custom In-App Guidance in the Settings accessed from the In-App Guidance Setup page, users can’t
open links to custom in-app guidance.

Keyboard Shortcuts
Use these handy keyboard shortcuts for Mac and Windows to quickly navigate around the builder.

Action Mac Windows

Keyboard Help Press ?+Shift+/ Press ?+Shift+/

Switch focus to different regions (move Press Cmd+F6 Press Ctrl+F6

focus around areas of the In-App Guidance
Builder, such as the header, right sidebar,
and left sidebar)

Switch focus to the builder (move focus Press Cmd+F7 Press Ctrl+F7
from the canvas (preview of app) to the
In-App Guidance Builder)

Select the next element in the canvas Press Ctrl+Alt+t Press Ctrl+Alt+t

Select the previous element in the canvas Press Cmd + Option + Shift + t Press Ctrl+Alt+Shift+t

Add a targeted prompt to the selected Press Cmd+Option+a Press Ctrl+Alt+a

element

In-App Guidance in Managed Packages

You can include prompts and walkthroughs in a managed package. See Guidelines for In-App Guidance in Managed Packages.

In-App Guidance Limits

See Limits for In-App Guidance.

SEE ALSO:
Types of In-App Guidance
Define Prompts in Lightning Experience
Define Walkthroughs in Lightning Experience
Monitor In-App Guidance in Lightning Experience
Test In-App Guidance in Lightning Experience
Knowledge Article: In-App Guidance Prompts FAQ

75
Extend Salesforce with Clicks, Not Code Custom Help Content

Tips for Writing Effective In-App Guidance

Create more effective prompts and walkthroughs with engaging titles and appropriate resources.
EDITIONS
For use cases, benefits, and caveats of each type of prompt and walkthrough, see Types of In-App
Guidance. Also, check out the User Engagement module on Trailhead. Available in: Lightning
Experience
For examples of different types of in-app guidance, you can install packages from AppExchange.
Available in: Essentials,
Use Case Packages You Can Install Group, Professional,
Enterprise, Performance,
Example prompts • In-App Guidance: Boost Sales User Unlimited, and Developer
Productivity in Lightning Experience Editions
• In-App Guidance: Boost Service User Not available for: Chatter
Productivity in Lightning Experience External and Chatter Free
user licenses
Example walkthroughs In-App Guidance Walkthroughs: Getting Started
for Sales Users Available with Enablement,
which is available with Sales
Cloud, Service Cloud,
Financial Services Cloud,
In general, use a conversational but concise tone when writing in-app guidance. For more voice
Health Cloud, and
and tone suggestions, check out the Salesforce Voice and Tone Guidelines, the User Engagement
Salesforce Platform for an
module on Trailhead, and the Writing Style module on Trailhead.
additional cost in:
Enterprise, Performance,
Titles and Unlimited Editions

Use keywords that emphasize the purpose and value of the feature or process to users. Avoid Available with Sales
excessive exclamation marks. Enablement (myTrailhead),
which is available in:
For prompts, format your title using imperative phrases.
Enterprise, Performance,
and Unlimited Editions
Example Prompt Title with Imperative Example Prompt Title with Noun
Phrases
Create shortcuts to favorite pages Favorites are a way to create shortcuts

New feature: Favorites

For walkthroughs, your title varies with each step.

• The first step of the walkthrough welcomes the user and explains where users are headed.
• The middle steps can be either instructional to describe how to complete an action or conceptual to provide information that helps
users understand the use case, benefit, or purpose.
• The last step gives users encouragement for taking the walkthrough.

Headers (Docked Prompts)

The header follows the title, so use it to indicate to the user what type of information is in the prompt. For example, Important Changes,
New Feature, or List View Tips.

76
Extend Salesforce with Clicks, Not Code Custom Help Content

Body Text
Elaborate on the title without restating it. Provide more information about the feature or process, mention the problem that the solution
solves, or include common use cases.
Write in a minimal, straightforward style. Include content that’s directly relevant to the current task. Don’t include anything that users
must refer to later. Focus on writing content that’s easy to understand and to execute.
Floating and targeted prompts support rich text formatting such as bold, italics, and underline. Docked prompts also support rich text
but provide more options, including colors, links, and lists.
For walkthroughs, the body varies with each step.
• The first step of the walkthrough clearly states the goal and the benefits to the user before they start.
• The middle steps provide more details about the process or concept.
• The last step can include next steps or resources to keep the user engaged with the feature

Media
Make your in-app guidance more engaging with optional images. In a docked prompt, optionally embed a video. For image and video
requirements, check out Considerations for Using Learning Paths.

Buttons
Keep button names consistent. For the optional action button, the label indicates where users are going before they click.

Button Recommended Label

Dismiss Dismiss

Action Tell Me More

The action button can also link to a helpful resource that’s still in their flow of work. When choosing a resource to link to, think about a
resource that helps users complete the task or is part of the call to action. In-app guidance is engaging because it keeps users in the app,
so don’t direct them to help stored outside the app unnecessarily.

SEE ALSO:
Types of In-App Guidance
Define Prompts in Lightning Experience
Define Walkthroughs in Lightning Experience
Considerations for In-App Guidance in Lightning Experience

77
Extend Salesforce with Clicks, Not Code Custom Help Content

Define Walkthroughs in Lightning Experience

USER PERMISSIONS EDITIONS

To add, edit, and manage prompts and Modify All Data Available in: Lightning
walkthroughs as an admin OR Experience

Customize Application Available in: Essentials,

Group, Professional,
To add, edit, and manage prompts and Manage Prompts Enterprise, Performance,
walkthroughs as a user who isn’t an admin AND Unlimited, and Developer
Editions
View All Profiles (if profile filtering is enabled)
Not available for: Chatter
Note: If a user doesn’t have access External and Chatter Free
to an item, such as an object or app, user licenses
some actions aren’t available.
Available with Enablement,
To view another user’s errors, views, and View All Data which is available with Sales
completions for in-app guidance Cloud, Service Cloud,
OR
Financial Services Cloud,
Modify All Data Health Cloud, and
Salesforce Platform for an
To view more than three active custom View Walkthroughs additional cost in:
walkthroughs as a user outside of the In-App Enterprise, Performance,
Note: The View Walkthroughs user
Guidance Builder and Unlimited Editions
permission is part of the Walkthroughs
Note: If any user in the organization permission set license. The Sales Available with Sales
has a Sales Enablement (myTrailhead) Enablement (myTrailhead) Enablement (myTrailhead),
subscription, users without the subscription includes this feature. For which is available in:
subscription can’t see custom pricing details, contact your Salesforce Enterprise, Performance,
walkthroughs. account executive. and Unlimited Editions

Create a hands-on interactive tour to guide users through onboarding or feature introduction with a series of step-by-step prompts.

Tip: You can activate up to three custom walkthroughs for free and an unlimited number of active walkthroughs in a Developer
Edition org. For more details, see Considerations for In-App Guidance in Lightning Experience in Salesforce Help.
Watch the video to see how to add a walkthrough. Create Walkthroughs in Lightning Experience
1. From Setup in Lightning Experience, in the Quick Find box, enter In-App Guidance, and then select In-App Guidance.
2. Click Add. The In-App Guidance Builder opens in a new browser tab.
3. Inside the builder canvas, navigate to the app and page where you want to add the walkthrough, and then click Add. You remain
in the builder while you navigate. The builder shows information about your page location, other in-app guidance on the page, and
your next step.

Note: You can place walkthroughs on object record pages, object home pages such as Home, and on new, edit, and clone
record pages, including dialogs. The Add button is disabled when you can’t add a walkthrough to the page. For record pages,
you can’t add a walkthrough step to a specific record. Instead, a step is added to a record page type. The step takes users to a
record they have access to. If a new or clone record page has multiple record types, you can choose if you want in-app guidance
to appear for all or only a specific record type. You can’t place in-app guidance on task record pages when using the split view,
the prompt appears on the Task home page.

78
Extend Salesforce with Clicks, Not Code Custom Help Content

4. Follow the instructions in the right side panel to choose Walkthrough. Then specify the type, location, and position of the prompt
and the content. A left side panel appears for you to view, reorder, or delete steps in the walkthrough. Add a step using the builder
header actions.

Tip: The In-App Guidance Builder shows errors and warnings related to authoring in-app guidance. For example, a page
doesn’t support a prompt. Or a page that contained a prompt is now missing, the author doesn’t have access to the page, or
there’s a field-level error. Errors that users encountered when viewing a walkthrough are noted on the In-App Guidance Setup
page.

Warning: Walkthroughs don’t appear correctly when the split view list view is open. Close split view before adding a step.
The first step of a walkthrough can instruct the user to close the split view before continuing with the walkthrough.

5. To specify the title, body, and button text, select Next. You can also include an image, or for docked prompts, embed a video.
6. Save your work. A window appears to complete more settings for an action link, schedule, profile, permissions, active status, and
name. The walkthrough is active by default.
7. Click Done.
To edit a walkthrough, click Edit from the In-App Guidance Setup page row-level action menu or the In-App Guidance Builder header.
Move a walkthrough step by navigating to a different page and saving. To edit more settings, click the gear icon in the header of the
builder.
To quickly create in-app guidance for different users, consider cloning. You can clone any prompt or walkthrough, including prompts
installed from packages, by clicking Clone from the row-level action menu. Edit any setting except the type.
Activate or deactivate a single prompt or walkthrough from the row-level action menu.
Use Translation Workbench to maintain your translated labels in your org. Look for the Prompt and PromptVersion setup component
to get started.
Open Settings on the In-App Guidance Setup page to:
• Turn off or turn on all in-app guidance created or installed in your Salesforce org.
• Turn off or turn on all in-app guidance created by Salesforce.
• Change the delay between in-app guidance appearances.

Assign Walkthrough Permissions in Lightning Experience

To have more than three custom walkthroughs active at a time, subscribe to Sales Enablement (myTrailhead) and assign the
Walkthrough permission set license and the Access Walkthroughs permission set to selected users.

SEE ALSO:
Types of In-App Guidance
Plan Your Enablement Site Solution
Manage Your Translations
Considerations for In-App Guidance in Lightning Experience
Test In-App Guidance in Lightning Experience
Monitor In-App Guidance in Lightning Experience
Knowledge Article: In-App Guidance Prompts FAQ

79
Extend Salesforce with Clicks, Not Code Custom Help Content

Assign Walkthrough Permissions in Lightning Experience

USER PERMISSIONS EDITIONS

To add, edit, and manage prompts and Modify All Data Available in: Lightning
walkthroughs as an admin OR Experience

Customize Application Available in: Essentials,

Group, Professional,
To add, edit, and manage prompts and Manage Prompts Enterprise, Performance,
walkthroughs as a user who isn’t an admin AND Unlimited, and Developer
Editions
View All Profiles (if profile filtering is enabled)
Not available for: Chatter
Note: If a user doesn’t have access External and Chatter Free
to an item, such as an object or app, user licenses
some actions aren’t available.
Available with Enablement,
To view another user’s errors, views, and View All Data which is available with Sales
completions for in-app guidance Cloud, Service Cloud,
OR
Financial Services Cloud,
Modify All Data Health Cloud, and
Salesforce Platform for an
To view more than three active custom View Walkthroughs additional cost in:
walkthroughs as a user outside of the In-App Enterprise, Performance,
Note: The View Walkthroughs user
Guidance Builder and Unlimited Editions
permission is part of the Walkthroughs
Note: If any user in the organization permission set license. The Sales Available with Sales
has a Sales Enablement (myTrailhead) Enablement (myTrailhead) Enablement (myTrailhead),
subscription, users without the subscription includes this feature. For which is available in:
subscription can’t see custom pricing details, contact your Salesforce Enterprise, Performance,
walkthroughs. account executive. and Unlimited Editions

To have more than three custom walkthroughs active at a time, subscribe to Sales Enablement (myTrailhead) and assign the Walkthrough
permission set license and the Access Walkthroughs permission set to selected users.
You can activate up to three custom walkthroughs at a time for your users without subscribing to Enablement Sites (myTrailhead). To
see how many are available, go to the In-App Guidance Setup page.
1. From Setup in Lightning Experience, in the Quick Find box, enter Users, and select Users.

Tip: To mass-assign permission set licenses, you can use the Data Loader. You can also assign permission set licenses by
assigning the permission sets first. When you assign the permission sets to users, the permission set license is automatically
assigned to those users.

2. Click a user’s name, go to the Permission Set License Assignments section, and then click Edit Assignments. Check Walkthroughs.
3. From Setup in Lightning Experience, in the Quick Find box, enter Permission Sets, and select Permission Sets.

80
Extend Salesforce with Clicks, Not Code Custom Help Content

4. Select the Access Walkthroughs permission set. Click Manage Assignments, and then Add Assignments. Select the checkboxes
next to the names of the users you want assigned to the permission set, and click Assign.

SEE ALSO:
Plan Your Enablement Site Solution
Permission Set Licenses
Permission Sets

Define Prompts in Lightning Experience

USER PERMISSIONS EDITIONS

To add, edit, and manage prompts and Modify All Data Available in: Lightning
walkthroughs as an admin OR Experience

Customize Application Available in: Essentials,

Group, Professional,
To add, edit, and manage prompts and Manage Prompts Enterprise, Performance,
walkthroughs as a user who isn’t an admin AND Unlimited, and Developer
Editions
View All Profiles (if profile filtering is enabled)
Not available for: Chatter
Note: If a user doesn’t have access External and Chatter Free
to an item, such as an object or app, user licenses
some actions aren’t available.
Available with Enablement,
To view another user’s errors, views, and View All Data which is available with Sales
completions for in-app guidance Cloud, Service Cloud,
OR
Financial Services Cloud,
Modify All Data Health Cloud, and
Salesforce Platform for an
To view more than three active custom View Walkthroughs additional cost in:
walkthroughs as a user outside of the In-App Enterprise, Performance,
Note: The View Walkthroughs user
Guidance Builder and Unlimited Editions
permission is part of the Walkthroughs
Note: If any user in the organization permission set license. The Sales Available with Sales
has a Sales Enablement (myTrailhead) Enablement (myTrailhead) Enablement (myTrailhead),
subscription, users without the subscription includes this feature. For which is available in:
subscription can’t see custom pricing details, contact your Salesforce Enterprise, Performance,
walkthroughs. account executive. and Unlimited Editions

Reach users inside the app with small windows displaying news, training, feature adoption, and onboarding messages.
Watch the video to see how to add a prompt. Create Prompts in Lightning Experience
1. From Setup in Lightning Experience, in the Quick Find box, enter In-App Guidance, and then select In-App Guidance.
2. Click Add. The In-App Guidance Builder opens in a new browser tab.
3. Inside the builder canvas, navigate to the app and page where you want to add the prompt, and then click Add. You remain in the
builder while you navigate. The builder shows information about your page location, other in-app guidance on the page, and your
next step.

81
Extend Salesforce with Clicks, Not Code Custom Help Content

Note: You can place prompts on object record pages, object home pages such as Home, and on new, edit, and clone record
pages, including dialogs. The Add button is disabled when you can’t add a prompt to the page. For record pages, you can’t
add a prompt to a specific record. Instead, a prompt is added to a record page type. The prompt takes users to a record they
have access to. If a new or clone record page has multiple record types, you can choose if you want in-app guidance to appear
for all or only a specific record type. You can’t place in-app guidance on task record pages when using the split view, the
prompt appears on the Task home page.

4. Follow the instructions in the right side panel to choose Single Prompt. Then specify the type, location, and position of the prompt
and the content.

Tip: The In-App Guidance Builder shows errors and warnings related to authoring in-app guidance. For example, a page
doesn’t support a prompt. Or, a page that contained a prompt is now missing, the author doesn’t have access to the page, or
there’s a field-level error. Errors that users encountered when viewing a prompt are noted on the In-App Guidance Setup page.

5. To specify the title, body, and button text, select Next. You can also include an image, or for docked prompts, embed a video.
6. When you’re done creating the prompt, click Save. A window appears to complete more settings for an action button, schedule,
profile, permissions, active status, and name. The prompt is active by default.
7. Click Done.
To edit a prompt, click Edit from the In-App Guidance Setup page row-level action menu or the In-App Guidance Builder header. Move
a prompt by navigating to a different page and saving. To edit more settings, click the gear icon in the header of the builder.
To quickly create in-app guidance for different users, consider cloning. You can clone any prompt, including prompts installed from
packages, by clicking Clone from the row-level action menu. Edit any setting except the prompt type.
Activate or deactivate a single prompt or walkthrough from the row-level action menu.
Use Translation Workbench to maintain your translated labels in your org. Look for the Prompt and PromptVersion setup component
to get started.
Open Settings on the In-App Guidance Setup page to:
• Turn off or turn on all in-app guidance created or installed in your Salesforce org.
• Turn off or turn on all in-app guidance created by Salesforce.
• Change the amount of time for the global delay between in-app guidance.

SEE ALSO:
Types of In-App Guidance
Manage Your Translations
Test In-App Guidance in Lightning Experience
Monitor In-App Guidance in Lightning Experience
Knowledge Article: In-App Guidance Prompts FAQ

82
Extend Salesforce with Clicks, Not Code Custom Help Content

Test In-App Guidance in Lightning Experience

USER PERMISSIONS EDITIONS

To add, edit, and manage prompts and Modify All Data Available in: Lightning
walkthroughs as an admin OR Experience

Customize Application Available in: Essentials,

Group, Professional,
To add, edit, and manage prompts and Manage Prompts Enterprise, Performance,
walkthroughs as a user who isn’t an admin AND Unlimited, and Developer
Editions
View All Profiles (if profile filtering is enabled)
Not available for: Chatter
Note: If a user doesn’t have access External and Chatter Free
to an item, such as an object or app, user licenses
some actions aren’t available.
Available with Enablement,
To view another user’s errors, views, and View All Data which is available with Sales
completions for in-app guidance Cloud, Service Cloud,
OR
Financial Services Cloud,
Modify All Data Health Cloud, and
Salesforce Platform for an
To view more than three active custom View Walkthroughs additional cost in:
walkthroughs as a user outside of the In-App Enterprise, Performance,
Note: The View Walkthroughs user
Guidance Builder and Unlimited Editions
permission is part of the Walkthroughs
Note: If any user in the organization permission set license. The Sales Available with Sales
has a Sales Enablement (myTrailhead) Enablement (myTrailhead) Enablement (myTrailhead),
subscription, users without the subscription includes this feature. For which is available in:
subscription can’t see custom pricing details, contact your Salesforce Enterprise, Performance,
walkthroughs. account executive. and Unlimited Editions

Testing lets you log in as specific users to verify that they see the correct prompt or walkthrough. While in test mode, Salesforce ignores
the schedule settings and timed delay so you can test more than one item at a time. User interactions aren’t logged, so metrics aren’t
affected.
1. From Setup in Lightning Experience, enter In-App Guidance in the Quick Find box, and then select In-App Guidance.
2. Click Start Testing.
3. Log in as a specific user, and navigate to the page where the in-app guidance appears. If you see anything that needs updating, edit
the in-app guidance by clicking Open In-App Guidance Builder from the testing bar at the top of the screen.
4. When you’re done, click Exit Testing in the testing bar.
There are two other ways to test in-app guidance.
• Take a quick look at in-app guidance. Click Preview from the In-App Guidance Setup page row-level action menu. A new tab opens
with the in-app guidance in preview mode in the builder.

83
Extend Salesforce with Clicks, Not Code Custom Help Content

• See in-app guidance in action in a sandbox environment. If you don’t see prompts and walkthroughs, turn on Adoption Assistance
in Sandbox Orgs on the In-App Guidance Setup page in your sandbox org.

SEE ALSO:
Define Prompts in Lightning Experience
Define Walkthroughs in Lightning Experience
Considerations for In-App Guidance in Lightning Experience

Monitor In-App Guidance in Lightning Experience

To help you fine-tune and iterate on the in-app guidance you created, evaluate how users engage
EDITIONS
with and complete prompts and walkthroughs.
You can monitor in-app guidance user engagement with a few different strategies. Available in: Lightning
Experience
• View the metrics on the In-App Guidance page in Setup.
• Create a custom report type. Available in: Essentials,
Group, Professional,
• Download an AppExchange package that includes prebuilt, customizable reports and
Enterprise, Performance,
dashboards.
Unlimited, and Developer
Editions
Metrics on the In-App Guidance Page in Setup
Not available for: Chatter
To track user interactions per org, review the standard usage metrics. External and Chatter Free
From Setup in Lightning Experience, in the Quick Find box, enter In-App Guidance, and then user licenses
select In-App Guidance. Look for the Views and Completes columns. Available with Enablement,
Views which is available with Sales
The total number of unique users who saw the prompt or walkthrough. Video views aren’t Cloud, Service Cloud,
tracked. Financial Services Cloud,
Health Cloud, and
Completes Salesforce Platform for an
The percentage of viewers who clicked the action button (prompt) or link (walkthrough) or additional cost in:
clicked the finish button on the last step of a walkthrough. Enterprise, Performance,
To reset the metric values to zero, select Reset Metrics from the row-level action menu. For instance, and Unlimited Editions
you made significant changes to a prompt and you want to restart the metrics tracking. If the end Available with Sales
date hasn’t passed and the in-app guidance is active, users see the prompt or walkthrough again Enablement (myTrailhead),
after resetting the metrics. which is available in:
Enterprise, Performance,
and Unlimited Editions
Custom Report Type
Set up a custom report type using the Prompt Actions object, and add these fields as columns in
the report.
• Last Display Date
• Last Result
• Name
• Times Action Taken
• Times Dismissed
• Times Displayed

84
Extend Salesforce with Clicks, Not Code Custom Help Content

• User: Full Name

If you’re reviewing walkthrough data, consider adding these fields.
• Step Count
• Step Number
To create a progress percentage formula field, you can use the Step Number divided by the Step Count.
Review the list of the available Prompt Actions fields. For more information, see the PromptAction and PromptVersion objects.

Fields Description
Active Date The date the in-app guidance was activated. If the in-app guidance
is part of a package, the active date is the date when the package
was installed.

API Type The type of in-app guidance. Valid values are Docked Prompt,
Floating Prompt, Targeted Prompt, and Walkthrough.

Last Display Date The date the in-app guidance was last showed to the user.

Last Result The most recent user interaction. Valid values are Error, Not Seen,
No Action, Dismiss, Finish (walkthroughs only), and Custom Action.
No Action represents the user clicking the close button.

Last Result Date The date the in-app guidance was last interacted with.

Name The name of the in-app guidance.

Step Count The total number of steps in the walkthrough.

Step Number The number of the last step the user viewed or interacted with in
a walkthrough.

Times Action Taken The number of times that the user acted upon on the in-app
guidance.

Times Dismissed The number of times that the user dismissed the in-app guidance.

Times Displayed The number of times that the in-app guidance was shown to the
user.

User: Full Name The full name of the user who viewed the in-app guidance.

AppExchange Packages with Reports and Dashboards

Visit AppExchange to install free packages with prebuilt, customizable reports and dashboards for monitoring user engagement of in-app
guidance.

Package For URL

Prompts In-App Guidance Dashboard: Prompt Engagement

85
Extend Salesforce with Clicks, Not Code Custom Help Content

Package For URL

Walkthroughs In-App Guidance Dashboard: Walkthrough Engagement

SEE ALSO:
Resolve Errors and Warnings in In-App Guidance
Create a Custom Report Type
Design the Field Layout for Reports Created from Your Custom Report Type
Build a Formula Field
Define Prompts in Lightning Experience
Define Walkthroughs in Lightning Experience
Considerations for In-App Guidance in Lightning Experience

Resolve Errors and Warnings in In-App Guidance

USER PERMISSIONS EDITIONS

To add, edit, and manage prompts and Modify All Data Available in: Lightning
walkthroughs as an admin OR Experience

Customize Application Available in: Essentials,

Group, Professional,
To add, edit, and manage prompts and Manage Prompts Enterprise, Performance,
walkthroughs as a user who isn’t an admin AND Unlimited, and Developer
Editions
View All Profiles (if profile filtering is enabled)
Not available for: Chatter
Note: If a user doesn’t have access External and Chatter Free
to an item, such as an object or app, user licenses
some actions aren’t available.
Available with Enablement,
To view another user’s errors, views, and View All Data which is available with Sales
completions for in-app guidance Cloud, Service Cloud,
OR
Financial Services Cloud,
Modify All Data Health Cloud, and
Salesforce Platform for an
To view more than three active custom View Walkthroughs additional cost in:
walkthroughs as a user outside of the In-App Enterprise, Performance,
Note: The View Walkthroughs user
Guidance Builder and Unlimited Editions
permission is part of the Walkthroughs
Note: If any user in the organization permission set license. The Sales Available with Sales
has a Sales Enablement (myTrailhead) Enablement (myTrailhead) Enablement (myTrailhead),
subscription, users without the subscription includes this feature. For which is available in:
subscription can’t see custom pricing details, contact your Salesforce Enterprise, Performance,
walkthroughs. account executive. and Unlimited Editions

86
Extend Salesforce with Clicks, Not Code Custom Help Content

Errors or warnings can sometimes appear when you’re writing or editing in-app guidance. An error or warning can appear on the In-App
Guidance page in the Setup, the In-App Guidance Builder, and the In-App Guidance Settings window. Usually, these errors and warnings
are related to issues with creating in-app guidance, not errors that users encountered. For example, errors and warnings occur when a
page doesn’t support a prompt, a page with a prompt is deleted, or a field-level error occurs.
1. From Setup, in the Quick Find box, enter In-App Guidance, and then select In-App Guidance.
2. Find the in-app guidance that has errors or warnings, and click the icon on the left side of the number column.
3. From the row-level action menu, click Edit to open the In-App Guidance Builder.
4. Resolve the error or warning.
5. Back on the In-App Guidance Setup page, click Clear Errors in the row-level action menu.

Note: Clear the errors only after you confirmed that the error is resolved.

6. If the cause of an error in a walkthrough isn’t clear, you can create a report to help you troubleshoot.
a. Set up a custom report type using the Prompt Actions object.
b. Add these fields as columns in the report.
• Step Number
• Last Display Date
• Last Result (look for the Error valid value)
• Name
• User: Full Name

Tip: Missing fields when you create or edit a report? You can design the field layout for reports created from a custom
report type. From the Report Types Setup page, select the custom report type you want to edit. Click Edit Layout on the
Fields Available for Reports section.

SEE ALSO:
Monitor In-App Guidance in Lightning Experience
Create a Custom Report Type

Disable Salesforce Standard In-App Guidance in Lightning Experience

If in-app content authored by Salesforce isn’t suitable for your users, you can turn it off from the In-App Guidance page in Setup.

Note: Users can still access content on their own through links and the Guidance Center when Salesforce Standard In-App
Guidance is disabled.
1. From Lightning Experience Setup, in the Quick Find box, enter In-App Guidance, and then select In-App Guidance.
2. Click Settings.
3. Deselect Salesforce Standard In-App Guidance.

87
Extend Salesforce with Clicks, Not Code Custom Help Content

Guidelines for In-App Guidance in Managed Packages

You can include prompts and walkthroughs in a managed package, with some limitations.
EDITIONS

Before Creating a Package Available in: Lightning

Experience
For information about creating a managed package, see Create a Package and Components Available
in Managed Packages. Available in: Essentials,
Group, Professional,
For developer information about the in-app guidance records included in the managed package,
Enterprise, Performance,
see the Prompt and PromptVersion object reference.
Unlimited, and Developer
You don’t have to purchase a license to package in-app guidance. Editions

Not available for: Chatter

After Installing a Package External and Chatter Free
After you install a managed package that includes in-app guidance, the In-App Guidance page in user licenses
Setup includes the packaged in-app guidance. Available with Enablement,
• The Created By column shows the name of the admin who installed the package. which is available with Sales
Cloud, Service Cloud,
• The Package column indicates that the in-app guidance was installed with a package.
Financial Services Cloud,
• The Active column shows the status that the package owner set. For example, a prompt marked Health Cloud, and
as active in the package is active after installing it in your org. After installation, you can change Salesforce Platform for an
the publish status at any time from the In-App Guidance Setup page. additional cost in:
Enterprise, Performance,
and Unlimited Editions
Other Data in Packages
Data other than in-app guidance that’s included in the managed package can affect whether the Available with Sales
Enablement (myTrailhead),
in-app guidance installs successfully.
which is available in:
• If the package includes a custom profile that isn’t part of your Salesforce org, the in-app guidance Enterprise, Performance,
is installed, but it doesn’t include those custom items. For example, you install a prompt with and Unlimited Editions
several custom profiles not included in your org. The prompts are installed without those custom
profiles.
• If the package includes a custom permission that isn’t a part of your Salesforce org, the installation fails.
• If the package includes a standard app that isn’t part of your Salesforce org, the in-app guidance is installed, but it’s not usable.
• If the package owner included translated labels, they can be installed from the package.
Always consult the package owner for specific details about the package containing in-app guidance.

Walkthroughs in Packages
• If a managed or unmanaged package includes walkthroughs for standard apps, walkthroughs are installed. However, production
orgs can have only three active walkthroughs at a time without subscribing to Enablement Sites (myTrailhead).
• If a security-reviewed, first-generation managed package includes walkthroughs with at least one step on a page within a custom
app, users can see the walkthroughs without a subscription to Enablement Sites (myTrailhead).

Prompts for Quick Actions in Packages

For targeted prompts in an unmanaged package associated with a quick action, the quick action component isn’t included in the package.
The package can only be installed in an org that has a quick action with the same name as the quick action targeted by the prompt.

88
Extend Salesforce with Clicks, Not Code Custom Help Content

When targeted prompts are installed from a managed package, the quick actions they target aren’t included in the package. Those quick
actions must be added to the page where the prompt appears. Otherwise, the prompt has nothing to target and becomes a floating
prompt.

Editing and Cloning In-App Guidance in Packages

In-app guidance cloned from managed packages doesn’t receive updates from the package owner.
For in-app guidance installed from packages, you can edit only the schedule, profiles, permissions, and status settings. You can’t add,
remove, or reorder steps from a walkthrough installed from a managed package.
For cloned prompts and walkthroughs, you can edit any setting except the in-app guidance type (prompt or walkthrough).

Limits for In-App Guidance

The number of prompts and walkthroughs you can create in your org is limited. The number of
EDITIONS
prompts and walkthroughs you can install from AppExchange isn’t limited but we recommend a
maximum number that you can have at one time. Available in: Lightning
Experience
In-App Guidance Limit Salesforce
Recommendation Available in: Essentials,
Group, Professional,
Walkthroughs installed from No limit currently. An 500 Enterprise, Performance,
AppExchange enforceable limit is possible in Unlimited, and Developer
future releases. Editions

Walkthroughs created in your 500 No specific recommendation Not available for: Chatter
org External and Chatter Free
user licenses
Steps in a walkthrough 10 No specific recommendation
Available with Enablement,
Prompts installed from No limit currently. An 500 which is available with Sales
AppExchange enforceable limit is possible in Cloud, Service Cloud,
future releases. Financial Services Cloud,
Health Cloud, and
Prompts created in your org 500 No specific recommendation
Salesforce Platform for an
additional cost in:
Enterprise, Performance,
SEE ALSO: and Unlimited Editions
Types of In-App Guidance
Available with Sales
Define Prompts in Lightning Experience Enablement (myTrailhead),
Define Walkthroughs in Lightning Experience which is available in:
Enterprise, Performance,
and Unlimited Editions

89
Extend Salesforce with Clicks, Not Code Custom Help Content

Learning Paths
Create a personalized and always-available learning experience for your users. When you customize
EDITIONS
Learning Paths, you can choose whom to assign a learning item to—individuals, public groups, or
all users. The Guidance Center icon in the global header opens a panel where users can see Available in: Lightning
suggestions from Salesforce and your Learning Paths assignments. Associate the learning item with Experience
a particular app or page, and optionally apply a due date. Choose modules from Trailhead or an
enablement site (myTrailhead), and add links to other training resources for the ultimate custom Available in: Developer,
training experience. Admins can let other stakeholders, such as trainers or sales team managers, Professional, Enterprise,
assign and manage learning items. Performance, and
Unlimited Editions
• Get going right away with Assign a Learning Item for Learning Paths.
Not Available for: Chatter
• Understand the layout of the Guidance Center with Find Help in Lightning Experience in
External, Chatter Free, or
Salesforce Help. Learn who sees what type of content.
Communities (now known
• Learn more on Trailhead, and take the User Training and Enablement module. as Experience Cloud) user
Ready to get started? Start reviewing Learning Paths documentation to begin helping your users licenses
as they work in the app. Enablement Sites
Note: As long as your Salesforce-related accounts are part of your Trailblazer.me profile, (myTrailhead) available in:
Enterprise, Performance,
badges that you earn while inside Lightning Experience are included in your profile. See
and Unlimited Editions
Trailblazer.me and Trailhead. If your company has an enablement site, you don’t necessarily
have a Trailblazer.me profile, but you can create one. See Create a Trailhead Account, and log
in with the username and password that you use to log in to Salesforce.
If your company uses Salesforce Identity for Enablement to authenticate users to your
enablement site, the Salesforce Trailhead badges that you earn in-app appear on your
Trailblazer.me profile. The enablement site badges that you earn don’t appear on your
Trailblazer.me profile. See Considerations for Selecting an Authentication Provider

Learning Paths Best Practices

Learn how to define an in-app help strategy, and get tips for customizing Learning Paths.
Considerations for Using Learning Paths
As you prepare to customize Learning Paths for your users, keep these details in mind.
Assign a Learning Item for Learning Paths
You can assign a Trailhead or enablement site (myTrailhead) module or a custom learning item such as a video, tutorial, or reference
guide. You can assign a learning item to individuals, public groups, or all users. And you can associate a learning item with an app
and a particular object and page within the app.
Monitor Learning Paths (Beta)
Use custom reports and dashboards to track user engagement with Learning Paths, Trailhead, and enablement sites (myTrailhead).
Turn Off Learning Paths
Optionally, you can turn off Learning Paths, which hides the Learning Home and prevents admins from assigning learning items to
users. When Learning Paths is turned off, the Guidance Center remains available.

SEE ALSO:
Find Help in Lightning Experience
Customize Content in the Guidance Center

90
Extend Salesforce with Clicks, Not Code Custom Help Content

Learning Paths Best Practices

Learn how to define an in-app help strategy, and get tips for customizing Learning Paths.

Strategy
As you plan your in-app help strategy, think of adding layers of customization to address the needs of your users and, if applicable, your
existing training program. Along with creating in-app guidance, customizing Learning Paths is a great next step.
Learning Paths offers targeted assignment functionality, available now and in upcoming releases. It’s as easy to assign learning items
across Salesforce as it is to assign items to a specific page for specific users. Users can read assigned Trailhead modules and earn badges
right inside the app.
Be sure to let users know that they can access these resources from the Trailhead icon in the global header or from Learning Home. To
make Learning Home easier to find, add Learning to the navigation bar.

Tips to Get Started

Here are some ideas to help you plan which resources to add to Learning Paths.
• Replicate the modules that you added to the global custom section of the Help Menu.
• Add your company’s videos, wiki pages, quick start guides, enablement site (myTrailhead) modules, or other custom resource.
• Assign shorter modules that users can complete in less than a half hour to facilitate learning as the user works.
• Assign only one or two items to a specific page in the app.
• Add due dates to give users a better sense of when to complete the learning item.
• Scope out what to add by listing the learning item, location, audience, and, optionally, due date.
Here are some resources to consider adding. All learning items are Trailhead modules, except as noted.

Onboarding

Learning Item App

Let’s Take Lightning Experience for a Spin (video) All

Searching in Salesforce (video) All

Working with List Views (video) All

Trailhead: Quick Look All

Salesforce User Basics All

Salesforce User Tour All

Salesforce CRM (CRM for Lightning Experience) All

Working from Anywhere

Learning Item App

Virtual Meeting Setup: Quick Look All

Virtual Collaboration All

91
Extend Salesforce with Clicks, Not Code Custom Help Content

Learning Item App

Virtual Whiteboarding: Quick Look All

Effective Emails: Quick Look All

Relationship Building All

Emotional Intelligence All

Fearless Teaming All

Sales

Learning Item App

Sales Cloud: Quick Look Sales

Prospecting to Improve Sales Sales

Demo Delivery Essentials Sales

Demo Storytelling Sales

Design Thinking for Sales Sales

Service

Learning Item App

Service Cloud: Quick Look Service

Service Cloud Agent Experience Service Console

Communication Skills for Customer Service Agents Service

Wellbeing

Learning Item App

The Power of Movement All

The Value of Sleep All

Mindful Living with the Plum Village Monastics All

SEE ALSO:
Find Help in Lightning Experience
Custom Help in Lightning Experience

92
Extend Salesforce with Clicks, Not Code Custom Help Content

Considerations for Using Learning Paths

As you prepare to customize Learning Paths for your users, keep these details in mind.
EDITIONS
Learning Paths isn’t available in sandbox or government environments.
Available in: Lightning
Experience
View Assignments in the Guidance Center
Available in: Developer,
Not all assignments appear in the Guidance Center. Users can find all learning assignments on
Professional, Enterprise,
Learning Home.
Performance, and
Unlimited Editions
Assign a Learning Item
Not Available for: Chatter
There are limits to the assignments that you can make. External, Chatter Free, or
Communities (now known
Assignments Maximum as Experience Cloud) user
licenses
Learning items 500
Enablement Sites
Assignments per learning item 100 (myTrailhead) available in:
Enterprise, Performance,
and Unlimited Editions
An assignment to a public group counts as one assignment.

Note: The number of assignments doesn't always correspond to the number of users assigned
to the learning item. A public group can contain thousands of users, but assigning a learning
item to that public group still counts as only one assignment.
You can assign Trailhead modules that contain quizzes, but not modules that contain hands-on challenges. You can’t assign Trailhead
projects.
You can’t create more than one learning item with the same Trailhead or enablement site module.
When you assign a learning item to a particular app or page, the item is visible in the side panel only to users who are in that app. It’s
visible on Learning Home to all users, regardless of which app a user is in.
To assign a learning item to a group, use a public group. You can’t assign learning items to Roles and Subordinates or Roles and Internal
Subordinates public group member types. You can’t assign learning items to permission set groups, personal groups, or Chatter groups.
When you assign a Trailhead or enablement site module via Learning Paths, the module assignment appears in the learning panel and
on Learning Home. It doesn’t appear on an assignee’s enablement site home page.

Modify a Learning Item

After you save a learning item, you can’t change its module, custom link, or due date. Delete the learning item and create another one
with the module, link, or due date that you want to assign. To add more assignees to a learning item, use the Add Assignments feature
on Learning Home.
If a module is deleted from Trailhead or an enablement site, any learning item that you created with that module remains in Learning
Paths. To avoid confusing users, delete the learning item.

Delete a Learning Item

If you want to delete a learning item that’s assigned to more than 100,000 users, first unassign users before you delete the learning item.
Otherwise, errors can occur when trying to delete a learning item that’s assigned to a large number of users.

93
Extend Salesforce with Clicks, Not Code Custom Help Content

Gather Feedback on Assigned Modules

When a user completes an assigned Trailhead or enablement site module, they can rate the module on a five-star scale.
For enablement site content, your company can review all the ratings that users submit and use the feedback to help guide content
planning.

Turn Off Learning Paths and Suggested Content

See Turn Off Learning Paths and Turn Off Suggested Content in the Guidance Center.
To hide assigned content from users, delete the assignments or select Don’t assign to anyone.

SEE ALSO:
Assign a Learning Item for Learning Paths
Learning Paths Best Practices
Monitor Learning Paths (Beta)
Turn Off Learning Paths
Turn Off Suggested Content in the Guidance Center

Assign a Learning Item for Learning Paths

You can assign a Trailhead or enablement site (myTrailhead) module or a custom learning item
EDITIONS
such as a video, tutorial, or reference guide. You can assign a learning item to individuals, public
groups, or all users. And you can associate a learning item with an app and a particular object and Available in: Lightning
page within the app. Experience
Watch the video to see how to assign learning items with Learning Paths.
Available in: Developer,
Watch a video Professional, Enterprise,
Performance, and
1. To open the panel, click the icon for Guidance Center in the global header. Unlimited Editions

Not Available for: Chatter

External, Chatter Free, or
Communities (now known
as Experience Cloud) user
2. At the bottom of the panel, click Assign Learning Content to go to Learning Home. licenses
You can also get to Learning Home via the App Launcher. Add Learning Home to your navigation
Enablement Sites
bar for easy access. (myTrailhead) available in:
3. On Learning Home, click Manage Learning Assignments, then click New. Only admins or Enterprise, Performance,
users with the Manage Learning user permission have access to the Manage Learning and Unlimited Editions
Assignments page.
4. In the New learning item window, select a content type, then search for a Trailhead or USER PERMISSIONS
enablement site module, or enter the URL for a custom link.
To manage as an admin
• Modify All Data OR
Customize Application
To manage as a designated
trainer
• Manage Learning

94
Extend Salesforce with Clicks, Not Code Custom Help Content

When users click the link for a Trailhead or enablement site module in the side panel or on Learning Home, the item opens in the
app. Custom links open in a new browser tab. Put custom links that you previously included in the Help Menu in Learning Paths
instead.
5. Under Location, specify where the learning item appears in the app by selecting an app and, if you want, an object and record.

• To make the learning item appear across Salesforce, select All for App and Object and Record.
• To make the learning item show up on every page in an app, select an app in the App picklist, then select All in the Object and
Record picklist.
• To make the learning item show up for a specific object in an app, select a value in the App and the Object and Record picklists.
• To have the learning item show up for the same object across Salesforce, select All in the app picklist, then select a value in the
Object and Record picklist.
• To add a module to a specific Setup page, enter a URL. If you don’t specify a URL, the module shows up on all pages in Setup.

6. Under Assignments, specify which users and public user groups see the module. If you don’t assign the module to at least one user
or public group, it doesn’t show up in the app.

When you assign a learning item to a public group, the assignment also applies to members that you subsequently add to the group.
The assignment is removed for members that you remove from the group.
7. To make the learning item required, include a due date.

95
Extend Salesforce with Clicks, Not Code Custom Help Content

8. Save your changes.

• The Selected for You section in the Guidance Center displays up to two learning items with a due date and no location specified
for Objects and Records. When completed, the learning items are removed from the panel.
• The Related to This Page section in the Guidance Center displays up to two learning items with a location specified for Objects
and Records. When completed, the learning items remain.
• A learning item that’s assigned to an app or a page is visible in the side panel only when users are in the associated app.
• Users can see all assigned learning items on Learning Home.

9. On the Manage Learning Assignments page, you can expand a row in the Name column to see all the users and groups that the
learning item is assigned to.

Use the row-level actions for a learning item to edit, delete, or add assignees to the item.
• To change the page that a learning item is assigned to, select Edit from the actions menu for the learning item.
• To assign a learning item to another individual or group, select Add Assignments from the actions menu for the learning item.
• To remove all assignments, select Unassign All in the row-level actions menu for the learning item.
• To delete a particular assignment, select Remove Assignment from the row-level action menu for an individual or group.

96
Extend Salesforce with Clicks, Not Code Custom Help Content

We suggest that you let your users know about Guidance Center and Learning Home so they can watch out for required content. To
hide Learning Home, in Setup, turn off Learning Paths on the Guidance Center page.

SEE ALSO:
Considerations for Using Learning Paths
Learning Paths Best Practices
Find Help in Lightning Experience
Customize the Help Menu in Lightning Experience
Customize Content in the Guidance Center
Plan Your Enablement Site Solution
Your Trailblazer Profile
Merge Trailblazer Accounts
Personalize the Navigation Bar in Lightning Experience
Personalized Navigation Considerations
Add and Customize Tabs on Lightning Pages Using the Lightning App Builder
What Is a Group?
Create and Edit Groups

Monitor Learning Paths (Beta)

USER PERMISSIONS EDITIONS

To create custom reports and dashboards Manage Learning Reporting Available in: Lightning
for Learning Paths Experience

To create and update custom report types Legacy Folder Sharing Available in: Developer,
Create and Customize Reports Professional, Enterprise,
Performance, and
AND Unlimited Editions
Manage Custom Report Types
Not Available for: Chatter
Enhanced Folder Sharing External, Chatter Free, or
Create and Customize Reports Communities (now known
AND as Experience Cloud) user
licenses
Manage Custom Report Types
Enablement Sites
To delete custom report types Legacy Folder Sharing (myTrailhead) available in:
Create and Customize Reports Enterprise, Performance,
and Unlimited Editions
AND
Manage Custom Report Types
AND
Modify All Data
Enhanced Folder Sharing
Create and Customize Reports

97
Extend Salesforce with Clicks, Not Code Custom Help Content

AND
Manage Custom Report Types
AND
Modify All Data

Use custom reports and dashboards to track user engagement with Learning Paths, Trailhead, and enablement sites (myTrailhead).

Note: As a beta service, Monitoring Learning Paths is subject to the Beta Services terms at:
https://www.salesforce.com/company/legal/agreements.jsp. 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.

Use Cases for Reporting on Learning Paths

Learning Paths comes with four objects. Two of them give you information about Trailhead and an enablement site, and two give you
information about your assignments in Learning Paths. You can:
• Track the number of Trailhead and enablement site modules completed, including total points earned and how long it took each
user to complete each module.
• Identify the modules that are the most popular with your users by tracking how many people complete each one.
• Track the number of assigned modules that your users started but haven’t completed to get an idea of how helpful that learning
item is.
• Track how many learning items you assign in a given month and how many are in progress, overdue, or completed.
• Filter your reports by user fields such as username, profile, role, manager, or locale.
Here are examples of how you can use the four objects to track your users’ progress on learning items. Set up a custom report type using
one of the following objects to monitor Learning Paths.

Object Pulls Data from... Create a Report Showing...

Learning Content Trailhead and an enablement site How many Trailhead or enablement site
modules exist, by module title, and how
many points a user can earn for each

Learning Content Progress Trailhead and an enablement site How many Trailhead and enablement site
modules your users completed
Which users completed a particular
Trailhead or enablement site module and
how long it took them to finish
How many enablement site modules are in
progress
How many total points earned
company-wide

98
Extend Salesforce with Clicks, Not Code Custom Help Content

Object Pulls Data from... Create a Report Showing...

Learning Learning Paths How many individual users you assigned a
learning item to and how many of those
users completed the item

Learning Assignment Progress Learning Paths Which users you assigned a learning item
to, which users have it in progress, and
which users completed it
Which users have an overdue learning
assignment
The percentage of your users that
completed an assigned learning item

For example, create a report that associates the Learning Content object with the Learning object and Learning Assignments Progress
object. Then you can review data on the modules that you assign to specific users and those users' progress on the assigned modules.

After you create reports, you can create a dashboard that shows key data.

1. Number of Trailhead and enablement site modules completed company-wide, by week

2. Most popular Trailhead and enablement site modules

99
Extend Salesforce with Clicks, Not Code Custom Help Content

3. Number of Trailhead and enablement site modules completed company-wide

4. Number of hours spent reading Trailhead and enablement site modules company-wide
5. Number of points earned company-wide
6. Number of Trailhead and enablement site modules that your users have started but not yet finished

Considerations for Monitoring Learning Paths

You can track user engagement with Trailhead and enablement site modules, but not with custom links.
Reports using the Learning Content and Learning Content Progress objects show a maximum of 1,000 rows.
You can filter a report on the Learning Content Progress object by the date when a user began a module, but not when a user completed
the module.
You can’t filter a report on the Learning Assignment Progress object by the date when a user completed a module.
To report on users' learning assignment progress, filter your report on the Title field from the Learning Content object. You can't create
a report that shows users' progress on all assigned Trailhead modules.
You can’t track how many public groups or public group members you assigned a learning item to.
For more details on limitations for reports on Learning Paths, see Limits on Report Types and Report Considerations for Salesforce
Connect—All Adaptors in Salesforce Help.

SEE ALSO:
Assign a Learning Item for Learning Paths
Create a Custom Report Type
Limits on Report Types
Manage Custom Report Types
Build a Lightning Experience Dashboard
Reports

Turn Off Learning Paths

Optionally, you can turn off Learning Paths, which hides the Learning Home and prevents admins
USER PERMISSIONS
from assigning learning items to users. When Learning Paths is turned off, the Guidance Center
remains available. Change Guidance Center
1. From Setup, in the Quick Find box, enter Guidance Center, and then select Guidance Settings
• Modify All Data
Center.
OR
2. Turn off Learning Paths.
Customize Application

100
Extend Salesforce with Clicks, Not Code Custom Help Content

Guidance Center
The Guidance Center panel in Lightning Experience provides a convenient location for showing
EDITIONS
content that's assigned to or recommended for the current user. The Guidance Center includes not
only suggested content that's authored by Salesforce but also custom content that you manage. Available in: Lightning
With Learning Paths, you can manage the learning items—custom links, videos, and Trailhead Experience
modules—that are available in the Guidance Center and assign those items to specific users with
optional due dates. Available in: Starter,
Professional, Enterprise,
Note: The Guidance Center isn’t supported in the Salesforce mobile app. Trailhead modules Performance, Unlimited,
aren’t available in the Guidance Center in sandbox environments. and Developer Editions

Explore the Guidance Center

Open the Guidance Center to easily access help while in the flow of work.
Explore Guidance Sets
Salesforce admins, Enablement admins, and all Starter Edition users have access to guidance sets in the Guidance Center. Guidance
sets offer personalized setup and learning resources that align with experience level and a specific business journey. Each guidance
set includes suggested resources to help you successfully complete your job.
Customize Content in the Guidance Center
To add your own learning items in the Guidance Center, assign content with Learning Paths. Or, optionally hide Learning Home or
Salesforce suggestions.
Configuring the Size and Position of the Guidance Center
Personalize the in-app content experience with options for pinning and unpinning the Guidance Center panel. The Guidance Center
panel also automatically expands for videos and Trailhead modules, offering more room on the screen for your content.
Turn Off Suggested Content in the Guidance Center
Optionally, you can turn off Salesforce suggestions for content in the Guidance Center for end users. Suggested content still appears
for admins. The Guidance Center remains available so you can assign specific learning items with Learning Paths.
Turn Off Salesblazer Content in the Guidance Center
Optionally, turn off Salesblazer content in the Guidance Center for end users. The Guidance Center remains available for other content.

Explore the Guidance Center

Open the Guidance Center to easily access help while in the flow of work.
EDITIONS
To open the Guidance Center panel, in the global header, click the Guidance Center icon.
Available in: Lightning
Experience

Available in: Starter,

Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

The Guidance Center panel includes these sections.

101
Extend Salesforce with Clicks, Not Code Custom Help Content

Selected for You (1)

Includes suggested content that’s specific to your role. Learning items assigned through Learning Paths also appear here when they
have a due date but no specific object or record location. Content is removed from this section when you complete it.
Salesblazer (2)
Includes insights, tips, and strategies curated for and written by sales leaders and professionals, originally published on the Salesforce
website. Content in the Salesblazer section opens in a new browser tab. Clicking an item in the Salesblazer section opens the content
in a new browser tab. Items remain in the Salesblazer section until the source content is refreshed, which occurs weekly on average.
Related to This Page (3)
Includes contextual content that’s specific to the page that you’re currently working on. Learning items assigned through Learning
Paths also appear here when they have a specific object or record location. Content remains visible in this section when complete
it so you can refer to it again. If there’s no contextual content or assignments for the page, the section is removed.
If your company uses Enablement for sales reps, the Guidance Center also shows a user’s assigned Enablement programs.

SEE ALSO:
Take Enablement Programs

102
Extend Salesforce with Clicks, Not Code Custom Help Content

Explore Guidance Sets

Salesforce admins, Enablement admins, and all Starter Edition users have access to guidance sets
EDITIONS
in the Guidance Center. Guidance sets offer personalized setup and learning resources that align
with experience level and a specific business journey. Each guidance set includes suggested resources Available in: Lightning
to help you successfully complete your job. Experience
1. Open the Guidance Center.
Available in: Starter,
The Selected for You section shows up to two guidance sets.
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

2. To find all available guidance sets, click View More.

As you open resources and complete steps in a guidance set, they’re marked as completed.

103
Extend Salesforce with Clicks, Not Code Custom Help Content

Customize Content in the Guidance Center

To add your own learning items in the Guidance Center, assign content with Learning Paths. Or,
EDITIONS
optionally hide Learning Home or Salesforce suggestions.
For information about assigning learning items with Learning Paths, see Assign a Learning Item for Available in: Lightning
Learning Paths. Experience
You can also turn off certain content in the Guidance Center. Available in: Starter,
• Turn Off Learning Paths Professional, Enterprise,
Performance, Unlimited,
• Turn Off Suggested Content in the Guidance Center and Developer Editions
• Turn Off Salesblazer Content in the Guidance Center

USER PERMISSIONS
SEE ALSO:
Find Help in Lightning Experience Change Guidance Center
Settings
Learning Paths • Modify All Data OR
Customize Application

Configuring the Size and Position of the Guidance Center

Personalize the in-app content experience with options for pinning and unpinning the Guidance
EDITIONS
Center panel. The Guidance Center panel also automatically expands for videos and Trailhead
modules, offering more room on the screen for your content. Available in: Lightning
Experience
Pinning and Unpinning the Guidance Center Available in: Starter,
The Guidance Center panel can overlap some elements of the page in Lightning Experience. To Professional, Enterprise,
split the screen between the Guidance Center and the Lightning Experience page, side by side with Performance, Unlimited,
no overlap, click the pin icon in the Guidance Center header. and Developer Editions

Salesforce remembers a user’s pin selection for the browser and device they’re on.

Tip: Pinning works best on wide screens. If the screen is too narrow, the Guidance Center can still overlap content on the page
even when it’s pinned.
To exit the split view and have the Guidance Center overlap the Lightning Experience page again, click the unpin icon in the Guidance
Center header.

Note: If you’re using Enablement programs, the Guidance Center is pinned by default.

To turn off pinning and unpinning, contact Salesforce Customer Support.

Expanded View for Videos and Trailhead Content

Some content types in the Guidance Center, such as videos or Trailhead units, are easier to experience when you have more room on
the screen. For these content types, the Guidance Center automatically expands to a larger width.
To resize the Guidance Center after it expands, toggle the arrow icon.

104
Extend Salesforce with Clicks, Not Code Custom Help Content

Turn Off Suggested Content in the Guidance Center

Optionally, you can turn off Salesforce suggestions for content in the Guidance Center for end users.
EDITIONS
Suggested content still appears for admins. The Guidance Center remains available so you can
assign specific learning items with Learning Paths. Available in: Lightning
1. From Setup, in the Quick Find box, enter Guidance Center, and then select Guidance Experience
Center.
Available in: Starter,
2. Turn off Salesforce Suggestions for End Users. Professional, Enterprise,
Performance, Unlimited,
Note: Turning off Salesforce suggestions also turns off Salesblazer content in the Guidance and Developer Editions
Center. When Salesforce suggestions are on, you can optionally turn off Salesblazer content
separately.
USER PERMISSIONS

Change Guidance Center

Settings
• Modify All Data
OR
Customize Application

105
Extend Salesforce with Clicks, Not Code Custom Help Content

Turn Off Salesblazer Content in the Guidance Center

Optionally, turn off Salesblazer content in the Guidance Center for end users. The Guidance Center
EDITIONS
remains available for other content.
1. From Setup, in the Quick Find box, enter Guidance Center, and then select Guidance Available in: Lightning
Center. Experience
2. Turn off Salesblazer Content. Available in: Starter,
Professional, Enterprise,
Note: If you turn off Salesforce suggestions for content in the Guidance Center, Salesblazer
Performance, Unlimited,
content also turns off. and Developer Editions

SEE ALSO:
USER PERMISSIONS
Turn Off Suggested Content in the Guidance Center
Salesforce: Salesblazer Website Change Guidance Center
Settings:
• Modify All Data
OR
Customize Application

Customize the Help Menu in Lightning Experience

The question mark icon in the global header opens a menu of related resources for a page, Trailhead
EDITIONS
modules, videos, and more items suggested by Salesforce. The Help Menu offers a default in-app
help experience for companies that don’t have custom guidance or training available to users. You Available in: Lightning
can supplement the recommended resources by adding a global section with links to your own Experience
content.
Available in: Group,
Select the question mark icon in the global header to open the Help Menu.
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create custom help:

• Customize Application
OR Modify All Data

106
Extend Salesforce with Clicks, Not Code Custom Help Content

If you added custom resources, users see those resources first (1). New users can check out Getting Started (2). Different resources are
shown to users and admins. As you read, more suggested resources appear.
When appropriate, Salesforce suggests help topics, videos, Trailhead modules, and more under Help for This Page (3). Click the section
name or the arrow to view all resources for the page. If there are no suggested resources for the page, the section is hidden.
For general tasks such as searching help documentation and Trailhead, getting support, going to Trailhead, or learning about keyboard
shortcuts, look under More Resources (4). Admins see a link to view release notes.

Note: To create an improved and more robust learning experience for your users, check out Guidance Center on page 104 and
Learning Paths on page 90.
Add resources to the custom section of the Help Menu. Your section appears at the top of the Help Menu on each page. There’s only
one custom Help Menu section per org. You can’t add links to the Getting Started, Help For This Page, or More Resources sections.
1. From Setup in Lightning Experience, in the Quick Find box, enter Help Menu, and then select Help Menu.
2. Enter a title for the custom section. Salesforce recommends naming the section so that users understand that the resources are
custom help for your org or company. For example, Acme Company Help. Labels aren’t translated and appear as you entered
them.
3. Tip: List the most important resources first. Only the first two resources are shown in each section. Users can view all resources
by clicking the section name or the arrow.

107
Extend Salesforce with Clicks, Not Code Custom Help Content

Add labels and URLs for the resources. You can add up to 30 resources. Items are listed in the Help Menu in the order that they
appear on the setup page.
4. Save your changes.
5. Turn on Customize the Help Menu.
If you find that some sections of the Help Menu aren’t working for your users, simply hide them. Under Salesforce Help Content, turn off
the sections and links that you want to hide. As an admin with the Customize Application or Modify All Data user permission, you always
see all resources, including a link to the release notes.

Important: If you install a package with custom Help Menu resources, they don't appear in your Help Menu Setup page or in the
Help Menu user interface. To add resources per the package suggestions, use the CustomHelpMenuItem and
CustomHelpMenuSection SOAP API objects to view the information contained in the package. Then manually add any resources
to the Help Menu Setup page.
The Help Menu isn’t supported in the Salesforce mobile app.

SEE ALSO:
Find Help in Lightning Experience

Custom Help in Salesforce Classic

In Salesforce Classic, object-level help replaces the links for a custom object or external object page. Replace built-in Salesforce Help
with documentation that’s customized for your users.

Object-Level Help in Salesforce Classic

Help your users by providing object-level help for all custom objects and external objects. This way, when your users click the Help
for this Page link on your custom object, they’ll find useful information that’s relevant to your custom object. When you add custom
help to a custom or external object, the Help for this Page link on those object pages displays your custom help instead of generic
help. Your users can access the custom help content from the object home (overview), detail, and edit pages, list views, and related
lists.

Object-Level Help in Salesforce Classic

Help your users by providing object-level help for all custom objects and external objects. This way, when your users click the Help for
this Page link on your custom object, they’ll find useful information that’s relevant to your custom object. When you add custom help
to a custom or external object, the Help for this Page link on those object pages displays your custom help instead of generic help.
Your users can access the custom help content from the object home (overview), detail, and edit pages, list views, and related lists.

Note: If you don’t create object-level help, the Help for this Page link provides information about standard objects that won’t
be relevant to your custom object. You can override the Help for this Page links for a custom object or external object with help
content contained in a Visualforce page. But don’t worry! You don’t have to learn Visualforce to add help content to your custom
objects.

108
Extend Salesforce with Clicks, Not Code Custom Help Content

Define Org-Level Help in Salesforce Classic

If you rename standard tabs, objects, fields, and other related user interface labels, you can also replace the built-in Salesforce Help
with documentation that’s customized specifically for your users. To replace the built-in help, simply provide a URL to your custom
help. This feature is available for Salesforce Classic only.

SEE ALSO:
Custom Help Content
Define Object-Level Help in Salesforce Classic
Object-Level Help Considerations in Salesforce Classic

Define Object-Level Help in Salesforce Classic

Object-level help overrides the Help for this Page links for a custom object or external object with
EDITIONS
your own help content contained in a Visualforce page. To make object-level help available to all
your users, create a Visualforce page that contains your help content. Then edit the custom or Available in: Salesforce
external object definition to reference the page. Object-level help becomes available to all your Classic
users instantly.
Custom objects are
1. Create a Visualforce page that contains your help content.
available in: Contact
2. Edit the custom object definition or external object definition that uses the custom help when Manager, Group,
users click the Help for this Page link. Professional, Enterprise,
Performance, Unlimited,
3. For Context-Sensitive Help Setting, select Open a window using a Visualforce
and Developer Editions
page.
Salesforce Connect external
4. Select the Visualforce page that contains your help content.
objects are available in
5. Save you work. Developer Edition and, for
an extra cost, in Enterprise,
Performance, and Unlimited
SEE ALSO:
Editions.
Object-Level Help in Salesforce Classic
Custom Help Content
USER PERMISSIONS

To define or change
object-level help:
• Customize Application

109
Extend Salesforce with Clicks, Not Code Custom Help Content

Create a Custom Object Help Page with Static Content in Salesforce Classic
If you know HTML, it’s easy to add help to your custom objects by writing the content in HTML and
EDITIONS
saving it in a Visualforce page. No need to learn Visualforce. Just use the template that we provide.
1. From Setup, enter Visualforce Pages in the Quick Find box, then select Visualforce Available in: Salesforce
Pages. Classic
2. Click New. Custom objects are
The Visualforce page editor opens with a new page. available in: Contact
3. Complete the following fields. Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
Field Description
and Developer Editions
Label The human-friendly name of the page used to identify the page in Salesforce Connect external
Setup tools. objects are available in:
Developer Edition and for
Tip: It’s a great idea to have a naming convention for your
an extra cost in: Enterprise,
custom help pages. For example, start all custom help pages
Performance, and
with “Help_” and then the object name. Unlimited Editions

Name The API name for the page. You can use the auto-filled value. Visualforce is available in:
Contact Manager, Group,
Description An optional description of the page. Professional, Enterprise,
Performance, Unlimited,
Available for Select this option if your custom object is available in the Salesforce and Developer Editions
Lightning Experience, mobile app.
Experience Builder
sites, and the mobile USER PERMISSIONS
app
To define or change
object-level help:
• Customize Application
4. Click Quick Save.
To create or edit Visualforce
5. In the Visualforce Markup tab code editor, select the default code and delete it. pages:
6. Paste the following help template code into the code editor. • Customize Application

<apex:page showHeader="false">

<!-- Add your help styles -->

<h1>Help for {YourObjectName} Object</h1>

<p>Your custom help message here.</p>

</apex:page>

7. Click Quick Save.

8. Edit the template to add your help content.
To add formatting to your page, use HTML markup. You can also use Visualforce markup if you know it.

9. Click Save.

110
Extend Salesforce with Clicks, Not Code Custom Help Content

You can now add this page as custom help. When users click Help for this Page, they see this page in the Help & Training window.

SEE ALSO:
Define Object-Level Help in Salesforce Classic
Create Custom Object Help with a PDF File in Salesforce Classic
Object-Level Help Considerations in Salesforce Classic

Create Custom Object Help with a PDF File in Salesforce Classic

Add help to your custom objects by creating Visualforce pages that redirect to PDF help files or a
EDITIONS
URL. No need to learn Visualforce. Just use the template that we provide.
You can write your help content in an authoring tool such as Microsoft Word and convert it to a Available in: Salesforce
PDF file. Classic
1. Upload your PDF file as a static resource. Custom objects are
Users see this PDF file when they request help with the custom object. available in: Contact
Manager, Group,
2. From Setup, enter Visualforce Pages in the Quick Find box, then select Visualforce Professional, Enterprise,
Pages. Performance, Unlimited,
3. Click New. and Developer Editions
The Visualforce page editor opens with a new page. Salesforce Connect external
objects are available in:
4. Complete the following fields.
Developer Edition and for
an extra cost in: Enterprise,
Field Description Performance, and
Label The human-friendly name of the page used to identify the page in Unlimited Editions
Setup tools. Visualforce is available in:
Contact Manager, Group,
Tip: It’s a great idea to have a naming convention for your
Professional, Enterprise,
custom help pages. For example, start all custom help pages Performance, Unlimited,
with “Help_” and then the object name. and Developer Editions

Name The API name for the page. You can use the auto-filled value.

Description An optional description of the page. USER PERMISSIONS

Available for Select this option if your custom object is available in the Salesforce To define or change
object-level help:
Lightning Experience, mobile app.
• Customize Application
Experience Builder
sites, and the mobile To create or edit Visualforce
app pages:
• Customize Application

5. Click Quick Save.

6. In the Visualforce Markup tab code editor, select the default code and delete it.
7. Paste the following help template code into the code editor.
<apex:page showHeader="false" action="{! URLFOR($Resource.YourCustomHelpResource) }">

111
Extend Salesforce with Clicks, Not Code Custom Help Content

<!-- This page redirects to the URL in the action attribute above -->

<p>Redirecting to help content...</p>

</apex:page>

8. Replace YourCustomHelpResource in the action attribute with the name of the static resource that you uploaded.
9. Click Save.
You can now add this page as help. When users click Help for this Page, they’re redirected to the resource you set in the action attribute.

Note: The user’s browser controls the behavior of a PDF link, not your Visualforce page. The PDF content might display in the
browser or be downloaded as a PDF file.

SEE ALSO:
Define Object-Level Help in Salesforce Classic
Create a Custom Object Help Page with Static Content in Salesforce Classic
Object-Level Help Considerations in Salesforce Classic

Object-Level Help Considerations in Salesforce Classic

Before defining object-level help text for your custom or external objects, review these best practices
EDITIONS
and implementation considerations.
Available in: Salesforce
Best Practices Classic (not available in all
orgs)
• The window that displays your object-level help has the same height and width dimensions
as the standard Salesforce Help & Training window. To increase the usability of your help content, Custom objects are
size and style your content appropriately. available in: Contact
Manager, Group,
• Your Visualforce help content pages can use merge fields or other functions to make the
Professional, Enterprise,
experience more personalized. For example, you can design the help to add the user’s name
Performance, Unlimited,
when the help page is displayed.
and Developer Editions
Salesforce Connect external
Advanced Implementation Considerations objects are available in:
• Create custom help Visualforce pages without a controller, or use a custom controller. You can’t Developer Edition and for
use a standard controller. an extra cost in: Enterprise,
Performance, and
• If you have defined object-level help for an object that you add to a Salesforce AppExchange
Unlimited Editions
package, Salesforce adds the Visualforce page or static resource referenced in your
Context-Sensitive Help Settings for that object. Visualforce is available in:
Contact Manager, Group,
• In managed packages, object-level help is locked to the developer, giving installers the ability Professional, Enterprise,
to change it if needed. Performance, Unlimited,
and Developer Editions
SEE ALSO:
Define Object-Level Help in Salesforce Classic
Object-Level Help in Salesforce Classic

112
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

Define Org-Level Help in Salesforce Classic

If you rename standard tabs, objects, fields, and other related user interface labels, you can also
EDITIONS
replace the built-in Salesforce Help with documentation that’s customized specifically for your
users. To replace the built-in help, simply provide a URL to your custom help. This feature is available Available in: Salesforce
for Salesforce Classic only. Classic (not available in all
Users can view this URL whenever they click on any context-sensitive help link on an end-user page orgs)
or within their personal settings. After you replace the help, the Help & Training link at the very
Available in: All Editions
top of every page and all Setup pages will continue to display the Salesforce Help. except Database.com
1. From Setup, enter Help Settings in the Quick Find box, then select Help Settings.
2. Enter the complete URL for your help file that you would like to replace the Salesforce Help.
3. Click Save.

Considerations for Replacing the Salesforce Help

• When you replace the Salesforce Help with your own help file, the Help & Training link still displays Salesforce Help. However, other
than within Setup, the Help for this Page links on all pages are no longer context-sensitive. That is, your help file will open at the
same place regardless of which page the user is viewing when they click the link.
• You can make your help context-sensitive by taking advantage of the context-specific parameters that are passed with each help
link. For example, the help link from the Opportunities tab home page is constructed as follows (without any line breaks):
http://your_help_file.com?loc=help&amp;body=%2Fhelp%2Fdoc%2Fen%2Fhelp2.jsp
&target=opp_overview.htm&section=Opportunities
The values of the target and section parameters are unique for every page within the application. You can parse these
parameters to display context-sensitive help content for your users.

Tailor Business Processes to Different Record Types Users

Record types let you offer different business processes, picklist values, and page layouts to different
EDITIONS
users. You can create record types to differentiate your regular sales deals from your professional
services engagements, offering different picklist values for each. Or you can display different page Available in: both Salesforce
layouts for your customer support cases versus your billing cases. Classic and Lightning
Here’s an example of how record types can work in your org. Let’s say you have two sales divisions, Experience
hardware and consulting, and only your consulting division receives leads through seminars. You
Available in: Professional,
can choose to display the Seminar contact lead source for the consulting division only. Enterprise, Performance,
Step 1: Manage master picklists Unlimited, and Developer
Define a list of contact Lead Source picklist values that contains all the values used by Editions
both the Hardware and Consulting divisions, including Seminar.
Step 2: Create record types
USER PERMISSIONS
Create two contact record types: one called Hardware and another called Consulting. This step
includes adding master picklist values to the record types. To create or change record
Step 3: Add record types to profiles types:
Add the Hardware record type to the profiles for all users in the hardware sales division. Add • Customize Application
the Consulting record type to the profiles of all users in the consulting sales division.

113
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

Step 4: Set personal options for record types

Let users of both the hardware and consulting sales divisions bypass the prompt that asks them to select a record type when creating
a contact. If you have users that create contact records for both sales divisions, they can customize their personal settings to always
prompt them to select a record type.

Considerations for Creating and Updating Record Types and Picklists

Keep these considerations in mind when working with record types and business process picklists.
Create Record Types
Edit Picklists for Record Types and Business Processes
Customize the values in record type or business process picklists based on your organization’s unique needs.
Limitations for Creating and Updating Record Types and Picklists
Keep these limitations in mind when working with record types and business process picklists.
Managing Multiple Business Processes
Use multiple business processes to display different picklist values according to each user’s profile. Use multiple business processes
to track separate sales, support, and lead lifecycles.
Create Multiple Business Processes

SEE ALSO:
How Is Record Type Access Specified?

Considerations for Creating and Updating Record Types and Picklists

Keep these considerations in mind when working with record types and business process picklists.
EDITIONS

General Available in: both Salesforce

Classic and Lightning
• If each profile is associated with a single record type, users will never be prompted to select a Experience
record type when creating records.
Available in: Professional,
• Don’t name your record type Master because it’s reserved for record types.
Enterprise, Performance,
• Don’t use record types as an access control mechanism. Profile assignment governs create and Unlimited, and Developer
edit access for an object but doesn’t govern read access. For example, a user assigned to a Editions
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 applied appropriate access controls.
• A user can be associated with several record types. For example, a user who creates marketing campaigns for both US and European
divisions can have both US and European campaign record types available when creating campaigns.
• When creating and editing record types for accounts, opportunities, cases, contacts, or custom objects, check for criteria-based
sharing rules that use existing record types as criteria. A record type change may affect the number of records that the rule shares.
For example, let's say you have a record type named Service, and you created a criteria-based sharing rule that shares all Service
record types with your service team. If you create another record type named Support, and you want these records shared with your
service team, update the sharing rule to include Support record types in the criteria.
• Deleting a record type also deletes the related path.

114
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

• Business and person accounts require at least one active record type.
• Deleting campaign member record types updates the Campaign Member Type field on campaign and campaign member records.
• Person accounts are account records to which a special record type has been assigned. These record types are called person account
record types. Person account record types allow contact fields to be available on the account and allow the account to be used as if
it were a contact. A default person account record type named Person Account is automatically created when person accounts are
enabled for your org. You can change the name of this record type, and you can create more person account record types.
• From the UI, you can change an account’s record type from a business account to a business account or from a person account to
a person account. However, to change an account’s record type from a business account to a person account, or vice versa, you
must use the API.
• When users convert, clone, or create records, these special considerations apply.
– When a user converts a lead, the new account, contact, and opportunity records use the default record type for the owner of
the new records. The user can choose a different record type during conversion.
– When a user clones a record, the new record has the record type of the cloned record. If the user’s profile doesn’t have access
to the record type of the cloned record, the new record adopts the user’s default record type.
– When a user creates a case or lead and applies assignment rules, the new record can keep the creator’s default record type or
take the record type of the assignee, depending on the case and lead settings specified by the administrator.

• Changing a record type causes Lightning pages to refresh.

Deactivating Record Types

Consider these guidelines if you are deactivating a record type.
• Deactivating a record type doesn’t remove it from any user profiles or permission sets.
• Deactivating a record type means that no new records can be created with the record type. However, any records that were previously
created with the record type are still associated with it and with its associated page layout.
• To deactivate all record types from an object, remove all record types from all the profiles and deactivate the record types. Then
create one new record type and activate it, but don’t add it to any profiles. One record type must exist to enable existing records
that used the deactivated record types to display properly.
If you encounter any issues inline editing a record in Lightning Experience after deactivating a record type, edit the Page Layout Assignment
so that another layout on the object, such as the default layout, is used for the custom record type. Otherwise, consider reactivating the
disabled record type.

Record Types and Picklists

• Before creating record types, include all the possible record type values in your master list of picklists. The master picklist is a complete
list of picklist values that can be used in any record type.
• The master picklist is independent of all record types and business processes. If you add a picklist value to the master picklist, you
must manually include the new value in the appropriate record types. If you remove a picklist value from the master, it is no longer
available when creating records, but records assigned to that value are unchanged.

115
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

• When you create a record type without cloning an existing one, the new record type automatically includes the master picklist values
for both standard and custom picklists. You can then customize the picklist values for the record type.

SEE ALSO:
Tailor Business Processes to Different Record Types Users
Create Record Types
Limitations for Creating and Updating Record Types and Picklists

Create Record Types

Tip: Before creating record types, include all of the possible record type values in your master EDITIONS
list of picklists. The master picklist is a complete list of picklist values that can be used in any
record type. Available in: both Salesforce
1. From the management settings for the appropriate object, go to Record Types. Classic and Lightning
Experience
2. Click New.
Available in: Professional,
3. Select Master from the Existing Record Type dropdown list to copy all available picklist values,
Enterprise, Performance,
or choose an existing record type to clone its picklist values. Unlimited, and Developer
Note: When you create a record type without cloning an existing one, the new record Editions
type automatically includes the master picklist values for both standard and custom
picklists. You can then customize the picklist values for the record type. USER PERMISSIONS
4. Enter a Record Type Label that's unique within the object. To create or change record
types:
Important: Don’t name your record type Master because it’s reserved for record types.
• Customize Application

5. Enter a Record Type Name. The Record Type Name refers to the component when using
Metadata API and prevents naming conflicts on package installation in managed packages.
6. For opportunity, case, lead, and solution record types, select a business process to associate with the record type.
7. Enter a description.
8. Select Active to activate the record type.
9. Select Make Available next to a profile to make the record type available to users with that profile. Select the checkbox in the
header row to make it available for all profiles.

Tip: If each profile is associated with a single record type, users will never be prompted to select a record type when creating
records. Users assigned to a record type can still view and edit records associated with record types not enabled for their
profiles.

10. For selected profiles, select Make Default next to a profile to make it the default record type for users of that profile. Select the
checkbox in the header row to make it the default for all profiles.
11. Click Next.
12. Choose a page layout option to determine what page layout displays for records with this record type:
• To apply a single page layout for all profiles, select Apply one layout to all profiles and choose the page layout from the
dropdown list.
• To apply different page layouts based on user profiles, select Apply a different layout for each profile and choose a page
layout for each profile.

116
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

13. Click Save to edit the values of the standard and custom picklists available for the record type, or click Save and New to create
another record type.

SEE ALSO:
Tailor Business Processes to Different Record Types Users
Considerations for Creating and Updating Record Types and Picklists
Limitations for Creating and Updating Record Types and Picklists

Edit Picklists for Record Types and Business Processes

Customize the values in record type or business process picklists based on your organization’s
EDITIONS
unique needs.
1. Select a record type or business process and click Edit next to the picklist field to change its Available in: both Salesforce
values. Classic and Lightning
Experience
2. Add or remove values as needed. Users can choose from these values when creating or editing
records. Record types are available
3. Optionally, choose a default picklist value. Some picklists require a default value. The default in: Professional, Enterprise,
Performance, Unlimited,
value in a dependent field is ignored.
and Developer Editions
4. Click Save.
Business processes are
available in: Enterprise,
SEE ALSO: Performance, Unlimited,
Custom Fields and Developer Editions

USER PERMISSIONS

To create or change record

types:
• Customize Application
To create or change
business processes:
• Customize Application

Limitations for Creating and Updating Record Types and Picklists

Keep these limitations in mind when working with record types and business process picklists.
EDITIONS
• These special picklist fields aren’t available for record types because they’re used exclusively for
sales processes, lead processes, support processes, and solution processes: Available in: both Salesforce
Classic and Lightning
– Opportunity Stage
Experience
– Case Status
Available in: Professional,
– Solution Status
Enterprise, Performance,
– Lead Status Unlimited, and Developer
You can use these fields to provide different picklist values for different record types by assigning Editions
a different process to each record type.
• These campaign member picklists aren’t available for these record types:

117
Extend Salesforce with Clicks, Not Code Tailor Business Processes to Different Record Types Users

– Status
– Salutation
– Lead Source

• If the object is referenced in Apex, you can’t edit or delete a record type for the object.
• If a record type is in use by an email routing address for Email-to-Case or On-Demand Email-to-Case, you can’t deactivate the record
type.
• Record types can only be assigned to campaign members using the Campaign Member Type field on new or existing
campaigns. To assign record types to campaign members, add the Campaign Member Type field to the campaign page
layout. You must have the Marketing User user permission to change the campaign member type. You can also add a
read-only Campaign Member Type field to the campaign members page layout.
• We recommend creating no more than 200 record types. While there’s no limit, orgs can have difficulty managing their record types
if they exceed 200.
• When the org source tracking permission is enabled and you try retrieving information about a specific custom field associated with
a record type, you retrieve information for all the fields associated with that record type. However, when the org source tracking
permission is disabled, you retrieve information only for the standard fields associated with the record type and the field mentioned
in the package.xml file.

SEE ALSO:
Create Record Types
Considerations for Creating and Updating Record Types and Picklists

Managing Multiple Business Processes

Use multiple business processes to display different picklist values according to each user’s profile.
EDITIONS
Use multiple business processes to track separate sales, support, and lead lifecycles.
Sales Processes Available in: both Salesforce
Create different sales processes that include some or all of the picklist values available for the Classic and Lightning
opportunity Stage field. Experience

Lead Processes Available in: Enterprise,

Create different lead processes that include some or all of the picklist values available for the Performance, Unlimited,
Lead Status field. and Developer Editions
Support Processes
Create different support processes that include some or all of the picklist values available for USER PERMISSIONS
the case Status field.
To create or change
Solution Processes business processes:
Create different solution processes that include some or all of the picklist values available for • Customize Application
the Status field.
After creating a sales, support, lead, or solution process, assign the process to a record type. The
record type determines the user profiles that are associated with the business process.
To view a list of business processes, from Setup, enter Processes in the Quick Find box, then select the appropriate link.

SEE ALSO:
Edit Picklists for Record Types and Business Processes

118
Extend Salesforce with Clicks, Not Code Manage Your Translations

Create Multiple Business Processes

Follow these steps to create sales processes, support processes, lead processes, and solution
EDITIONS
processes.
1. From Setup, enter Processes in the Quick Find box, then select the appropriate link. Available in: both Salesforce
Classic and Lightning
2. Click New.
Experience
3. Choose an existing process to copy its picklist values into the new process. Select Master to
copy all available picklist values. Available in: Enterprise,
Performance, Unlimited,
4. Enter a name and description for the new process. The name must be unique within the tab. and Developer Editions
5. Click Save.
All of the available values in the picklist are displayed. Choose the values that you would like USER PERMISSIONS
included in the new business process.
To create or change
Next, add the new business process to a record type, and then make the record type available to business processes:
users based on profile. • Customize Application

Manage Your Translations

If your Salesforce org has multiple languages enabled, manage translations so that your global users
EDITIONS
can use Salesforce in their language.

Note: Standard objects aren’t available in Translation Workbench. Use the rename tabs and Metadata translation
labels interface for standard object translation. available in: Salesforce
Classic (not available in all
orgs) and Lightning
Metadata Translation Experience
When you enable multiple languages in your Salesforce org, Salesforce translates some labels
Data translation available in:
for you, based on the language type. For labels without a default translation, you can localize
Lightning Experience
your apps and custom functionality for any Salesforce supported language through metadata
translation. Available in: Professional,
Enterprise, Performance,
Data Translation
Unlimited, and Developer
When data translation is enabled, the data stored in the Industries Record Alert object and the
Editions
B2B Commerce Product and Product Category objects’ Name and Description fields is available
for translation. You can also enable data translation for custom text and URL fields on those Data translation applies to:
objects. B2B Commerce

Translation Workbench
Use Translation Workbench to maintain translated values for metadata and data labels in your Salesforce org. Specify languages for
translation and assign translators for each language. Manage translated values for any Salesforce supported language. Translators
can maintain translations directly through the workbench, or you can export translation files for bulk translation imports.
Translation Considerations
Review considerations for managing your translations and translating flows.

119
Extend Salesforce with Clicks, Not Code Manage Your Translations

Metadata Translation
When you enable multiple languages in your Salesforce org, Salesforce translates some labels for
EDITIONS
you, based on the language type. For labels without a default translation, you can localize your
apps and custom functionality for any Salesforce supported language through metadata translation. Available in: Salesforce
Salesforce-provided translations vary by language type. Classic (not available in all
orgs) and Lightning
Language Type Translations Provided by Salesforce Experience

Fully supported languages Metadata labels for all standard features, plus Available in: Professional,
Help. Enterprise, Performance,
Unlimited, and Developer
End-user languages Metadata labels for all standard objects and Editions
pages, except admin pages and Setup. No
translations for Help.

Platform-only languages None

In situations where Salesforce doesn’t provide default translations, metadata translation allows you to localize apps and custom functionality
that you build in Salesforce. You can translate items such as custom labels, custom objects, and field names.

Metadata Available for Translation

You can translate metadata labels only for certain Salesforce Setup components.
Flow Components for Metadata Translation
Flow components are the parts of a flow you can translate.

SEE ALSO:
Supported Languages
Translation Workbench

Metadata Available for Translation

You can translate metadata labels only for certain Salesforce Setup components.
EDITIONS
Note: Standard objects aren’t available in Translation Workbench. Use the rename tabs and
labels interface for standard object translation. Available in: Salesforce
Classic (not available in all
To view the translatable metadata labels in your Salesforce organization, first enable Translation orgs) and Lightning
Workbench. Then, from the Translate Setup page, select a Setup component. If needed, select Experience
Object, Custom Report Type Entity, Flow, Flow Type, Flow Component, or Aspect.
Available in: Professional,
You can translate the following components. Enterprise, Performance,
• Action Unlimited, and Developer
• Address Country Editions

• Address State
• Apex Sharing Reason
• App
• Button and Link Label

120
Extend Salesforce with Clicks, Not Code Manage Your Translations

• Chatter Extension
• Custom Field
• Custom Report Type
• Data Category
• Data Category Group
• Division
• Feed Filter
• Field Set
• Flow
• Global Value Set
• Layout Section
• Lookup Filter
• Managed Content Node Type
• Managed Content Type
• Navigation Menu Item (for Experience Cloud sites)
• Path Step Rich Text
• Picklist Value
• Prompt
• Prompt Version
• Record Type
• Reputation Level (for Experience Cloud sites)
• S-Control
• Solution Category
• Stamp
• Standard Field Help
• Validation Error Message
• Web Tab (also includes Lightning component and Visualforce tabs)
• Workflow Task

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.

SEE ALSO:
Supported Languages
Translation Workbench

121
Extend Salesforce with Clicks, Not Code Manage Your Translations

Flow Components for Metadata Translation

Flow components are the parts of a flow you can translate.
EDITIONS
Flow Description Where Translation Appears Available in: Salesforce
Component Classic (not available in all
Definition The flow name The flow interview’s title bar. orgs) and Lightning
Experience
Version The version label of a flow The active flow version label is the flow
Available in: Professional,
definition label by default, so it appears
Enterprise, Performance,
in the flow interview's title bar. When
Unlimited, and Developer
you enter the flow definition and its
Editions
translation manually, the translated
definition label overrides the active flow
version label. When the flow definition
label doesn't have a translation, the
translated version label appears as the
flow interview's title.

Screen Info Aspect includes help text and paused Help text and paused messages for the
messages overall screen.

Screen Field Aspect includes labels, description, help Field-level text on a screen. The
text, and error messages for screen description aspect is the text for screen
components output components.

Choice Aspect includes field labels, help text, Field-level text for choice components.
text input labels

Stage Stage labels Screen components that can reference

stage labels, including Display Text
components and attributes for screen
components that require Lightning
runtime.

Text Template Aspect includes text in a text template All the pages of a survey. Available only
in Salesforce Surveys.

SEE ALSO:
Metadata Translation
Translation Workbench
Considerations for Translating Flows

122
Extend Salesforce with Clicks, Not Code Manage Your Translations

Data Translation
When data translation is enabled, the data stored in the Industries Record Alert object and the B2B
EDITIONS
Commerce Product and Product Category objects’ Name and Description fields is available for
translation. You can also enable data translation for custom text and URL fields on those objects. Available in: Lightning
Note: Data translation requires API version 48.0 or later. Experience

Available in: Enterprise,

Performance, and
Enable Data Translation Developer Editions
Allow translation of data stored in the Industries Record Alert object and within the Name and
Description fields on the Product and Product Category objects.
Enable Data Translation for Custom Fields
Allow translation of data stored in custom fields on the Record Alert, Product, and Product Category objects. You can enable data
translation on custom fields with a type of Text, Text Area, Text Area (Long), Text Area (Rich), and URL.

Enable Data Translation

Allow translation of data stored in the Industries Record Alert object and within the Name and
EDITIONS
Description fields on the Product and Product Category objects.

Note: Before enabling data translation, note these important considerations: Available in: Lightning
Experience
• Data translation requires API version 48.0 or later.
Available in: Enterprise,
• Data translation counts against your Salesforce org’s storage limits.
Performance, and
1. From Setup, in the Quick Find box, enter Company Information, and then select Developer Editions
Company Information.
2. In the Organization Detail section, click Edit. USER PERMISSIONS
3. Select Enable Data Translation. To view company
4. Click Save. information:
• View Setup and
Data translation is now available for the Name and Description fields through the Translation
Configuration
tab within Product. You can also manage your data translations through the Export and Import
options within Translation Workbench. To change company
information:
5. Optional: Enable data translation for custom fields. • Modify All Data

SEE ALSO:
Translation Workbench
Salesforce B2B Commerce and D2C Commerce
Data and File Storage Allocations

123
Extend Salesforce with Clicks, Not Code Manage Your Translations

Enable Data Translation for Custom Fields

Allow translation of data stored in custom fields on the Record Alert, Product, and Product Category
EDITIONS
objects. You can enable data translation on custom fields with a type of Text, Text Area, Text Area
(Long), Text Area (Rich), and URL. Available in: Lightning
Before enabling data translation for custom fields, you must enable data translation. Experience

Note: Data translation requires API version 48.0 or later. Available in: Enterprise,
Performance, and
1. From Setup, in the Quick Find box, enter Data Translation Settings, and then Developer Editions
select Data Translation Settings.
2. Select an object to enable data translation for its custom fields. USER PERMISSIONS
Only objects that support data translation are listed.
To change data translation
3. Select the custom fields that you want to make available for data translation. settings:
Data translation can only be enabled on custom fields with a type of Text, Text Area, Text Area • Customize Application
(Long), Text Area (Rich), and URL. AND
Modify All Data
4. Click Save.
If your B2B Commerce Store supports multiple languages, data translation is now available for the
selected custom fields through the Translation tab within Product and Product Category. You can
also manage your data translations through the Export and Import options within Translation Workbench.

SEE ALSO:
Salesforce B2B Commerce and D2C Commerce
Translation Workbench

Translation Workbench
Use Translation Workbench to maintain translated values for metadata and data labels in your
EDITIONS
Salesforce org. Specify languages for translation and assign translators for each language. Manage
translated values for any Salesforce supported language. Translators can maintain translations Metadata translation
directly through the workbench, or you can export translation files for bulk translation imports. available in: Salesforce
Classic (not available in all
Note: Translation Workbench is only available for multi-language orgs. If you aren’t sure
orgs) and Lightning
whether you have a single-language or multi-language organization, contact Salesforce
Experience
Customer Support.
Data translation available in:
Lightning Experience
Enable or Disable Translation Workbench
Translation Workbench allows you to specify languages for translation, assign translators, and Available in: Professional,
manage your translations through the workbench or bulk translation. Enterprise, Performance,
Unlimited, and Developer
Add Translated Languages and Translators
Editions
Add languages for translation, assign translators for each language, and activate or deactivate
a language’s translations. Data translation applies to:
B2B Commerce
Translate Metadata Labels
Create and update metadata translations for customizations you make to your Salesforce
organization, such as custom picklist values and custom field labels.

124
Extend Salesforce with Clicks, Not Code Manage Your Translations

Override Translations in Second-Generation Managed Packages and Unlocked Packages

You can override metadata translations for custom objects in namespaced unlocked packages and second-generation managed
packages. For example, override the label on a custom field or workflow task.
Export Metadata Translation Files
Create files for your translators that contain your Salesforce org’s translatable metadata. Examples of translatable metadata include
custom field labels, report type names, and picklist values.
Export Data Translation Files
If data translation is enabled in your Salesforce org, you can create files for your translators that contain your org’s data translations.
Examples of translatable data include B2B Commerce Product names and data stored in custom fields.
Work with Translation Files
Translate metadata labels or data translation text, or review existing translations, with XML Localization Interchange File Format (.xlf)
or Salesforce Translation Format (.stf) files.
Import Translated Files
Import and update the translations for your Salesforce org’s metadata, such as custom fields, report types, and picklist values. Or
import and update data translations, such as Product names. Typically, you export translation files from Salesforce, then send them
to outside translators or a translation agency for bulk translation activities. You then import the translated files.
Common Errors with Exporting and Importing Translation Files
Troubleshoot issues you can encounter while exporting and importing files in Translation Workbench.

SEE ALSO:
Supported Languages
Rename Object, Tab, and Field Labels

Enable or Disable Translation Workbench

Translation Workbench allows you to specify languages for translation, assign translators, and
EDITIONS
manage your translations through the workbench or bulk translation.
1. From Setup, in the Quick Find box, enter Translation Language Settings, and Available in: Salesforce
then select Translation Language Settings. Classic (not available in all
orgs) and Lightning
2. On the welcome page, click Enable.
Experience
Enabling Translation Workbench makes these changes to your Salesforce org. If a customized
component doesn’t have a translated value, the component uses the org’s default language. When Available in: Professional,
Enterprise, Performance,
you deactivate a language, all translations for that language are still available in Translation
Unlimited, and Developer
Workbench. However, users with that language selected see the org’s default language values.
Editions
• The Manage Translation systems permission is available in permission sets.
• You must edit picklist values individually. You can’t mass-edit existing picklist values, but you USER PERMISSIONS
can still mass-add new values.
• When picklist values are sorted alphabetically, the values are alphabetical by the org’s default To enable and disable
language. Translation Workbench:
• Customize Application
• Reports have a Filter Language dropdown list in the Filters pane of the report builder. Selecting
a language filters on translated strings for any filter criteria that use the starts with, contains, or
doesn’t contain operator.
• Import files have a Language dropdown list, and all records and values within the import file must be in the selected language.

125
Extend Salesforce with Clicks, Not Code Manage Your Translations

• Web-to-Lead and Web-to-Case have a Language dropdown list before you generate the HTML.
To disable Translation Workbench, from Setup, in the Quick Find box, enter Translation Language Settings, and then
select Translation Language Settings. Click Disable.

Note: In a Developer org with a managed package containing translations, Translation Workbench can’t be disabled after it’s
enabled.

SEE ALSO:
Supported Languages
Language, Locale, and Currency Settings
Rename Object, Tab, and Field Labels

Add Translated Languages and Translators

Add languages for translation, assign translators for each language, and activate or deactivate a
EDITIONS
language’s translations.

Note: The Manage Translation permission is enabled by default in the System Administrator Available in: Salesforce
profile. Classic (not available in all
orgs) and Lightning
Before adding a language for translation, you must select languages for your org and enable Experience
Translation Workbench.
Available in: Professional,
1. From Setup, in the Quick Find box, enter Translation Language Settings, and Enterprise, Performance,
then select Translation Language Settings. Unlimited, and Developer
2. To activate a new language, click Add. Or to change an existing supported language, click Edit. Editions
3. If adding a language, choose a language.
4. To make the entered translations available to your users, select Active. Users can change USER PERMISSIONS
their personal language anytime, regardless of whether it's active in the Translation Workbench. To add or edit languages:
Selecting Active makes the translations available to the users in that language. • Manage Translation
We recommend that you don't make a language active until the translators have translated all To assign translators:
values. • Manage Translation
Note: If you installed a managed package that includes translations, those translated
values appear to users regardless of whether the language is active on the Translation
Language Settings Setup page. To override metadata translations delivered by a managed
package for custom objects, see Override Translations in Second-Generation Managed
Packages and Unlocked Packages.

5. To assign translators for this language, select them from the Available List, and click Add. If you don't see the member that
you want to add, enter keywords in the search box, and click Find.

Important: Ensure that all translators have the View Setup and Configuration permission so that they can begin translating.
Users can only translate languages that they're assigned to.

126
Extend Salesforce with Clicks, Not Code Manage Your Translations

6. Save your changes.

SEE ALSO:
Select Languages for Your Org
Enable or Disable Translation Workbench
Override Translations in Second-Generation Managed Packages and Unlocked Packages

Translate Metadata Labels

Create and update metadata translations for customizations you make to your Salesforce
EDITIONS
organization, such as custom picklist values and custom field labels.

Note: Entering translations through Translation Workbench has limitations, so note the Available in: Salesforce
following. Classic (not available in all
orgs) and Lightning
• Use the rename tabs and labels interface for standard object translation. Standard objects Experience
and custom object names aren’t available in Translation Workbench.
Available in: Professional,
• Manage data translations through the Translation tab within Product or through the
Enterprise, Performance,
Export and Import options in Translation Workbench. Only metadata translations are
Unlimited, and Developer
available for translation via the Translate Setup page. Editions
Before translating metadata labels, you must select languages for your org, enable Translation
Workbench, and add translated languages and translators. USER PERMISSIONS
1. From Setup, in the Quick Find box, enter Translate, and then select Translate.
To translate terms:
2. Select the Language you're translating into. • View Setup and
3. Select a Setup Component. See Metadata Available for Translation for a list of translatable Configuration
components. AND

4. Depending on the setup component, select the next options. Be designated as a

translator
The aspect is a part of the setup component that you can translate. For example:For global
value sets and picklist values, you can translate inactive values by selecting Show Inactive
Values.
• Workflow tasks have an object (for example, Account or Contact) and aspect (Subject or Comment).
• Custom Report Types have a custom report type entity (Custom Report Type, Custom Report Type Column, or Custom Report
Type Layout Section) and aspect (field label or description).
• Flows have a flow type (Flow and Autolaunched Flow), a flow name, and a flow component (Definition, Version, Screen Info,
Screen Field, and Choice). Flow components can have a flow version, screen, or aspect.

5. To enter new values, double-click in the translation column. You can press Tab to advance to the next editable field or Shift+Tab to
go to the previous editable field.

Note: The Out of Date column indicates the possibility that the label needs translating because the primary label has
been updated. When editing a button or link label, you see the Button or Link Name column, which is used to refer
to the component when using SOAP API.

6. Click Save.

127
Extend Salesforce with Clicks, Not Code Manage Your Translations

If a customized component doesn’t have a translated value, the component uses the org’s default language. When you deactivate a
language, all translations for that language are still available in Translation Workbench. However, users with that language selected see
the org’s default language values.

SEE ALSO:
Select Languages for Your Org
Translation Workbench
Rename Object, Tab, and Field Labels
Metadata Available for Translation

Override Translations in Second-Generation Managed Packages and Unlocked Packages

You can override metadata translations for custom objects in namespaced unlocked packages and
EDITIONS
second-generation managed packages. For example, override the label on a custom field or workflow
task. Available in: Salesforce
Note: Overriding translations in second-generation managed packages and unlocked Classic (not available in all
orgs) and Lightning
packages has limitations:
Experience
• You can’t override translations for standard objects in packages.
Available in: Professional,
• You can’t override translations for global picklist value sets.
Enterprise, Performance,
• You can’t override data translations. Unlimited, and Developer
Editions
If you installed a managed package that includes translations, those translated values appear to
users regardless of whether the language is active on the Translation Language Settings Setup
page. Before you can override those translations, you must select languages for your org and enable USER PERMISSIONS
Translation Workbench.
To override metadata
1. From Setup, in the Quick Find box, enter Override, and then select Override. translations:
2. Select the Package that you’re overriding. • View Setup and
Configuration
3. Select the Language that you're entering your overrides in.
AND
Note: The Language list shows the languages that meet these criteria: Customize Application
• The language is in the package that’s associated with this namespace.
• There is at least one translation for the language, or it’s the package default language.

4. Select a Setup Component. See Metadata Available for Translation for a list of translatable components.
5. Depending on the setup component, select the next options.
The aspect is a part of the setup component that you can translate. For example:For global value sets and picklist values, you can
translate inactive values by selecting Show Inactive Values.
• Workflow tasks have an object (for example, Account or Contact) and aspect (Subject or Comment).
• Custom Report Types have a custom report type entity (Custom Report Type, Custom Report Type Column, or Custom Report
Type Layout Section) and aspect (field label or description).
• Flows have a flow type (Flow and Autolaunched Flow), a flow name, and a flow component (Definition, Version, Screen Info,
Screen Field, and Choice). Flow components can have a flow version, screen, or aspect.

128
Extend Salesforce with Clicks, Not Code Manage Your Translations

6. To enter new values, double-click in the translation column. You can press TAB to advance to the next editable field or SHIFT-TAB
to go to the previous editable field.

Note: The Out of Date column indicates the possibility that the term needs translation because the primary label has
been updated. When editing a button or link label, you see the Button or Link Name column, which is used to refer
to the component when using SOAP API.

7. Click Save.

SEE ALSO:
Select Languages for Your Org
Enable or Disable Translation Workbench
Metadata Available for Translation

Export Metadata Translation Files

Create files for your translators that contain your Salesforce org’s translatable metadata. Examples
EDITIONS
of translatable metadata include custom field labels, report type names, and picklist values.

Note: You need the Manage Translation AND Create Documents user permissions to import Available in: Salesforce
or export translation files. If you attempt either operation without both user permissions, it’s Classic (not available in all
orgs) and Lightning
possible to navigate to the import or export page, but the operation itself fails.
Experience
Before you can export metadata translation files, you must enable Translation Workbench.
Available in: Professional,
Tip: When exporting metadata translation files, individual uncompressed files are limited to Enterprise, Performance,
5 MB each. If your org’s metadata translations exceed 5 MB, the system exports multiple files. Unlimited, and Developer
If multiple .zip files are required, each file name is date-stamped and incremented. For example, Editions
Outdated and untranslated 2020–09–20 05:13_part 1 of 2.zip.
1. From Setup, in the Quick Find box, enter Export, and then select Export. USER PERMISSIONS
2. If data translation is enabled in your org, select the Metadata Translation Type.
To export or import
3. Select which labels you want to export. translation files
• Manage Translation
• Source–Used as the initial source for creating translations.
AND
Creates a single file that contains a list of all your translatable customizations.
Create Documents
• Outdated and untranslated–Used to make updates.
Creates a set of files that contain only metadata labels that haven’t been translated, including
new and modified labels.
One file is created for each language. These files are then compressed into .zip files.

• Bilingual–Used for reference and reviewing all your untranslated and translated customizations.
Creates a list of all the translatable metadata labels in their current translated or untranslated state.
One file is created for each language. These files are then compressed into .zip files.
The content in each file is divided into Untranslated and Translated sections. Each translatable label is in the Untranslated or the
Translated section, according to its translation state. The Translated section includes the out-of-date status for each label.

Note: Exported translation file content is in your org's default language.

129
Extend Salesforce with Clicks, Not Code Manage Your Translations

4. Select a format. Salesforce recommends the XML Localization Interchange File Format (XLIFF) because it contains more information
than the .stf format, like the field width.
5. Click Export.
A status message tells you that the export is being processed. Wait for it to finish before submitting another export request. When
the export is complete, an email is sent to the email address specified in your profile.

6. Locate the exported .stf, .xlf, or .zip file.

Go to Your name > Documents > Document Folders > My Personal Documents > Go!.
All exported files indicate the Export option used to create them and are date and time stamped. Individual files end with the .stf or
.xlf extension. Multiple files are grouped into .zip files.
If you have many documents in your personal documents area, find the exported files under the sort letter:
• B—Bilingual export option, for example: Bilingual_2020-01-23_11:20.zip.
• S—Source export option, for example: Source_en_US_2020-01-23_11:20.stf.
• O—Outdated and untranslated export option, for example:
Outdated_and_untranslated_2020-01-23_11:20.zip.

7. Save the files for translation by your translators or translation agency.

Click View > Save File > OK. The file is saved to the location specified by your browser. For example,
C:/Users/username/Downloads.

8. Send the files to your outside translators or translation agency for bulk translation activities, then use Import to update your labels.

SEE ALSO:
Translation Workbench
Salesforce Developer Doc: Translations

Export Data Translation Files

If data translation is enabled in your Salesforce org, you can create files for your translators that
USER PERMISSIONS
contain your org’s data translations. Examples of translatable data include B2B Commerce Product
names and data stored in custom fields. To export or import
translation files
Available in: Lightning Experience • Manage Translation
AND
Available in: Enterprise, Performance, and Developer Editions
Create Documents

Note: You need the Manage Translation AND Create Documents user permissions to import
or export translation files. If you attempt either operation without both user permissions, it’s
possible to navigate to the import or export page, but the operation itself fails.
Before you can export data translation files, you must enable Translation Workbench and data translation.

Important: Each data translation export request is limited to 1 GB of data and 100,000 records. If your requested export exceeds
either of those limits, only a partial file is exported. To reduce the amount of data exported, use the language filter, available for
the Outdated and translated and Bilingual export types. If your org’s data translations for a single object and language exceed
either of those limits, use BULK API.

130
Extend Salesforce with Clicks, Not Code Manage Your Translations

1. From Setup, in the Quick Find box, enter Export, and then select Export.
2. Select Data as the Translation Type.
3. Select the objects for data translation.
4. Select which labels you want to export.
• Source–Used as the initial source for creating translations.
Creates a set of files by object with all translatable text.

• Outdated and untranslated–Used to make updates.

Creates a set of files, by language and then by object, including text changed after the last translation and text that isn’t yet
translated. These files are then compressed into .zip files.

• Bilingual–Used for reference and reviewing all your untranslated and translated customizations.
Creates a set of files, by language and then by object, including all the translatable text in its current translated or untranslated
state. These files are then compressed into .zip files.
The content in each file is divided into Untranslated and Translated sections. Each translatable text element is in the Untranslated
or the Translated section, according to its translation state. The Translated section includes the out-of-date status for each text
element.

5. If you selected the Outdated and untranslated or Bilingual export type, select at least one language.
6. Select a file format. Salesforce recommends the XML Localization Interchange File Format (XLIFF) because it contains more information
than the .stf format, like the field width.
7. Click Export.
A status message tells you that the export is being processed. Wait for it to finish before submitting another export request. When
the export is complete, an email is sent to the email address specified in your profile. The email includes a link to a .zip file with your
exported translation files.

Note: When exporting data translation files, individual uncompressed files are limited to 25 MB. If multiple files are required,
each file name is date stamped and incremented. For example, Bilingual_de_Product2_2020-10-20
0836_1.xlf and Bilingual_de_Product2_2020-10-20 0836_2.xlf.

8. Send the files to your outside translators or translation agency for bulk translation activities, then use Import to update your data
translations.

SEE ALSO:
Enable Data Translation
Translation Workbench
Salesforce Developer Doc: Translations

131
Extend Salesforce with Clicks, Not Code Manage Your Translations

Work with Translation Files

Translate metadata labels or data translation text, or review existing translations, with XML
EDITIONS
Localization Interchange File Format (.xlf) or Salesforce Translation Format (.stf) files.
Translation files can contain metadata translations or data translations. Metadata translations are Metadata translation
for customizations that you made to your Salesforce organization, such as custom picklist values available in: Salesforce
and custom field labels. Data translations are for the data stored within fields, such as the text in Classic (not available in all
the Product object’s Name and Description fields. orgs) and Lightning
Experience
For metadata and data translation files, there are three file types.
Data translation available in:
• Source: Use to translate labels for the first time.
Lightning Experience
• Outdated and untranslated: Use to translate labels after the first translation pass.
Available in: Professional,
• Bilingual: Use to review and edit translations.
Enterprise, Performance,
Translation files are identified with either the .xlf or .stf extension. Salesforce recommends the XML Unlimited, and Developer
Localization Interchange File Format (.xlf) for translation files. Editions

Data translation applies to:

Considerations for Working with Translation Files B2B Commerce
Review some important considerations to ensure that your edited translation file can be
successfully imported.
Source Translation Files
Use the Source file to translate an organization's labels or data for the first time. The Source file contains labels for all of a Salesforce
org's translatable metadata or data in the org's default language.
Outdated and Untranslated Translation Files
Use the Outdated and untranslated file to translate labels or data that need translation. The file includes labels or data changed since
the last translation and labels that haven't been translated. One Outdated and untranslated file is generated for each language.
When multiple files are generated, they're exported to a .zip file containing a file for each translation language.
Bilingual Translation Files
Use the Bilingual file to review translations, edit existing translations, and add translations for labels or data that haven't been
translated. One Bilingual file is generated for each translation language.
Translation File IDs and Keys
Each translatable item has a unique identifier in the translation file. In .xlf files, it’s the id within a trans-unit tag. In .stf files, it’s the
key. The structure of these identifiers differs for metadata and data translation files.
Flow Identifiers in Translation Files
In a translation file exported from Translation Workbench, a unique key or trans-unit ID attribute identifies a flow metadata label.

SEE ALSO:
Export Metadata Translation Files
Export Data Translation Files
Import Translated Files

132
Extend Salesforce with Clicks, Not Code Manage Your Translations

Considerations for Working with Translation Files

Review some important considerations to ensure that your edited translation file can be successfully
EDITIONS
imported.
Metadata translation
General Considerations available in: Salesforce
Classic (not available in all
• Translation files are identified with the .stf or .xlf extension. Don't change the file extension. orgs) and Lightning
• Salesforce recommends the XML Localization Interchange File Format (.xlf) for translation files. Experience
• All translation files are language-specific. Data translation available in:
• A translation file name includes the name of the export option used to create it, the language Lightning Experience
code for the file's content, and a date stamp. Data translation file names also include the name
Available in: Professional,
of the object.
Enterprise, Performance,
• Deleting a translation value, row, or trans-unit tag in the file doesn't remove the translation Unlimited, and Developer
after the file is imported. To delete a translation, replace the translated text with <> in an .stf Editions
file or &lt;&gt; in an .xlf file. When the file is imported, the label reverts to its primary label
value. See Outdated and Untranslated Translation Files and Bilingual Translation Files in Salesforce Data translation applies to:
B2B Commerce
Help for examples.

Note: See the following Data Translation File Considerations for important notes about
deleting the data translation for a record’s Name field.

Exported Translation File Limits

• When exporting metadata translation files, individual uncompressed files are limited to 5 MB each. If your org’s metadata translations
exceed 5 MB, the system exports multiple files. If multiple .zip files are required, each file name is date-stamped and incremented.
For example, Outdated and untranslated 2020–09–20 05:13_part 1 of 2.zip.
• Each data translation export request is limited to 1 GB of data and 100,000 records. If your requested export exceeds either of those
limits, only a partial file is exported. To reduce the amount of data exported, use the language filter, available for the Outdated and
translated and Bilingual export types. If your org’s data translations for a single object and language exceed either of those limits,
use BULK API.
• When exporting data translation files, individual uncompressed files are limited to 25 MB. If multiple files are required, each file name
is date stamped and incremented. For example, Bilingual_de_Product2_2020-10-20 0836_1.xlf and
Bilingual_de_Product2_2020-10-20 0836_2.xlf.

Translation File Import Limits

• When importing metadata translation files, individual uncompressed files are limited to 10 MB each.
• If data translation isn’t enabled in your org, each imported .zip file is limited to 10 MB. If data translation is enabled, each imported
.zip file is limited to 1 GB.
• When importing data translation files, individual uncompressed files are limited to 50 MB each.
• When zipping data translation files for import, each .zip file can contain up to 100,000 total translation records within up to 2 GB of
uncompressed files.

Data Translation File Considerations

A translated value for the data in the record’s Name field is required to translate data in other fields for that record. For example, you
must provide a German translation for the name of a Product before you can translate its description into German.

133
Extend Salesforce with Clicks, Not Code Manage Your Translations

When translating text in a rich text area field, don’t delete HTML tags such as <p></p> and <b></b>. If you remove those tags, the
returned value of toLabel(rich_text_area_field) in SOQL queries can be truncated to 255 characters.
There are two ways to delete the translated values for all fields related to a record. Because translation files are language-specific, this
action is per language.

Note: You can restore deleted data translation values through the recycle bin.

• Delete translated text for all of the record’s fields. For example, a Product has German translated values for its name and description.
To remove all German data translations for that Product, replace the translated text for that Product record’s Name and Description
fields with <> in an .stf file or &lt;&gt; in an .xlf file.
• Delete the translated text for the record’s Name field, and remove the rows or trans-unit tags for the record’s other fields. For
example, a Product has German translated values for its name and description. To remove all German data translations for that
Product, replace the translated text for that Product record’s Name fields with <> in an .stf file or &lt;&gt; in an .xlf file. Also
delete the row or trans-unit tag for that Product’s Description field.
If an imported translation file deletes the translated value for a record’s Name and includes a translated value for another field, no action
is taken. For instance, you delete the translated value for a Product’s name but leave the translation key for that Product’s description
unchanged in a translation file for German. When you import that translation file, no changes are made to that Product’s translated
values for German.

XML Localization Interchange File Format (.xlf) File Considerations

The .xlf format is the recommended export type because it contains more information than the .stf format, like the field width.
• .xlf translation file content is organized into translation units. Translation units for translated labels contain a target tag with the
translated value. Untranslated labels have a source tag, but no target tag.
• Translators must create a target tag for each untranslated label to store the translated value. Otherwise, don't add tags to or
remove tags from the .xlf file.
• The file tag’s attributes define details about the translation file , such as the source language, target language, and the translation
type.
• The trans-unit tags’ attributes define details about the translation unit, such as the id and the field width.

Salesforce Translation Format (.stf) File Considerations

The .stf format behaves like a .csv file, with content organized into tab-delimited columns.
• If you don’t use a standard translation tool such as Trados, edit the file using an application that supports tabs and word wrap, such
as WordPad.
• Don't add columns to or remove columns from the translation file.
• If you use tabs, new lines, or carriage returns in your text for translation, they are represented with special characters in the .stf file
format. Tabs are \t, new lines are \n, and carriage returns are \r. To ensure consistency between your language versions, ensure
that these characters are maintained in your translations.
• If you use Microsoft Excel to enter translations in an .stf file, your file format can be corrupted. MS Excel automatically adds quotation
marks around entries that have commas. We recommend that you open your files in a text editor before importing them and remove
these quotation marks. The import fails if these quotation marks aren’t removed.

Translating Rich Text Fields

Fields with a type of Text Area (Rich) allow special formatting, such as bolding text or adding an image. When rich text fields are exported
for translation, the translatable text for those fields includes encoded HTML tags.

134
Extend Salesforce with Clicks, Not Code Manage Your Translations

If your translators edit raw translation files, make sure that they understand HTML tags and their encoding. When translating the text,
HTML tags aren’t required. However, if HTML tags are included in a translated value, they must be valid and in the same format as the
exported tags. If the tags are incorrect, the translation import fails.

Note: The HTML tags are visible in the raw files. Many translation tools handle the conversion of markup languages like HTML for
you.
All rich text field translations must be contained within an HTML paragraph (<p>) tag with the appropriate HTML encoding for that file
type. If the translation value contains only plain text, the required paragraph tag is added upon import.
This table provides examples of exported rich text field content.

Rich Text Field Content Format Exported Text

Available in women’s shoe sizes .stf <p>Available in women’s shoe sizes 5-13.</p>
5–13.
.xlf &lt;p&gt;Available in women’s shoe sizes 5-13.&lt;/p&gt;

15% discount available for .stf <p>15% discount available for veterans.
veterans. </p><p><b>Verification required.</b></p>
Verification required. .xlf &lt;p&gt;15% discount available for veterans.
&lt;/p&gt;&lt;p&gt;&lt;b&gt;Verification
required.&lt;/b&gt;&lt;/p&gt;

Features: .stf <p>Features:<ul><li>Leather</li><li>LImported</li><li>Rubber

• Leather sole</li><li>Lightweight</li><li>Flexible
sole</li></ul></p>
• Imported
• Rubber sole .xlf &lt;p&gt;Features: &lt;ul&gt;&lt;li&gtLeather
&lt;/li&gt&lt;li&gtImported &lt;/li&gt&lt;li&gtRubber
• Lightweight
sole &lt;/li&gt&lt;li&gtLightweight
• Flexible sole &lt;/li&gt&lt;li&gtFlexible sole
&lt;/li&gt&lt;/ul&gt;&lt;/p&gt;

See more information at this .stf <p>See more information at <a

reference site. href=”https://www.example.com”>this reference
site</a>.</p>

.xlf &lt;p&gt;&lt;a
href=&quot;https://www.example.com&quot;&gt;this
reference site&lt;/a&gt;.&lt;/p&gt;

SEE ALSO:
Export Metadata Translation Files
Export Data Translation Files
Import Translated Files
View, Restore, and Manage the Recycle Bin in Salesforce Classic

135
Extend Salesforce with Clicks, Not Code Manage Your Translations

Source Translation Files

Use the Source file to translate an organization's labels or data for the first time. The Source file
EDITIONS
contains labels for all of a Salesforce org's translatable metadata or data in the org's default language.

Note: Salesforce recommends the XML Localization Interchange File Format (.xlf) for Metadata translation
translation files. See Considerations for Working with Translation Files for tips on editing available in: Salesforce
Classic (not available in all
translation files and how to translate rich text field content.
orgs) and Lightning
To prepare the translation file for your translators: Experience
• Create one copy of the Source file for each language you’re translating into. Data translation available in:
• In the header of each Source file, change the language code from the organization's default Lightning Experience
language to the translation language. For example, replace en_US for English (US) with es
Available in: Professional,
for Spanish.
Enterprise, Performance,
Unlimited, and Developer
XML Localization Interchange File Format (.xlf) Source Translation Files Editions
Source .xlf translation file content is organized into translation units. Translation units for translated Data translation applies to:
labels contain a target tag with the translated value. Untranslated labels have a source tag, B2B Commerce
but no target tag.
Tell your translators:
• After each source tag, add a target tag that contains the translated value.
• If a target tag exists and the translation is out of date, replace the text in the target tag. Outdated labels have a value of
outOfDate="true" within the trans-unit tag.
• When translating text in a rich text area field, include all HTML tags such as <p></p> and <b></b>.

Important: A translated value for the data in the record’s Name field is required to translate data in other fields for that record.
For example, you must provide a German translation for the name of a Product before you can translate its description into German.

Tag Description Edit Options

trans-unit Translation unit. Contains unique identifiers Do not edit.
for the label, including the label’s id,
maximum width, and out-of-date indicator.

source Label or text in the org’s default language. Do not edit.

target The current translation that is visible to end Enter the translated value. Add a target tag
users selecting the target language as their if needed.
personal language.

note Description of the metadata label, if defined, Do not edit. Translatable field descriptions
in the source language. each have a separate trans-unit tag.

For example, if you build a custom Nickname field on the Account object, the original file contains the following trans-unit tag
in the exported Source .xlf file.
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char">
<source>Nickname</source>
<note>The person’s nickname, or what they prefer to be called.</note>
</trans-unit>

136
Extend Salesforce with Clicks, Not Code Manage Your Translations

To translate this label, add a target tag containing the translated value to the corresponding trans-unit tag after the source
tag.
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char">
<source>Nickname</source>
<target>Apodo</target>
<note>The person’s nickname, or what they prefer to be called.</note>
</trans-unit>

Salesforce Translation Format (.stf) Source Translation Files

Note: Salesforce doesn’t recommend the STF format for translation files. If you choose to use this format, we don’t recommend
editing the file with Microsoft Excel. For more information and restrictions, see Considerations for Working with Translation Files.
Tell your translators to replace the untranslated values in the LABEL column with translated values.

Important: A translated value for the data in the record’s Name field is required to translate data in other fields for that record.
For example, you must provide a German translation for the name of a Product before you can translate its description into German.

Column Description Edit Options

KEY Unique identifier for the label. Do not edit.

LABEL Label or text in the org’s default language. Replace untranslated values with translated
values.

For example, if you build a custom Nickname field on the Account object, the original file contains the following row in the exported
Source .stf file.

# KEY LABEL

CustomField.Account.Nickname.FieldLabel Nickname

To translate this label, replace the LABEL text in that row with the translated value.

# KEY LABEL

CustomField.Account.Nickname.FieldLabel Apodo

Important: Don't add columns to or remove columns from the .stf translation file.

SEE ALSO:
Considerations for Working with Translation Files
Supported Languages

137
Extend Salesforce with Clicks, Not Code Manage Your Translations

Outdated and Untranslated Translation Files

Use the Outdated and untranslated file to translate labels or data that need translation. The file
EDITIONS
includes labels or data changed since the last translation and labels that haven't been translated.
One Outdated and untranslated file is generated for each language. When multiple files are Metadata translation
generated, they're exported to a .zip file containing a file for each translation language. available in: Salesforce
Classic (not available in all
Note: Salesforce recommends the XML Localization Interchange File Format (.xlf) for
orgs) and Lightning
translation files. See Considerations for Working with Translation Files for tips on editing
Experience
translation files and how to translate rich text field content.
When working with the Outdated and untranslated translation file, each entry needs a new translated Data translation available in:
value. Special values are used to delete an existing translation and revert the label to its original Lightning Experience
value. Available in: Professional,
Enterprise, Performance,
Unlimited, and Developer
XML Localization Interchange File Format (.xlf) Outdated and Untranslated Translation
Editions
Files
Data translation applies to:
Outdated and untranslated .xlf translation file content is organized into translation units. Translation
B2B Commerce
units for translated labels contain a target tag with the translated value. Untranslated labels
have a source tag, but no target tag.
Tell your translators:
• For untranslated labels, add a target tag containing the translated value after each source tag.
• If the label’s translation is out of date, replace the text in the target tag. Outdated labels have a value of outOfDate="true"
within the trans-unit tag. Don’t update the outOfDate value.
• To delete a translation, replace the value in the label's target tag with &lt;&gt;. When the Bilingual file is imported, the label
reverts to its original value.
• A translated value for the data in the record’s Name field is required to translate data in other fields for that record. For example, you
must provide a German translation for the name of a Product before you can translate its description into German.
• Deleting the data translated value for a record’s Name field can delete all of that record’s other translated values for that language.
See Considerations for Working with Translation Files for more information.
• When translating text in a rich text area field, don’t delete HTML tags such as <p></p> and <b></b>. If you remove those tags,
the translated text can be truncated.

Tag Description Edit Options

trans-unit Translation unit. Contains unique identifiers Do not edit.
for the label, including the label’s id,
maximum width, and out-of-date indicator.

source Label or text in the org’s default language. Do not edit.

target The current translation that is visible to end Enter the translated value. Add a target tag
users selecting the target language as their if needed.
personal language.

note Description of the metadata label, if defined, Do not edit. Translatable field descriptions
in the source language. each have a separate trans-unit tag.

138
Extend Salesforce with Clicks, Not Code Manage Your Translations

For example, an existing Nickname field on the Account object has a Spanish translated value of “Apodo.” You change the primary label
on the Nickname field from “Nickname” to “Preferred Name.” That label is now outdated. You also build a new custom Business Hours
field on the Account object. The exported Outdated and untranslated .xlf translation file contains the following trans-unit tags.
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="true">
<source>Preferred Name</source>
<target>Apodo</target>
<note>The name preferred by this person.</note>
</trans-unit>
<trans-unit id="CustomField.Account.Business_Hours.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="false">
<source>Business Hours</source>
</trans-unit>

To update the outdated label, update the text in the corresponding target tag. To translate the new field’s label, add a target
tag containing the translated value to the corresponding trans-unit tag after the source tag. Don’t change the outOfDate
tag values. When you import the translated file, labels with updated translations are marked as up to date.
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="true">
<source>Preferred Name</source>
<target>Nombre preferido</target>
<note>The name preferred by this person.</note>
</trans-unit>
<trans-unit id="CustomField.Account.Business_Hours.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="false">
<source>Business Hours</source>
<target>Horario de oficina</target>
</trans-unit>

To delete the Preferred Name label’s translation, update the translation value in the target tag with &lt;&gt;. When the file is imported,
the label reverts to its original value.
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="true">
<source>Preferred Name</source>
<target>&lt;&gt;</target>
<note>The name preferred by this person.</note>
</trans-unit>

Salesforce Translation Format (.stf) Outdated and Untranslated Translation Files

Note: Salesforce doesn’t recommend the STF format for translation files. If you choose to use this format, we don’t recommend
editing the file with Microsoft Excel. For more information and restrictions, see Considerations for Working with Translation Files.
Tell your translators to replace the values in the LABEL column with updated translated values.
• To delete a translation, replace the desired value in the TRANSLATION column with a left and right angle bracket pair (<>). When
the file is imported, the label reverts to its original value.
• A translated value for the data in the record’s Name field is required to translate data in other fields for that record. For example, you
must provide a German translation for the name of a Product before you can translate its description into German.
• Deleting the data translated value for a record’s Name field can delete all of that record’s other translated values for that language.
See Considerations for Working with Translation Files for more information.

139
Extend Salesforce with Clicks, Not Code Manage Your Translations

Column Description Edit Options

KEY Unique identifier for the label. Do not edit.

LABEL Label or text in the org’s default language. Replace untranslated values with translated
values.

For example, an existing custom Nickname field on the Account object has a Spanish translated value of “Apodo.” You change the
primary label on the Nickname field from “Nickname” to “Preferred Name.” That label is now outdated. You also build a new custom
Business Hours field on the Account object. The exported Outdated and untranslated .stf translation file contains the following rows.

# KEY LABEL

CustomField.Account.Nickname.FieldLabel Preferred Name

CustomField.Account.Business_Hours.FieldLabel Business Hours

To translate the new field’s label and update the existing label, replace the LABEL text in each row.

# KEY LABEL

CustomField.Account.Nickname.FieldLabel Nombre preferido

CustomField.Account.Business_Hours.FieldLabel Horario de oficina

To delete the Nickname field’s outdated translation of “Apodo,” replace the translation value in the LABEL column with <>. When the
file is imported, the label reverts to its primary label value of “Preferred Name.”

# KEY LABEL

CustomField.Account.Nickname.FieldLabel <>

SEE ALSO:
Considerations for Working with Translation Files

140
Extend Salesforce with Clicks, Not Code Manage Your Translations

Bilingual Translation Files

Use the Bilingual file to review translations, edit existing translations, and add translations for labels
EDITIONS
or data that haven't been translated. One Bilingual file is generated for each translation language.

Note: Salesforce recommends the XML Localization Interchange File Format (.xlf) for Metadata translation
translation files. See Considerations for Working with Translation Files for tips on editing available in: Salesforce
Classic (not available in all
translation files and how to translate rich text field content.
orgs) and Lightning
Experience
XML Localization Interchange File Format (.xlf) Bilingual Translation Files
Data translation available in:
Bilingual .xlf translation file content is organized into translation units. Translation units for translated Lightning Experience
labels contain a target tag with the translated value. Untranslated labels have a source tag,
but no target tag. Available in: Professional,
Enterprise, Performance,
Tell your translators: Unlimited, and Developer
• For untranslated labels, add a target tag containing the translated value after the source Editions
tag. Data translation applies to:
• If the label’s translation is out of date, replace the text in the target tag. Outdated labels B2B Commerce
have a value of outOfDate="true" within the trans-unit tag.
• To delete a translation, replace the value in the trans-unit's target tag with
&lt;&gt;. When the Bilingual file is imported, the label reverts to its primary label value.
• A translated value for the data in the record’s Name field is required to translate data in other fields for that record. For example, you
must provide a German translation for the name of a Product before you can translate its description into German.
• Deleting the data translated value for a record’s Name field can delete all of that record’s other translated values for that language.
See Considerations for Working with Translation Files for more information.
• When translating text in a rich text area field, don’t delete HTML tags such as <p></p> and <b></b>. If you remove those tags,
the translated text can be truncated.

Tag Description Edit Options

trans-unit Translation unit. Contains unique identifiers Do not edit.
for the label, including the label’s id,
maximum width, and out-of-date indicator.

source Label or text in the org’s default language. Do not edit.

target The current translation that is visible to end Enter the translated value. Add a target tag
users selecting the target language as their if needed. Replace a value with &lt;&gt;
personal language. to delete the translation.

note Description of the metadata label, if defined, Do not edit. Translatable field descriptions
in the source language. each have a separate trans-unit tag.

For example, in an org with English as its default language, you build a new custom Business Hours field on the Account object. This
label is untranslated.
Nickname, an existing custom field on the Account object, has a Spanish translated value of “Apodo.” You change the primary label on
the Nickname field from “Nickname” to “Preferred Name.” This label is outdated.

141
Extend Salesforce with Clicks, Not Code Manage Your Translations

Another existing custom Prior Reference Number field on the Account object has an incorrect Spanish translated value of “Número de
consulta previa.” Although the translation isn’t out of date, it must be updated to “Número de referencia precedente.”
The Name field on a custom Widget object had a primary label of “SLK.” A translator misinterpreted this acronym and entered a Spanish
translation of “Flojo.” Although the translation isn’t out of date, you want to revert the translation to the primary label.
Finally, a custom Number field on a custom Widget object had a primary label of “Number” and a Spanish translated value of “Número.”
You update the primary label to “#” and want to remove the translated value.
The exported Bilingual .xlf translation file contains the following row in the OUTDATED AND UNTRANSLATED section.
<trans-unit id="CustomField.Account.Business_Hours.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="false">
<source>Business Hours</source>
</trans-unit>
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="true">
<source>Preferred Name</source>
<target>Apodo</target>
<note>The name preferred by this person.</note>
</trans-unit>
<trans-unit id="CustomField.Account.Prior_Ref_No.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="false">
<source>Prior Reference Number</source>
<target>Número de consulta previa</target>
</trans-unit>
<trans-unit id="CustomField.Widget__c.Name.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="false">
<source>SLK</source>
<target>Seda</target>
</trans-unit>
<trans-unit id="CustomField.Widget__c.Number.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="true">
<source>#</source>
<target>Número</target>
</trans-unit>

To make the requested changes:

• Add a target tag with the translated value to the new Business Hours field.
• Update the translation values in the target tags for the Preferred Name and Prior Reference Number fields.
• To delete the translation of the Widget object’s Name and Number fields, update the translation values in those target tags with
&lt;&gt;. When this file is imported, those labels revert to the primary label values.
• Don’t change the outOfDate tag values. When you import the translated file, labels with updated translations are marked as up
to date.
<trans-unit id="CustomField.Account.Business_Hours.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="false">
<source>Business Hours</source>
<target>Horario de oficina</target>
</trans-unit>
<trans-unit id="CustomField.Account.Nickname.FieldLabel" maxwidth="40" size-unit="char"
outOfDate="true">
<source>Preferred Name</source>
<target>Nombre preferido</target>
<note>The name preferred by this person.</note>

142
Extend Salesforce with Clicks, Not Code Manage Your Translations

</trans-unit>
<trans-unit id="CustomField.Account.Prior_Ref_No.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="false">
<source>Prior Reference Number</source>
<target>Número de referencia precedente</target>
</trans-unit>
<trans-unit id="CustomField.Widget__c.Name.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="false">
<source>SLK</source>
<target>&lt;&gt;</target>
</trans-unit>
<trans-unit id="CustomField.Widget__c.Number.FieldLabel" maxwidth="20" size-unit="char"
outOfDate="true">
<source>#</source>
<target>&lt;&gt;</target>
</trans-unit>

Salesforce Translation Format (.stf) Bilingual Translation Files

Note: Salesforce doesn’t recommend the STF format for translation files. If you choose to use this format, we don’t recommend
editing the file with Microsoft Excel. For more information and restrictions, see Considerations for Working with Translation Files.
Bilingual .stf translation file content is separated into translated labels and outdated or untranslated labels.
The TRANSLATED section of the .stf file contains text that has been translated and is up to date. When importing, four columns are
expected for each label in this section: KEY, LABEL, TRANSLATION, and OUT OF DATE.
For this section, tell your translators:
• To update a current translation, replace the value in the TRANSLATION column.
• To delete a translation, replace the value in the TRANSLATION column with a left and right angle bracket pair (<>). When the file is
imported, the label reverts to its primary label’s value.

Column Description Edit Options

KEY Unique identifier for the label. Do not edit.

LABEL Label or text in the org’s default language. Do not edit.

TRANSLATION The current translation that is visible to end • To edit a translation, replace the
users selecting the target language as their translated value.
personal language.
• To delete a translation, replace the
translated value with <>.

OUT OF DATE Indicates whether the source text has Do not edit.
changed since the previous translation.
A dash (-) indicates that the translation is
current.

The OUTDATED AND UNTRANSLATED section of the file contains labels changed after the label’s translation value was last updated and
text that hasn't been translated. When importing, two columns are expected for each label in this section: KEY and LABEL.

143
Extend Salesforce with Clicks, Not Code Manage Your Translations

For this section, tell your translators:

• Replace the text in the LABEL column with new or updated translation values.
• Delete any values in the TRANSLATED and OUT OF DATE columns.
• Delete the corresponding columns in the OUTDATED AND UNTRANSLATED section.
• To delete an outdated translation, replace the value in the LABEL column with a left and right angle bracket pair (<>). When the file
is imported, the label reverts to its primary label’s value.
• A translated value for the data in the record’s Name field is required to translate data in other fields for that record. For example, you
must provide a German translation for the name of a Product before you can translate its description into German.
• Deleting the data translated value for a record’s Name field can delete all of that record’s other translated values for that language.
See Considerations for Working with Translation Files for more information.

Column Description Edit Options

KEY Unique identifier for the label. Do not edit.

LABEL Label or text in the org’s default language. Replace label text with new or updated
translated values.

TRANSLATION The current translation that is visible to end Delete this column and its contents when
users selecting the target language as their updating an out-of-date translation.
personal language.
Untranslated labels don’t have a value in
this column.

OUT OF DATE Indicates whether the source text has Delete this column and its contents when
changed since the previous translation. updating an out-of-date translation.
An asterisk (*) indicates that the label is out
of date. A change was made to the primary
label and the translation hasn't been
updated.
Untranslated labels don’t have a value in
this column.

For example, in an org with English as its default language, an existing custom Prior Reference Number field on the Account object has
an incorrect Spanish translated value of “Número de consulta previa.” Although the translation isn’t out of date, it must be updated to
“Número de referencia precedente.”
The Name field on a custom Widget object had a primary label of “SLK.” A translator misinterpreted this acronym and entered a Spanish
translation of “Flojo.” Although the translation isn’t out of date, you want to revert the translation to the primary label.
You also build a new custom Business Hours field on the Account object. This label is untranslated.
Nickname, another existing custom field on the Account object, has a Spanish translated value of “Apodo.” You change the primary label
on the Nickname field from “Nickname” to “Preferred Name.” This label is outdated.
Finally, a custom Number field on a custom Widget object had a primary label of “Number” and a Spanish translated value of “Número.”
You update the primary label to “#” and want to remove the translated value.
The exported Bilingual .stf translation file contains these rows in the OUTDATED AND UNTRANSLATED section.

144
Extend Salesforce with Clicks, Not Code Manage Your Translations

------------------TRANSLATED-------------------

# KEY LABEL TRANSLATION OUT OF

DATE

CustomField.Account.Prior_Ref_No.FieldLabel Prior Reference Número de consulta –

Number previa

CustomField.Widget__c.Name.FieldLabel SLK Seda –

------------------OUTDATED AND UNTRANSLATED-----------------

# KEY LABEL TRANSLATION OUT OF

DATE

CustomField.Account.Business_Hours.FieldLabel Business Hours

CustomField.Account.Nickname.FieldLabel Preferred Name Apodo *

CustomField.Widget__c.Number.FieldLabel # Número *

To make the requested changes:

• In the TRANSLATED section, update translations by replacing the value in the TRANSLATION column. To delete the translation of the
Widget object’s Name field, replace the TRANSLATION value with <>. When this file is imported, the label for that Number field
reverts to its primary label value of SLK.
• In the OUTDATED AND UNTRANSLATED section, replace the value in the LABEL column. Then remove the TRANSLATION and OUT
OF DATE columns and their content for the Nickname field. To delete the translation of the Widget object’s Number field, replace
the TRANSLATION value with <>. When this file is imported, the label for that Number field reverts to its primary label value of #.

------------------TRANSLATED-------------------

# KEY LABEL TRANSLATION OUT OF

DATE

CustomField.Account.Prior_Ref_No.FieldLabel Prior Reference Número de –

Number referencia
precedente

CustomField.Widget__c.Name.FieldLabel SLK <> –

------------------OUTDATED AND UNTRANSLATED-----------------

# KEY LABEL

CustomField.Account.Business_Hours.FieldLabel Horario de oficina

CustomField.Account.Nickname.FieldLabel Nombre preferido

CustomField.Widget__c.Number.FieldLabel <>

145
Extend Salesforce with Clicks, Not Code Manage Your Translations

Important: Delete the TRANSLATION and OUT OF DATE columns only in the OUTDATED AND UNTRANSLATED section. Rows in
that section must have exactly two columns of data to be imported. Rows in the TRANSLATED section must have exactly four
columns of data to be imported.

SEE ALSO:
Considerations for Working with Translation Files

Translation File IDs and Keys

Each translatable item has a unique identifier in the translation file. In .xlf files, it’s the id within a
EDITIONS
trans-unit tag. In .stf files, it’s the key. The structure of these identifiers differs for metadata and data
translation files. Metadata translation
Note: Translation file keys and ids aren’t edited during translation. The text to be translated available in: Salesforce
Classic (not available in all
is in the translation file in the source tag for .xlf files or the label column for .stf files. For
orgs) and Lightning
admins, knowing how the id or key work can help them understand how these identifiers
Experience
are structured.
Data translation available in:
Lightning Experience
Metadata Translation File IDs and Keys
All translatable metadata has a setup component. Depending on the setup component, the Available in: Professional,
Enterprise, Performance,
translatable metadata can have an object, aspect, custom report type entity, flow type, flow name,
Unlimited, and Developer
and flow component.
Editions
• Metadata label translation file IDs and keys follow the format:
SetupComponentName.ObjectName.AspectName. Data translation applies to:
B2B Commerce
• Metadata label translation file IDs and keys for custom report types contain the report type
entity in place of the object name. The format is:
SetupComponentName.CustomReportEntityName.AspectName.
• Metadata translation file IDs and keys for flows can also contain the flow component, flow type, flow name, flow version, flow screen,
or flow aspect. See Flow Identifiers in Translation Files for detailed examples.
This table provides examples of metadata translation IDs and keys.

Translation Label or Text id (in .xlf Files) or Key (in .stf Files)
Country “Spain” in address AddressCountry.ES

“Billing” button or link on the Account object ButtonOrLink.Account.Billing

Label of the “Active” field on the Account object CustomField.Account.Active.FieldLabel

Description of the “Active” field on the Account object CustomField.Account.Active.Description.FieldLabel

Help text of the “Active” field on the Account object CustomField.Account.Active.Description.HelpText

“Low” picklist entry in the Customer Priority picklist on the Account PicklistValue.Account.CustomerPriority.Low
object

Description of the “East Accounts” Custom Report Type CustomReportType.East_Accounts.Description

“Accounts” Custom Report Type Layout Section on the “Accounts” CrtLayoutSection.Custom_Accounts_Reports_1

Custom Report Type

146
Extend Salesforce with Clicks, Not Code Manage Your Translations

Translation Label or Text id (in .xlf Files) or Key (in .stf Files)
Description of the “Goal Layout” Custom Report Type Layout on LayoutSection.Goal.Goal
the “Goals” Custom Report Type Layout.Description_1

“Survey Customers” flow name Flow.Flow.Survey_customers.FieldLabel

“Customer Name” screen input field on version 2 of the “Survey Flow.Flow.Survey_customers.2.Survey_

Customer” flow Customer.Field.Customer_Name.FieldLabel

Data Translation File IDs and keys

If data translation is enabled in your Salesforce org, the record ID is used to identify the translatable text in an exported data translation
file. Data translation IDs and keys follow the format ObjectName.recordUniqueIdentifier.FieldName.
This table provides examples of data translation IDs and keys.

Translation Label or Text id (in .xlf Files) or Key (in .stf Files)
Name of the product with record ID 01txx0000006yvEAAQ Product2.01txx0000006yvEAAQ.Name

Description of the product with record ID Product2.01txx0000006yvEAAQ.Description

01txx0000006yvEAAQ

Text stored in a custom “Discount Notes” field for the product Product2.01txx0000006yvEAAQ.Discount_Notes__c
record ID 01txx0000006yvEAAQ

SEE ALSO:
Flow Components for Metadata Translation

Flow Identifiers in Translation Files

In a translation file exported from Translation Workbench, a unique key or trans-unit ID attribute
EDITIONS
identifies a flow metadata label.
Flows follow a convention based on the flow label. Available in: Salesforce
Classic (not available in all
Flow Key or Trans-Unit ID Example orgs) and Lightning
Component Experience

Flow Flow.flowType. Flow.Flow.Survey_customers.FieldLabel Available in: Professional,

Definition flowUniqueName.FieldLabel Enterprise, Performance,
Name Unlimited, and Developer
Editions
Flow Version Flow.flowType. Flow.Flow.Survey_customers.1.Name
Name flowUniqueName.
versionNumber.Name

Screen

147
Extend Salesforce with Clicks, Not Code Manage Your Translations

Flow Component Key or Trans-Unit ID Example

Paused Message Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.1.Screen.Greet_Customer.
versionNumber.Screen.screenUniqueName. PausedText
PausedText

Help Text Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.1.Screen.Greet_Customer.

versionNumber.Screen.screenUniqueName. HelpText
HelpText

Screen Input Field

Label Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Survey_Customer.Field.

versionNumber.screenUniqueName.Field. Customer_Name.FieldLabel
fieldUniqueName.FieldLabel

Help Text Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Survey_Customer.Field.

versionNumber.screenUniqueName.Field. Customer_Name.HelpText
fieldUniqueName.HelpText

Error Message Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Survey_Customer.

versionNumber.screenUniqueName.Field. Field.Customer_Name.ErrorMessage
fieldUniqueName.ErrorMessage

Screen Output Field

Display Text Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Greet_Customer.Field.

versionNumber.screenUniqueName.Field. WelcomeMessage.Description
fieldUniqueName.Description

Choice

Label Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Choice.Participate_No.

versionNumber.Choice.choiceUniqueName. FieldLabel
FieldLabel

Error Message Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Choice.Participate_No.

versionNumber.Choice.choiceUniqueName. ErrorMessage
ErrorMessage

Input Label Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.Choice.Participate_No.

versionNumber.Choice.choiceUniqueName. InputLabel
InputLabel

Stages

Stage Label Flow.flowType.flowUniqueName. Flow.Flow.Stages_Online_Purchase_Breadcrumbs.1.

versionNumber.Stage.stageUniqueName. Stage.Billing_Details.FieldLabel
FieldLabel

Text Template

148
Extend Salesforce with Clicks, Not Code Manage Your Translations

Flow Component Key or Trans-Unit ID Example

Label Flow.flowType.flowUniqueName. Flow.Flow.Survey_customers.2.TextTemplate.
versionNumber.TextTemplate. ParticipantCity_FieldLabel
texttemplateUniqueName.FieldLabel

SEE ALSO:
Work with Translation Files
Considerations for Translating Flows

Import Translated Files

Import and update the translations for your Salesforce org’s metadata, such as custom fields, report
EDITIONS
types, and picklist values. Or import and update data translations, such as Product names. Typically,
you export translation files from Salesforce, then send them to outside translators or a translation Metadata translation
agency for bulk translation activities. You then import the translated files. available in: Salesforce
Classic (not available in all
Note: You need the Manage Translation AND Create Documents user permissions to import
orgs) and Lightning
or export translation files. If you attempt either operation without both user permissions, it’s
Experience
possible to navigate to the import or export page, but the operation itself fails.
Data translation available in:
Lightning Experience
Prepare Your Translated Files
1. Create a separate file for each language. Available in: Professional,
Enterprise, Performance,
Salesforce recommends the XML Localization Interchange File Format (.xlf) for translation files. Unlimited, and Developer
Editions
2. Specify the language for this translation import.
When you export a translation file with the Bilingual or Outdated and untranslated export type, Data translation applies to:
B2B Commerce
the language is already specified. If you’re importing a Source file or importing translations for
a different language than the original file, update the language code.
• For .xlf files, use the target-language attribute on the file tag. For example, <file USER PERMISSIONS
original="Salesforce" source-language="en_US"
To export or import
target-language="es" datatype="xml">. translation files
• For .stf files, use the language code attribute at the top of the file. For example: • Manage Translation
AND
Create Documents

# Language: Spanish
Language code: es
Type: Source

Translation for the specified language must be supported for your org. For a full list of Salesforce supported languages and their
language codes, see Supported Languages in Salesforce Help.

3. If data translation is enabled in your Salesforce org, include a translation type attribute. For .xlf files, include the translation-type
attribute on the file tag. For .stf files, include the translation type on its own line after the language code and type.

149
Extend Salesforce with Clicks, Not Code Manage Your Translations

Note: If you export a translation file after data translation is enabled in your org, the resulting file includes this attribute.

File Type Metadata Translation Attribute Data Translation Attribute

XML Localization translation-type="metadata" translation-type="data"
Interchange File
Format (.xlf)

Salesforce Translation Type: Metadata Translation Type: Data

Translation
Format (.stf)

4. Save import files in UTF-8 encoding.

5. Size your files.
When importing metadata translation files, individual uncompressed files are limited to 10 MB each. When importing data translation
files, individual uncompressed files are limited to 50 MB each.

6. Bundle multiple files into .zip files.

If data translation isn’t enabled in your org, each imported .zip file is limited to 10 MB. If data translation is enabled, each imported
.zip file is limited to 1 GB. When zipping data translation files for import, each .zip file can contain up to 100,000 total translation
records within up to 2 GB of uncompressed files. Create multiple .zip files as needed.

Important: Each .zip file can only contain metadata or data translation. If data translation is enabled in your org, import
metadata and data translations separately.
The zipped files don't have to be in the same order or grouping as the exported .zip files.
For example, you start with two exported .zip files. The first file includes French, Italian, and Japanese. The second file includes Russian,
Simplified Chinese, and Greek. You can create:
• One .zip file with French, Greek, and Italian.
• One .zip file with Russian and Greek.
• One .zip file with Simplified Chinese.

Import Your Prepared Translated Files

1. From Setup, in the Quick Find box, enter Import, and then select Import under Translation Workbench.
2. Click Choose File, and select the file you want to import.
3. Click Import.
After the import is complete, a confirmation email is sent to the email address specified in your profile. Wait for each import to finish
before submitting another translation file for import.
If any portion of the import fails, the email includes details about what went wrong. If the imported zip file exceeds translation import
limits, the email lists the files that were imported before the limit was reached. If records within the imported translation files weren’t
processed, the email lists those files and includes an error log.

Verify Your Translations

There are multiple ways to view the imported translations:

150
Extend Salesforce with Clicks, Not Code Manage Your Translations

Note: Labels that are exported and left unchanged in the translation file aren’t saved as translations on import.

• Check metadata labels and data translations in your Salesforce org.

• Check metadata labels through Translation Workbench.
• Check data translations through the Translation tab within Product.
• Export data translations and verify your updated text. Check the labels in your Salesforce org.

SEE ALSO:
Supported Languages
Work with Translation Files
Common Errors with Exporting and Importing Translation Files
Documents Home

Common Errors with Exporting and Importing Translation Files

Troubleshoot issues you can encounter while exporting and importing files in Translation Workbench.
EDITIONS
Error Message What It Means Troubleshooting Steps Metadata translation
Bilingual file section starts with The header rows of the file Export your file again Make sure available in: Salesforce
non-header row: <line you're trying to import are that there are header rows for Classic (not available in all
orgs) and Lightning
number> missing. Or there’s extraneous all sections, and that all
Experience
text, such as notes that aren't extraneous text has been
commented out, in those rows. commented out or removed Data translation available in:
from the header rows. Lightning Experience

Data translation import for key This error message only applies Provide a translated value for Available in: Professional,
<key> failed. A translated value to data translation files. A the data stored in the Name Enterprise, Performance,
for the <object name> translated value for a record field for that record ID, then Unlimited, and Developer
<unique record ID> record ID’s ID’s Name field is required to import again. Editions
Name field is required to translate data in other fields for Data translation applies to:
translate data for the <field that record ID. B2B Commerce
name> field.

Data translation isn’t enabled This error message only applies Enable data translation, and
for this org. to data translation files. Data then import the file again.
translation isn’t enabled or was
disabled after the data
translation file was exported.

Duplicate key: <key> exists in The specified key appears in Export your file again, and
import file, re-export. your imported file more than make sure that each key is
one time. Each translated item unique. Then import the file
must have its own unique key, again.
and each key can only appear
in the file one time.

151
Extend Salesforce with Clicks, Not Code Manage Your Translations

Error Message What It Means Troubleshooting Steps

File contains translation keys that don't The file contains at least one key with a Create separate import files for metadata
match the translation type specified in the translation type that doesn’t match the file and data translation.
file header. Create separate import files for type in the header.
metadata and data translation.

Invalid Key During translation, Salesforce generates Export your file again, and make sure the
unique keys, or identifiers, for each object, keys in it match the keys in the file that
picklist value, or page element that you're you're trying to import.
translating. If these names or keys are
changed after you export your file,
Salesforce can't match the correct key with
the correct name.

Invalid key: <key>. Data translation isn’t This error message only applies to data Enable data translation on the field through
enabled for the <field name> field on the translation files. Data translation was the Data Translation Settings Setup page,
<object name> object. disabled on the field after the translation file or delete references to the key from the
was exported. translation file.

Invalid key: <key>. The <field name> field This error message only applies to data Export your file again, and compare it with
on the <object name> object doesn’t translation files. The key includes a field that the identified key. If the identified key was
support data translation. doesn’t support data translation. Either an modified, use the newly exported key. If it
exported key was changed after the export doesn’t exist in the exported translation file,
or the key was manually added. delete the identified key from the translation
file.

Invalid key: <key>. The key's translation type Imported translation files must contain Update the file’s translation type in the file
must match the file's translation type. either metadata keys or data translation header.
keys. This key doesn’t match the file’s Create separate import files for metadata
translation type. and data translation as needed.

Invalid key: <key>. The <object name> This error message only applies to data Export your file again, and compare it with
object doesn’t support data translation. translation files. The key includes an object the identified key. If the identified key was
that doesn’t support data translation. Either modified, use the newly exported key. If it
an exported key was changed after the doesn’t exist in the exported translation file,
export or the key was manually added. delete the identified key from the translation
file.

Invalid key: <key>. You can't delete the data This error message only applies to data Edit your file. To delete all data translations
translation value for a record's name and translation files. The file includes a key to associated with this record, remove all keys
update the value for another of that record's delete the data translation for this record’s related to this record except the key
fields at the same time. Name. The file also includes a data deleting the translated value for the record’s
translation value for another of the record’s Name. To update other fields, remove the
fields. Because deleting the translated value key deleting the translated value for the
of a record’s Name deletes the translated record’s Name.
values for all fields related to that record, See Considerations for Working with
the translation keys conflict. Translation Files for more information.

Key: <key> couldn’t be uniquely resolved. One of the keys in your Custom Report Type Export your file again, and make sure that
Caused by a change to our Custom Report (CRT) column is in the wrong format. you're using the correct CRT key format.

152
Extend Salesforce with Clicks, Not Code Manage Your Translations

Error Message What It Means Troubleshooting Steps

Type Column key format. Re-export and use
the new key format for those keys.

Maximum character limit <x> for <field Each type of field, such as a picklist value, Edit your translated labels so that they're
type> translation exceeded in line: can only have a certain number of within the character limit listed for the field
characters. Your translated labels for the type, and import your file again.
type of field at the line specified in the error
message are too long.

No data to import The file that you're trying to import is empty Make sure that you're importing the correct
or doesn’t contain any translation changes. file and that it contains translated data.

No language code specified in file header The file that you're trying to import doesn't Make sure that your language code is valid
have a valid language code, or the language and isn't missing or commented out.
code is in the wrong place.

No translated or untranslated section header The file that you're trying to import is Make sure that your file has section headers,
found in the bilingual file missing section headers. and import it again.

No valid file type specified in file header The file that you're trying to import doesn't Make sure that your file has a valid
have a valid import/export type (Source, import/export type in the file header and
Outdated and untranslated, or Bilingual) that the header isn’t translated.
specified in the file header. The file type
attribute must be in the default language
for your org.

No valid translation type specified in file The file that you’re trying to import doesn’t Make sure that your file has a valid
header have a valid translation type specified in the translation type in the file header and that
file header. The translation type is only the header isn’t translated.
required if data translation is enabled.
The attributes for metadata translation are:
• Translation Type:
Metadata for .stf files and
• translation-type="metadata"
for .xlf files
The attributes for data translation are:
• Translation Type: Data for
.stf files and
• translation-type="data" for
.xlf files
The translation type attribute must be in the
default language for your organization.

Not a valid file to import. Select a .stf, .xlf, or You can import files in .stf or .xlf formats, or Make sure that your file is a .stf, .xlf, or .zip
a .zip file for import. .zip files that contain .stf or .xlf files. file, and try importing it again.

153
Extend Salesforce with Clicks, Not Code Manage Your Translations

Error Message What It Means Troubleshooting Steps

Some keys are appended with their sort The order of the picklist values in your Export your source file, match the order of
order for uniqueness. Re-export your file and source file doesn't match your setup. the picklist values to your import file, and
ensure that the keys in both files match. then import again.

There were issues with import of file: The file that you’re importing has invalid or Export your file again, and identify the fields
importFileName.xlf [Your import request missing HTML tags. HTML tags are used in with HTML tags in the exported source text.
failed. Retry or contact support.] translations for rich text area fields. Edit your translation values for these rich
text area fields with the correct HTML tags.
See Considerations for Working with
Translation Files for more information on
translating rich text fields.

Wrong number of columns in line: <line The file that you're importing has extra tabs, Edit your data to remove or escape any extra
number>. Check that you have escaped new lines, or carriage returns in the line tabs, newlines, or carriage returns. Make sure
tabs (\\t), new lines (\\n), and carriage specified in the error message. that the translated file has the same number
returns (\\r) in your files. of columns as the file you exported.

Your export request failed. Retry or contact Salesforce had an unexpected problem Contact Salesforce Customer Support.
support. while exporting your file.

Your import request failed. Retry or contact Salesforce had an unexpected problem Contact Salesforce Customer Support.
support. while importing your file.

Your organization doesn’t have language The file that you're trying to import is in a Add the language you want to use to
permissions for <language>. language you haven't yet added to Translation Workbench through the
Translation Workbench. Translation Language Settings Setup page.
Then import your file again.

SEE ALSO:
Export Metadata Translation Files
Export Data Translation Files
Import Translated Files
Considerations for Working with Translation Files

154
Extend Salesforce with Clicks, Not Code Manage Your Translations

Translation Considerations
Review considerations for managing your translations and translating flows.
EDITIONS

Considerations for Managing Translations Metadata translation

Keep these tips in mind when creating custom labels, working with translators, and maintaining available in: Salesforce
translations. Classic (not available in all
orgs) and Lightning
Considerations for Translating Flows Experience
When you use Translation Workbench to translate flows, note these considerations.
Data translation available in:
Lightning Experience

Available in: Professional,

Enterprise, Performance,
Unlimited, and Developer
Editions

Data translation applies to:

B2B Commerce

Considerations for Managing Translations

Keep these tips in mind when creating custom labels, working with translators, and maintaining
EDITIONS
translations.
• Salesforce assumes that all customizations are entered in the Salesforce org’s default language. Metadata translation
We recommend that global administrators work together in the org’s default language. available in: Salesforce
Classic (not available in all
• Salesforce recommends the XML Localization Interchange File Format (.xlf) for translation files.
orgs) and Lightning
• When creating a custom report type for translation into multiple languages via Translation Experience
Workbench, set your personal language to match your org’s default language. Setting a language
ensures that translated words display in the correct language for translators. Data translation available in:
Lightning Experience
• Advise users customizing reports or list views to use filter criteria values in their personal
language. However, if they use the starts with or containscontains operators, advise Available in: Professional,
them to choose the language of the filter criteria values they entered. Enterprise, Performance,
• If you installed a managed package that includes translations, those translated values appear Unlimited, and Developer
to users regardless of whether the language is active on the Translation Language Settings Editions
Setup page. To override metadata translations delivered by a managed package for custom Data translation applies to:
objects, see Override Translations in Second-Generation Managed Packages and Unlocked B2B Commerce
Packages.
• Let translators know which languages they’re responsible for translating.
• Notify all translators when you add new translated components to your org. For best results, have your translators check their
translations frequently, and be sure to notify them when changes occur.
• Periodically review outdated translations by exporting your translations. To generate a list of all the translatable customizations and
the associated Out of Date states, use the Outdated and Untranslated export type or Bilingual export type.

155
Extend Salesforce with Clicks, Not Code Manage Your Translations

• If you have more than 25 navigation menu items open, use the scroll bar to find the navigation tools at the bottom of the window
to navigate between pages.

SEE ALSO:
Work with Translation Files
Override Translations in Second-Generation Managed Packages and Unlocked Packages

Considerations for Translating Flows

When you use Translation Workbench to translate flows, note these considerations.
EDITIONS

Translating Flows Available in: Salesforce

Classic (not available in all
• To check which flow types are translatable, see Flow Types in Salesforce Help. orgs) and Lightning
• A translation can only reference a merge field (like {!myVar}) if the field is referenced in the first Experience
1,000 characters of the primary label.
Available in: Professional,
• Translations for flow definition name and version name each have a maximum limit of 255 Enterprise, Performance,
characters. Other translations for flow labels have a maximum of 1,000 characters. Unlimited, and Developer
• Text templates and merge field values aren’t supported for translation. Editions
• Right-to-left languages aren’t supported.
• When a flow label isn’t translated for a language, Salesforce uses the translation for the
appropriate fallback language. If the fallback language has no translated label, the primary label is used.

Updating Flow Translations

When you change a flow that you translated, Salesforce copies as much information as it can when you create a version or save changes
to the translated version.
For example, version 1 of the Survey Customers flow has a translation for the WelcomeMessage field. When you save another version
of the flow, Salesforce copies all the latest translations from version 1 to version 2. The same happens if you save it as a new flow.
When you remove a label from a flow, translations aren’t copied. Salesforce uses the label’s Unique Name to copy translations to another
version. When you change the label’s unique name, Salesforce treats it as a new label.
When you delete a flow, its translations are also deleted.
When you translate a flow from a managed package, the flow’s Master Definition Name doesn’t appear on the Translate page or the
Override page. To update the translation for the Master Definition Name, edit the flow label and then update the translation from the
Translate page.

Exporting and Importing Flow Translations

• You can export and import translation files to send to translators or to help you translate lengthy text.
• When you export translations, the primary labels are truncated after 1,000 characters.

SEE ALSO:
Salesforce Help: Translate Flow Screen Components

156
Extend Salesforce with Clicks, Not Code Set Up Your Data Your Way

Set Up Your Data Your Way

Optimize your Salesforce data to fit the unique needs of your users. You can create your own objects
EDITIONS
with data that fits together in the ways that make the most sense for you.
Available in: both Salesforce
Store Information That’s Unique to Your Organization Classic and Lightning
Create custom objects to store information that’s unique to your organization. Choose whether Experience
your custom objects are searchable, support sharing, or include access to the Bulk API and The available customization
Streaming API. options vary according to
Store Customers’ Data Privacy Preferences which Salesforce Edition you
Store certain data privacy preferences for your customers. have.

Classify Sensitive Data to Support Data Management Policies

Record data sensitivity and compliance categorization at the field level. Data classification can USER PERMISSIONS
be used to guide decisions around access, reporting, and data compliance. To view setup options:
Design Your Own Data Model With Schema Builder • View Setup and
Schema Builder provides a dynamic environment for viewing and modifying all the objects and Configuration
relationships in your app. This greatly simplifies the task of designing, implementing, and To customize your org:
modifying your data model, or schema. Schema Builder is enabled by default. • Customize Application
Create Custom Settings
Use custom settings to create custom sets of data, or to create and associate custom data for
an org, profile, or user.
Customize Fields
Customize standard and custom fields to tailor your org to your own unique requirements.
Calculate Field Values with Formulas
A formula is an algorithm that derives its value from other fields, expressions, or values. Formulas can help you automatically calculate
the value of a field based on other fields.
Generate Emails From Records
A merge field is a field you can put in an email template, mail merge template, custom link, or formula to incorporate values from
a record. For example, you can place a merge field in an email template so that the greeting includes the recipient’s name rather
than a generic “Hello!”.

Store Information That’s Unique to Your Organization

Create custom objects to store information that’s unique to your organization. Choose whether
EDITIONS
your custom objects are searchable, support sharing, or include access to the Bulk API and Streaming
API. Available in: both Salesforce
Every custom object is classified as either an Enterprise Application object or a Light Application object. Classic and Lightning
The difference between these two categories is that Light Application objects don’t support sharing, Experience
access to the Bulk API, or access to the Streaming API.
Available in: Contact
If you need to track your organization’s usage of each category, create a custom report type with Manager, Group,
a primary object of User Licenses and a child object of Custom Object Usage by User License Metrics. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

157
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

By default, all custom objects are Enterprise Application objects. To make your custom object a Light Application object, disable Allow
Sharing, Allow Bulk API Access, and Allow Streaming API Access on the object’s detail page.

Manage Custom Objects

Create, customize, edit, delete, or truncate custom objects to extend the functionality that standard objects, like accounts and
contacts, provide.
Track Your Organization’s Custom Object Usage by User License Type
To keep track of how many custom objects your users are assigned to, create a custom report type with the User Licenses and Custom
Object Usage by User License Metrics objects.
Manage Big Objects
A big object stores and manages massive amounts of data on the Salesforce platform. You can archive data from other objects or
bring datasets from outside systems into a big object to get a full view of your customers. From Setup, you can create a custom big
object and define its fields and index.
Object Relationships Overview
Create relationships to link objects with each other, so that when your users view records, they can also see related data. For example,
link a custom object called Bugs to cases to track product defects that are associated with customer cases.
Customize Search Layouts
Search layouts let you determine what users see when Einstein Search returns results. For each unique user profile, you can create
search layouts for standard and custom objects, ensuring the layout shows users what’s most relevant to them. Only objects with
customizable layouts support profile-specific layouts. The search layout that you configure applies to global and lookup searches.
Custom Object Security
Learn how security settings work together so you can control access to your custom objects with great flexibility.
Notes on Enabling Activities for Custom Objects

SEE ALSO:
Track Your Organization’s Custom Object Usage by User License Type

158
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Manage Custom Objects

Create, customize, edit, delete, or truncate custom objects to extend the functionality that standard
EDITIONS
objects, like accounts and contacts, provide.

Note: Your administrator may have created a tab without any help. If you need help to Available in: both Salesforce
understand how a tab for a custom object works, contact your administrator. Classic (not available in all
orgs) and Lightning
Your object management settings list the custom objects that are defined for your organization. Experience
From this list, you can:
Available in: Contact
• Define a custom object. Manager, Group,
• Display detailed information about a custom object. Professional, Enterprise,
Optional features you can customize include enabling search and reports, tracking activities, Performance, Unlimited,
Developer, and
tracking field history, and making the object available for the Salesforce Customer Portal.
Database.com editions
• To update the custom object definition, click Edit and update the desired fields. Managed Packages aren’t
Note: The Allow Reports, Allow Activities, and Allow Search fields aren’t locked in available in Database.com.
Managed - Released and can be changed by the developer in future releases of a managed
package.
USER PERMISSIONS
• To delete a custom object, click Del.
To create and edit custom
• To truncate a custom object, click Truncate. objects:
• To view deleted custom objects, click the Deleted Objects link. The total number of deleted • Customize Application
custom objects for your organization is listed in parentheses.
The detail page of the custom object provides information about various characteristics of the
object, including standard fields, custom fields, field history tracking, relationships, custom links, search layouts, page layouts, and object
limits. You can:
• Click individual items to display additional detail.
• To delete a custom field, click Del next to its name in the Custom Fields & Relationships section.
• Click More at the bottom of the page or View More below a related list to display more items.
• Click New to directly add new items.

Note: The object limit percentages are truncated, not rounded. For example, if your org uses 95.55% of the limit for a particular
customization, the object limit displays 95%.

Deployment Status for Custom Objects and External Objects

Create a Custom Object
Track and store data that’s unique to your organization. Follow different steps, depending on which Salesforce experience you’re
using.
Modify Custom Objects
Custom Object Standard Fields
When you create a custom object, these default fields are automatically assigned to the object.
Delete Custom Objects
Manage Deleted Custom Objects
Considerations for Truncating Custom Objects
It’s important to understand what truncating an object does before using it to remove records.

159
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Truncate Custom Objects

Truncating custom objects allows you to delete all of the object’s records permanently, but preserve the empty object and its
metadata.

SEE ALSO:
Make Search Faster
Store Information That’s Unique to Your Organization
Find Object Management Settings

Deployment Status for Custom Objects and External Objects

While developing a custom object or external object, you might not want users to see and interact
EDITIONS
with it. Because users can get frustrated with changes in layout or lose data when you delete custom
fields, control visibility of the new object until you’re finished. Available in: both Salesforce
Use the Deployment Status setting in the object definition to control when users can see and use Classic (not available in all
the object and its associated custom tab, related lists, and reports. orgs) and Lightning
Experience
• Set the deployment status to In Development when first creating your custom object or external
object. Doing so hides it from users while you’re designing and testing it. Only users with the Available in: Contact
Customize Application permission can see the object tab, search results, related lists, and report Manager, Group,
data types. Professional, Enterprise,
Performance, Unlimited,
• Change the deployment status to Deployed when you want to allow all users to use the object
Developer, and
and the associated custom tab, related lists, and reports.
Database.com Editions
• If you make more enhancements after deploying a custom object or external object, you can
Salesforce Connect external
change the deployment status back to In Development.
objects are available in
Note: A custom report type’s deployment status changes from Deployed to In Development Developer Edition and, for
if its primary object is a custom or external object whose deployment status similarly changes. an extra cost, in Enterprise,
Performance, and Unlimited
Note: When you create a big object, the status is set to In Development. You can't deploy Editions.
a big object until it includes an index that contains at least one custom field. Only required
custom fields are allowed in an index. After you create an index, you see a second status of
Deployed. When you’re ready to grant users access, change the status to Deployed. USER PERMISSIONS

To deploy custom objects

SEE ALSO: and external objects:
Make Search Faster • Customize Application

Create a Custom Object

Track and store data that’s unique to your organization. Follow different steps, depending on which Salesforce experience you’re using.

Create a Custom Object in Lightning Experience

Track and store data that’s unique to your organization.
Create a Custom Object from a Spreadsheet in Lightning Experience
Use custom objects to track and store data that’s unique to your organization. If you prefer not to create a custom object and its
fields manually, you can use a spreadsheet to add the object and its fields and populate all its record data.

160
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Create a Custom Object in Salesforce Classic

Track and store data that’s unique to your org.
Fields Required for Creating Custom Objects
When you create a custom object, several fields are required to define how you can access the object.
Considerations for Creating Custom Objects
Before you create a custom object, make sure that you’ve reviewed the considerations.

SEE ALSO:
Make Search Faster
Object Relationships Overview
Define Object-Level Help in Salesforce Classic

Create a Custom Object in Lightning Experience

Track and store data that’s unique to your organization.
EDITIONS
If you see the App Launcher icon ( ) on the left side of the navigation bar at the top of your
screen, you're in Lightning Experience. If not, you're in Salesforce Classic. Available in: Lightning
Experience
1. From the top-right corner of any page in Setup, click Create > Custom Object.
Available in: Contact
2. Complete the fields for your custom object and configure its features.
Manager, Group,
3. If you want to create a custom tab for the object immediately after you save it, select Launch Professional, Enterprise,
New Custom Tab Wizard after saving this custom object. Performance, Unlimited,
To create the custom object tab later, from Setup in the Quick Find box, enter Tabs, and then and Developer Editions
click Tabs.

4. Save the new object. USER PERMISSIONS

5. In the Object Manager, click Fields & Relationships, and create the custom fields that your To create and edit custom
object needs. objects:
• Customize Application
Tip: If you don’t want your users to see the new custom object while you design and test it,
to hide it, set the deployment status to In Development.

SEE ALSO:
Create a Custom Object from a Spreadsheet in Lightning Experience
Fields Required for Creating Custom Objects
Considerations for Creating Custom Objects
Create a Custom Object

161
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Create a Custom Object from a Spreadsheet in Lightning Experience

Use custom objects to track and store data that’s unique to your organization. If you prefer not to
EDITIONS
create a custom object and its fields manually, you can use a spreadsheet to add the object and its
fields and populate all its record data. Available in: Lightning
Note: Although it’s available in Professional Edition, this feature uses API. To use this feature, Experience
Professional Edition orgs must have the API add on enabled. To enable the API add on, contact Available in: Contact
your Account Executive. Manager, Group,
You can create a custom object from a spreadsheet in two places: in Setup, or from the Navigation Professional, Enterprise,
Items tab inside a Lightning app’s settings. Performance, Unlimited,
and Developer Editions
1. In Setup, go to Object Manager, then click Create > Custom Object from Spreadsheet.
2. Alternatively, navigate to the Navigation Items tab inside a Lightning app.
USER PERMISSIONS
a. In Setup, enter App in the Quick Find box, then select App Manager.
To create and edit custom
b. Next to the app you want to add the custom object to, click , and select Edit. objects:
• Customize Application
c. Click Navigation Items.
d. From the Available Items list, click Create > Custom Object from Spreadsheet.

3. Follow the wizard steps to import your custom object data from an .xlsx file, a .csv file, or a Google sheet.
Salesforce detects object field labels from the spreadsheet row that you specify. All fields must be mapped to create the custom
object. Skipping the import step creates an empty custom object that uses the fields in the spreadsheet as a template. When you
finish creating the object, a custom tab is created for it. The object appears in the list of available items for your app. If you imported
field data, your object is ready to go with fully populated records.
4. If you don’t want your users to see the new custom object right away, in the Object Manager in Setup, set its deployment status to
In Development. This setting hides the object from users while you’re designing and testing it.
5. When you’re ready for your users to see the new custom object, add it to your app’s Selected Items list.

SEE ALSO:
Fields Required for Creating Custom Objects
Create a Custom Object in Lightning Experience
Considerations for Creating Custom Objects
Create a Custom Object

162
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Create a Custom Object in Salesforce Classic

Track and store data that’s unique to your org.
EDITIONS
1. From Setup, enter Objects in the Quick Find box, then select Objects.
Available in: Salesforce
2. Click New Custom Object.
Classic (not available in all
3. Follow the wizard to complete the fields for your custom object. orgs)
4. Save the new object. Available in: Contact
Manager, Group,
SEE ALSO: Professional, Enterprise,
Performance, Unlimited,
Fields Required for Creating Custom Objects
and Developer Editions
Considerations for Creating Custom Objects
Create a Custom Object
USER PERMISSIONS

To create and edit custom

objects:
• Customize Application

Fields Required for Creating Custom Objects

When you create a custom object, several fields are required to define how you can access the
EDITIONS
object.

Important: Where possible, we changed noninclusive terms to align with our company Available in: Lightning
value of Equality. We maintained certain terms to avoid any effect on customer Experience and Salesforce
Classic
implementations.
Available in: Contact
Note: If an administrator created a tab without including help, contact your administrator
Manager, Group,
if you need help with how a custom object works.
Professional, Enterprise,
Performance, Unlimited,
Field Description and Developer Editions
Label This name is used to refer to the object in a user
interface page.

Plural Label The plural name of the object. If you create a

tab for this object, this name is used for the tab.

Gender If it’s appropriate for your org’s default language,

specify the gender of the label. This field appears
if the org-wide default language expects gender.
Your personal language preference setting
doesn’t affect whether the field appears. For
example, if the org’s default language is English
and your personal language is French, you aren’t
prompted for gender when creating a custom
object.

Starts with a vowel sound If it’s appropriate for your org’s default language,
indicate whether “an” or “a” precedes the label.

163
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Field Description
Object Name A unique name used to refer to the object when using the API. In
managed packages, this name prevents naming conflicts with
package installations. Use only alphanumeric characters and
underscores. The name must begin with a letter and have no
spaces. It can’t end with an underscore nor have two consecutive
underscores.

Description An optional description of the object. A meaningful description

helps you remember the differences between objects when you’re
viewing them in a list.

Context-Sensitive Help Setting Defines the URL that displays when a user clicks Help for this Page
from the object record’s home (overview), edit, and detail pages,
list views, and related lists. This setting doesn’t affect the Help link
at the top of a page. That link always opens the Help window.
• To display the standard Salesforce Help available for any custom
object record, select Open the standard Salesforce Help &
Training window.
• To display custom object-level help for your custom object,
select Open a window using a Visualforce page and then
select the Visualforce page to use as the target of the
context-sensitive help link from that custom object’s pages.

Record Name The name used in page layouts, list views, related lists, and search
results.

Data Type The type of field (text or auto-number) for the record name. Records
that have unique IDs instead of names are auto-numbered and
always a read-only field.

Display Format For an auto-numbered record name, enter the display format. You
can have up to two sets of curly braces.

Starting Number For an auto-numbered record name, enter the number to use
when creating your first record for this custom object.

Allow Reports Makes the data in the custom object records available for reporting
purposes.
To create reports on custom objects, choose the Other Reports
report type category, unless the custom object has a relationship
with a standard object. When the custom object has a master-detail
relationship with a standard object or is a lookup object on a
standard object, select the standard object for the report type
category instead.
You can still create and run reports without selecting Allow
Reports; however, the custom report type isn’t visible.

164
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Field Description
Allow Activities Allows users to associate tasks and scheduled calendar events
related to the custom object records.

Allow in Chatter Groups Allows users to add records of this custom object type to Chatter
groups.
When true, users with permissions can create records of this
object type using the group publisher. The created record is
associated with the group and appears in the group record list.
When false, users with permissions can use the group publisher
to create records of this object type, but the record isn’t associated
with the group.

Enable Divisions If your org has divisions enabled, select this option to enable the
custom object for divisions. Divisions group records for simplified
search results, list views, reports, and other areas within Salesforce.
Salesforce adds a Division field to the custom object. If the custom
object is the master in a master-detail relationship, custom objects
on the detail side also get the Division field and inherit their division
from the master record.

Available for Customer Portal Makes the custom object available to all portal users.
This option is available only if your org has a customer portal.
If you enable Digital Experiences in your org, this option no longer
appears, and all custom objects are available in your Experience
Cloud sites. If before enabling, you had a Customer Portal and
custom objects without this option selected, those objects become
available in your Customer Portal.

Track Field History Enables your org to track changes to fields on the custom object
records. For example, it tracks who changed the field value and
when, what the value was before the edit, and what it was changed
to. History data is available for reporting, so users can easily create
audit trail reports when this feature is enabled.

Allow Sharing When this setting is enabled, the custom object is an Enterprise
Application object. When this setting isn’t enabled, the custom
object is a Light Application object.
When this setting is enabled, you must also enable Allow Bulk
API Access and Allow Streaming API Access.

Allow Bulk API Access When this setting is enabled, the custom object is an Enterprise
Application object. When this setting isn’t enabled, the custom
object is a Light Application object.
When this setting is enabled, you must also enable Allow Sharing
and Allow Streaming API Access.

165
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Field Description
Allow Streaming API Access When this setting is enabled, the custom object is an Enterprise
Application object. When this setting isn’t enabled, the custom
object is a Light Application object.
When this setting is enabled, you must also enable Allow Bulk
API Access and Allow Sharing.

Deployment Status Indicates whether the custom object is visible to other users.

Allow Search To allow your users to find a custom object’s records when they
search, create a custom tab set to Default On or Default Off.
Creating a custom tab enables the custom object's Allow Search
setting.

Add Notes & Attachments... Allows users to attach notes and attachments to custom object
records. You can attach external documents to any object record
in much the same way that you can add a PDF file or photo as an
attachment to an email.
This option is available only when you’re creating an object.

Launch the New Custom Tab Wizard Starts the custom tab wizard after you save the custom object.

SEE ALSO:
Create a Custom Object

Considerations for Creating Custom Objects

Before you create a custom object, make sure that you’ve reviewed the considerations.
EDITIONS
Object Creation
Available in: both Salesforce
• Establish object relationships first before adding all custom fields, page layouts, and related
Classic (not available in all
lists.
orgs) and Lightning
• The standard Name field is required on custom object related lists and page layouts. Experience
• Provide meaningful names for your custom objects. The plural label of the custom object
Available in: Contact
is used as the label of the custom tab based on that object.
Manager, Group,
• When creating an object from a spreadsheet: Professional, Enterprise,
– Skipping the import step creates an empty custom object that uses the fields in the Performance, Unlimited,
spreadsheet as a template. and Developer Editions

– You can click to preview the object data. Only the first 24 rows of data are displayed
in preview.
– These field types aren’t supported:
• Auto Number
• Formula
• Roll-Up Summary

166
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• Lookup Relationship
• Master-Detail Relationship
• External Lookup Relationship
• Text Area (Rich)
• Text (Encrypted)
• Time

Object Permissions
In Enterprise, Unlimited, Performance, Professional, and Developer editions, when you create a custom object, the Read, Create, Edit,
and Delete permissions for that object are disabled for profiles that have View All Data or Modify All Data disabled. Enable access to
custom objects in permission sets or custom profiles, and assign them to the users who need access.
In Contact Manager and Group editions, when you create a custom object, the Read, Create, Edit, and Delete permissions for that
object are enabled for all profiles.
Sharing Model
An org-wide default setting controls the data sharing model for custom objects. For more information, see Custom Object Security.
Delegating Custom Object Administration
After you create a custom object, you can delegate its administration to non-admin users.
Queues
After you create a custom object, you can define queues to distribute ownership of custom object records to your users.

SEE ALSO:
Create a Custom Object
Salesforce Features and Edition Allocations

Modify Custom Objects

To customize the user interface for your custom objects:
EDITIONS
• Create a custom tab
• Create custom fields and relationships Available in: both Salesforce
Classic and Lightning
• Add customized buttons and links to perform actions or link to other pages or websites
Experience
• Define which fields display for users on record detail and edit pages
Available in: Contact
• Specify which fields display for users in search results, lookup dialogs, and in the key lists on
Manager, Group,
custom object tabs Professional, Enterprise,
• Create record types to display different picklist values and page layouts to different users based Performance, Unlimited,
on their profiles and Developer Editions

USER PERMISSIONS

To customize custom
objects:
• Customize Application

167
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Custom Object Standard Fields

When you create a custom object, these default fields are automatically assigned to the object.
EDITIONS
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 Available in: both Salesforce
implementations. Classic (not available in all
orgs) and Lightning
Custom object fields store the data for your custom object records. Experience
Custom Fields for Custom Objects
Available in: Contact
You can create custom fields to store information unique to your org. You can also create custom Manager, Group,
relationship fields to associate your custom object with another object in Salesforce. Professional, Enterprise,
Standard Fields for Custom Objects Performance, Unlimited,
Custom objects automatically include these standard fields. Click Edit to modify any of the Developer, and
editable fields. Database.com Editions
Divisions aren’t available in
Field Name Description Database.com.

CreatedById ID of the user who created the record.

Currency Currency of the record if multicurrency is USER PERMISSIONS

enabled.
To view and edit standard
Division Division to which the custom object record fields:
belongs. Custom objects that are “detail” objects • Customize Application
in a master-detail relationship inherit their To create custom fields:
division from the master object. Custom objects • Customize Application
that aren’t related to other records are
automatically in the global division. Available
only in orgs that use divisions to segment their
data.

LastModifiedById ID of the user who most recently changed the

record.

Name 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.

OwnerId ID of the assigned owner of the custom object

record. If the custom object becomes the detail
side of a master-detail relationship, this field is
removed, as ownership of the data is controlled
by the master object, or by the primary master
object for a custom object with two
master-detail relationships.

Note: Custom objects on the detail side

of a master-detail relationship can't have

168
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Field Name Description

sharing rules, manual sharing, or queues, as these require

the Owner field.

Delete Custom Objects

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: Salesforce
When you delete a custom object, Salesforce doesn’t add it to the Recycle Bin. Instead, deleted Classic (not available in all
orgs)
objects appear in the Deleted Objects list for 15 days. During this time, the object and its data are
soft deleted, meaning you can restore or permanently erase (hard delete) the object and its data. Available in: Contact
After 15 days, the object and its data are automatically hard deleted. Manager, Group,
Soft-deleted custom objects and their data count against your org’s limits but hard-deleted items Professional, Enterprise,
don’t. Performance, Unlimited,
Developer, and
To delete a custom object: Database.com Editions
1. From the object management settings for custom objects, click Del next to the object that you
want to delete. USER PERMISSIONS
2. When prompted, select Yes, I want to delete the custom object to confirm and click Delete.
To delete custom objects:
• Customize Application
Why Can’t I Delete a Certain Custom Object?
AND
You can’t delete a custom object if it: View All Data
• Is on the master side of a master-detail relationship.
• Contains custom fields that are used in a roll-up summary field on another object.
• Is referenced in Apex, a Visualforce page, or a reporting snapshot.
• Is referenced by a duplicate rule or a matching rule.
• Contains more than 100,000 records. If the object you want to delete has more than 100,000 records, first delete an appropriate
number of records and then delete the object.

Results of Deleting Custom Objects

When you delete a custom object, Salesforce:
• Displays an Insufficient Privileges message if someone clicks a bookmark to a deleted custom object record’s URL.
• Removes the object from AppExchange packages.
• Changes the master-detail relationship to a lookup relationship if the deleted object is on the detail side of a master-detail relationship.
• Removes or erases:
– The object’s custom tab
– List views and workflow rules for the object
– Mobile configuration settings including data sets, mobile views, and excluded fields
– Standard report types associated with the object, and reports based on standard report types if the deleted object is on the
detail side of a master-detail relationship

169
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• Hides, inactivates, or disables:

– The custom object definition and related definitions
– The object’s records and related records, including any records in the Recycle Bin
– Custom report types where the deleted object is the main object
– Custom reports where the deleted object is the main object
– Custom formula fields on the object
– Custom validation rules and approval processes on the object

Note: To restore many removed, hidden, inactive, or disabled items, you can undelete the custom object. See Manage Deleted
Custom Objects for information about restoring deleted custom objects.

Results of Hard Deleting Custom Objects

When a custom object is hard deleted, either manually, or automatically after 15 days:
• The custom object’s definition and data are permanently deleted and can’t be restored.
• The custom object and its data no longer count against your org’s limits.
• If the deleted object is on the detail side of a master-detail relationship, master records currently in the Recycle Bin aren’t restorable
if one or more detail records were automatically deleted as a result of the master record being deleted. Attempting to undelete the
master record results in an error.

Note: This only happens when the deleted detail records have their custom object definition hard deleted while the master
record is in the Recycle Bin.

SEE ALSO:
Manage Deleted Custom Objects
Find Object Management Settings
Delete a Big Object

170
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Manage Deleted Custom Objects

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: Salesforce
Deleted custom objects appear in the Deleted Objects list for 15 days. During this time, you can Classic (not available in all
orgs)
choose to permanently delete the object and its data, or you can undelete them. If you undelete
a custom object, you might need to do some manual cleanup to restore list views and other Available in: Contact
customizations that use the object. Manager, Group,
• To view a list of deleted custom objects: Professional, Enterprise,
Performance, Unlimited,
1. Go to the object management settings for custom objects. Developer, and
2. Click Deleted Objects at the bottom of the list. Database.com Editions

The Deleted Objects link appears only when you have at least one deleted custom object in
your organization. The number in parentheses indicates the total number of deleted custom USER PERMISSIONS
objects.
To restore deleted custom
• In the Deleted Objects list, you can do any of the following: objects:
• Customize Application
– Click the object’s label to view details about it
– Click Erase to permanently remove the object and its data To permanently delete
custom objects:
– Click Undelete to restore the object and its data • Customize Application

Results of Hard Deleting Custom Objects

When a custom object is hard deleted, either manually, or automatically after 15 days:
• The custom object’s definition and data are permanently deleted and can’t be restored.
• The custom object and its data no longer count against your org’s limits.
• If the deleted object is on the detail side of a master-detail relationship, master records currently in the Recycle Bin aren’t restorable
if one or more detail records were automatically deleted as a result of the master record being deleted. Attempting to undelete the
master record results in an error.

Note: This only happens when the deleted detail records have their custom object definition hard deleted while the master
record is in the Recycle Bin.

Limitations for Restoring Truncated Custom Objects

Copies of truncated custom objects also appear in the list of deleted objects. Truncated custom objects can’t be restored to their original
state. Undeleted copies of truncated objects have a new name and new URL, and some fields and data cannot be manually restored.

Restoring a Custom Object to Its Predeleted State

When you restore a deleted custom object, its records are also undeleted, including any that were in the Recycle Bin.

Note: It might take several hours before you can search the undeleted object’s records.

To ensure that you return the object to its fully functional, predeleted state, check all affected conditions and customizations, and
manually fix them if necessary.

171
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

AppExchange packages
Add the custom object to any appropriate AppExchange packages.
Custom tabs
Re-create a custom tab for the object and add it to any custom apps that use it.
List views, reports, and workflow rules
Re-create them.
Validation rules and approval processes
Reactivate them.
Formula fields
Open and save any custom formula fields on the object to re-enable them.
Page layouts
Page layouts are restored automatically on the undeleted object. Page layouts are also restored automatically on other objects that
use the page layout in a related list—as long as the page layout wasn’t edited while the object was deleted. Otherwise, you have
to add the related list back to the other object.
Custom report types
For custom report types where the deleted object wasn’t the main object, add the reference back to the restored object. Reports
based on the custom report type are automatically restored if they weren’t edited while the object was deleted. Re-create any reports
that have been edited.
Relationships
If the deleted custom object was on the detail side of a master-detail relationship, Salesforce converted it to a lookup relationship.
Change it back to master-detail.
Developer name
The developer name for the object was changed to objectname_del. Change it back to the original name, objectname_c,
so that customizations using the name will work properly.
Deployment status
When the custom object was deleted, its Deployment Status field was set to In Development. When you’ve restored all
affected customizations to the undeleted object, change its status back to Deployed.

SEE ALSO:
Delete Custom Objects
Considerations for Truncating Custom Objects
Find Object Management Settings

172
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Considerations for Truncating Custom Objects

It’s important to understand what truncating an object does before using it to remove records.
EDITIONS
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 Available in: both Salesforce
implementations. Classic (not available in all
orgs) and Lightning
Truncating a custom object lets you remove all of the object’s records, while keeping the object Experience
and its metadata. Truncating custom objects is similar to the mass delete option available for
standard objects. Available in: Contact
Manager, Group,
Truncating a custom object permanently removes all of its records. You can’t recover the records Professional, Enterprise,
from the Recycle Bin. A copy of the truncated object appears in the Deleted Objects list for 15 Performance, Unlimited,
days—during this period the object and its records continue to count toward your organization’s Developer, and
limits—and then the copied object and its records are permanently deleted. Database.com Editions
In contrast, if you delete a custom object, the object moves to the Deleted Objects list for 15 days.
After that the object and its records are permanently deleted.

Important: Truncated custom objects can’t be restored to their original state.

You can’t truncate standard objects or custom objects that:

• Are referenced by another object through a lookup field or that are on the master side of a master-detail relationship
• Are referenced in a reporting snapshot
• Have a custom index or an external ID
• Have activated skinny tables
In addition, you can’t truncate custom objects when your org has reached its limit on allowed custom objects.
Truncating a custom object erases:
• All records currently sitting in the custom object’s Recycle Bin
• The custom object’s history
• Related events, tasks, notes, and attachments for each deleted record
Truncating a custom object breaks:
• Bookmarks to the truncated objects and its records. If someone clicks a bookmark to the truncated custom object or to a deleted
record’s URL, Salesforce displays an Insufficient Privileges message.
• Apex scripts and Visualforce pages with references to a truncated object or record.
After truncating a custom object, you can continue to use the custom object and add new records. Salesforce preserves:
• The custom object definition and all related definitions
• Workflow rules, actions, and triggers
• Sharing rules associated with the custom object
• Validation rules and approval processes
• Master-detail relationships and formula fields
• Translations
• Mobile configuration settings
When working with truncated objects, keep in mind:
• The truncated object tab has a new URL, so new bookmarks need to be created.

173
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• List views and reports need to be refreshed after truncation.

• Roll-up summary fields need to be recalculated after truncation.
• There’s no support for truncation in the API.
• To truncate objects that contain master-detail relationships, first truncate the detail (child) objects and then the (master) parent
objects, working your way up the relationship tree.

SEE ALSO:
Truncate Custom Objects
Manage Deleted Custom Objects

Truncate Custom Objects

Truncating custom objects allows you to delete all of the object’s records permanently, but preserve
EDITIONS
the empty object and its metadata.

Important: Truncating custom objects causes some irreversible changes to the truncated Available in: Salesforce
object and its records. Before truncating, see Truncating Custom Objects. Then, enable it for Classic (not available in all
orgs)
your organization by entering User Interface in the Quick Find box, selecting User
Interface, and then selecting the permission. Available in: Contact
Truncating custom objects is a way to permanently remove all of the records from a custom object, Manager, Group,
while keeping the object and its metadata intact for future use. Truncating is useful, for example, Professional, Enterprise,
if you’ve created a custom object and filled it with test records. When you’re done with the test Performance, Unlimited,
Developer, and
data, you can truncate the object to purge the test records, but keep the object and put it into
Database.com Editions
production. This is much faster than batch-deleting records and possibly recreating the object.
1. Go to the object management settings for custom objects.
USER PERMISSIONS
2. Click an object name to go to the object’s detail page, and then click Truncate.
3. In the Confirm Custom Object Truncate window, review the warning, then enter the name of To truncate custom objects:
the object to truncate in the empty field. • Customize Application

4. Click Truncate.

SEE ALSO:
Manage Deleted Custom Objects
Find Object Management Settings

174
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Track Your Organization’s Custom Object Usage by User License Type

To keep track of how many custom objects your users are assigned to, create a custom report type
EDITIONS
with the User Licenses and Custom Object Usage by User License Metrics objects.
1. From Setup, enter Report Types in the Quick Find box, then select Report Types. Available in: both Salesforce
Classic (not available in all
2. Click New Custom Report Type.
orgs) and Lightning
3. Fill out the fields. Experience

Custom objects are

For this field... Enter or select...
available in: Contact
Primary Object User Licenses Manager, Group,
Professional, Enterprise,
Report Type Label A label for this report type. The label appears Performance, Unlimited,
when users create a report. and Developer Editions
For example, Custom Object Usage Custom report types are
by User License. available in: Professional,
Enterprise, Performance,
Report Type Name A unique name for this report type. Unlimited, and Developer
Editions
Description A description for this report type. This
description appears when users create a
report. USER PERMISSIONS
Store in Category Other Reports
To create or update custom
report types:
• Manage Custom Report
4. (Optional) To make this report type available to other users, select a Deployment Status of Types
Deployed. To delete custom report
types:
5. Click Next.
• Modify All Data
6. Click the box under the primary object.
7. Select Custom Object Usage by User License Metrics.
8. Click Save.
9. Create a report using the new report type.

Manage Big Objects

A big object stores and manages massive amounts of data on the Salesforce platform. You can archive data from other objects or bring
datasets from outside systems into a big object to get a full view of your customers. From Setup, you can create a custom big object
and define its fields and index.

Available in: both Salesforce Classic and Lightning Experience

Available in: Enterprise, Performance, Unlimited, and Developer Editions for up to 1 million records
Additional record capacity and Async SOQL query available as an add-on license.

From Setup, enter Big Objects in the Quick Find box, then select Big Objects. From this page you can:

175
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• Create a big object.

• View and update details about a big object.
• Delete a big object or view any big objects that were deleted in the last 15 days.

Create or Edit a Big Object

Track and store big data that’s unique to your org. For existing big objects, a details page shows information about the big object’s
fields and index.

SEE ALSO:
Salesforce Developers: Big Objects Implementation Guide

Create or Edit a Big Object

Track and store big data that’s unique to your org. For existing big objects, a details page shows information about the big object’s fields
and index.
Before you create a big object, make sure that you understand the restrictions on updating and deleting fields for big objects described
in Changing Big Object Fields.
1. From Setup, in the Quick Find box, enter Big Objects, and then select Big Objects.
2. Click New or click an existing big object.
3. Add or edit details about the big object.
4. Add or edit custom fields. Custom fields store the data for your big object records.
5. Add an index. The index defines the composite primary key for a big object and is used to query and filter the big object data.
6. Save the big object.
After you create an index and deploy a big object, you can’t edit or delete the index. To change the index, you must start over with a
new big object.

Big Object Definition Details

When you create a custom big object, several required fields define how you can access the big object.
Custom Big Object Fields
Custom fields store the data for your custom big object records.
Considerations When Creating an Index
Plan carefully when creating an index for your custom big object. The index is used for querying and filtering the big object data
and must be designed properly.
Add an Index to a Big Object
The index defines the composite primary key for a custom big object and is used for querying and filtering the big object data. Each
big object requires an index.
Changing Big Object Fields
Learn how big object fields differ from standard object fields when you update or delete them. Make sure that your big object is
correct before you save it.

176
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Delete a Big Object

When you delete a custom big object, Salesforce doesn’t add it to the Recycle Bin. Instead, deleted big objects appear in the Deleted
Objects list for 15 days. During this time, the big object and its data are soft deleted, meaning you can restore or permanently erase
(flag for hard delete) the big object and its data. After 15 days, the big object and its data are automatically flagged for hard delete.

Big Object Definition Details

When you create a custom big object, several required fields define how you can access the big object.
The big object definition details page displays information about the big object’s fields and index.

Field Name Description

Label This name is used to refer to the object in a user interface page.

Plural Label The plural name of the object.

Starts with a vowel sound If it’s appropriate for your organization’s default language, indicate whether “an” or “a” precedes
the label.

Object Name A unique name used to refer to the object when using the API. In managed packages, this name
prevents naming conflicts with package installations. Use only alphanumeric characters and
underscores. The name must begin with a letter and have no spaces. It cannot end with an
underscore nor have two consecutive underscores.
In the API, the names of custom big objects have a suffix of two underscores immediately
followed by a lowercase “b” (__b). For example, a big object named “HistoricalInventoryLevels”
is seen as HistoricalInventoryLevels__b in that organization's WSDL.

Description An optional description of the object. A meaningful description helps you remember the
differences between objects when you are viewing them in a list.

Context-Sensitive Help Setting Defines the URL that displays when a user clicks Help for this Page from the object record’s
home (overview), edit, and detail pages, list views, and related lists. This setting doesn’t affect
the Help link at the top of a page. That link always opens the Help window.
• To display the standard Salesforce Help available for any custom object record, select Open
the standard Salesforce Help & Training window.
• To display custom object-level help for your custom object, select Open a window using
a Visualforce page and then select the Visualforce page to use as the target of the
context-sensitive help link from that custom object’s pages.

Deployment Status When you create a big object, the status is set to In Development. You can't deploy a big object
until it includes an index that contains at least one custom field. Only required custom fields are
allowed in an index. After you create an index, you see a second status of Deployed. Once you’re
ready to grant users access, change the status to Deployed.

Custom Big Object Fields

Custom fields store the data for your custom big object records.

177
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Custom Fields for Big Objects

Create custom fields to store information unique to your org. You can also create custom relationship fields to associate your big object
with another object in Salesforce. Big objects support these field types:
• Lookup Relationship
• Date/Time
• Email
• Number
• Phone
• Text
• Text Area (Long)
• URL
To create an index for your big object, at least one custom field must be marked as required.

Standard Fields for Big Objects

Currently, big objects don’t include standard fields.

SEE ALSO:
Create Custom Fields

Considerations When Creating an Index

Plan carefully when creating an index for your custom big object. The index is used for querying and filtering the big object data and
must be designed properly.
Keep these considerations in mind when creating the index.
• An index must include at least one custom field and can have up to five custom fields total.
• All custom fields that are part of the index must be marked as required.
• You can’t include Long Text Area and URL fields in the index.
• The total number of characters across all text fields in an index can’t exceed 100.

Note: Email fields are 80 characters. Phone fields are 40 characters. Keep these lengths in mind when designing your index
because they count toward the 100 character limit.

• After you’ve created the index, you can’t edit or delete it. To change the index, you must start over with a new big object.
• Design your index so that you assign the most frequently used field in a query filter to Index Position 1. The order in which you define
the fields determines the order that they’re listed in the index.

Add an Index to a Big Object

The index defines the composite primary key for a custom big object and is used for querying and filtering the big object data. Each big
object requires an index.
To create an index, you must have at least one required custom field defined on the big object. See Considerations When Creating an
Index on page 178 for more details.
1. From the Index section of a big object detail page, click New. This button displays only if the big object has at least one required
custom field.

178
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

2. Add a Label and Name for the index.

Warning: 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.

3. For each custom field listed, set the Index Position and Index Direction. The order in which you define the fields determines the order
that they’re listed in the index. Set the Index Position to 1 for the most frequently used filter parameter.

4. Save the index.

Changing Big Object Fields

Learn how big object fields differ from standard object fields when you update or delete them. Make sure that your big object is correct
before you save it.

Updating Fields for Big Objects

If a field has an existing value, you can update it with a different value. You can’t update it with a NULL value. You can delete a record
and recreate it if you want to change the value to NULL.
Most properties cause data mutation. You can’t change big object field properties that cause data mutation and you can’t edit the
properties after you create an object. Properties that don’t cause data mutation are related to information about the data, such as labels
or help text.

Deleting Fields for Big Objects

You can’t delete an individual field after the object is created. So if you want to delete a field from a Big Object, delete the object and
then recreate it.

179
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Delete a Big Object

When you delete a custom big object, Salesforce doesn’t add it to the Recycle Bin. Instead, deleted big objects appear in the Deleted
Objects list for 15 days. During this time, the big object and its data are soft deleted, meaning you can restore or permanently erase (flag
for hard delete) the big object and its data. After 15 days, the big object and its data are automatically flagged for hard delete.
Salesforce runs a background job to completely remove big objects that have been flagged for hard-delete from your org. The job
doesn’t run immediately, but you can’t access these large objects because they no longer appear in the Deleted Objects list.
Soft-deleted big objects and their data always count against your org’s limits. Big objects that are flagged for hard delete, but the
background job hasn’t yet removed, also count. After the background job removes these big objects, they no longer count against your
org’s limit.
1. From Setup, enter Big Objects in the Quick Find box, then select Big Objects.
2. Click Del next to the object that you want to delete.
3. When prompted, select the Yes, I want to delete the Big Object checkbox to confirm and click Delete.
The big object is soft deleted and remains in the Deleted Objects list for 15 days.
4. To permanently erase (flag for hard-delete) the big object, click Deleted Big Object.
5. Click Erase next to the big object you want to permanently erase.
6. When prompted, select the Yes, I want to permanently delete the Big Object checkbox to confirm and click Delete.
The big object is flagged for hard-delete and can no longer be restored.

Object Relationships Overview

Create relationships to link objects with each other, so that when your users view records, they can
EDITIONS
also see related data. For example, link a custom object called Bugs to cases to track product defects
that are associated with customer cases. Available in: Salesforce
Important: Where possible, we changed noninclusive terms to align with our company Classic (not available in all
orgs) and Lightning
value of Equality. We maintained certain terms to avoid any effect on customer
Experience
implementations.
You can define different types of relationships by creating custom relationship fields on an object. Available in: Contact
Before you begin creating relationships, determine the type of relationship that suits your needs. Manager, Group,
Professional, Enterprise,
Different types of relationships between objects in Salesforce determine how they handle data Performance, Unlimited,
deletion, sharing, and required fields in page layouts. Let’s review the types of relationships. Developer, and
Master-detail Database.com Editions
Closely links objects together such that the master record controls certain behaviors of the
detail and subdetail record. For example, you can define a two-object master-detail relationship,
such as Account—Expense Report that extends the relationship to subdetail records, such as Account—Expense Report—Expense
Line Item. You can then perform operations across the master—detail—subdetail relationship.

Tip: Create a master-detail relationship before a custom object contains data.

Behaviors of master-detail relationships:

• Deleting a detail record moves it to the Recycle Bin and leaves the master record intact; deleting a master record also deletes
related detail and subdetail records. Undeleting a detail record restores it, and undeleting a master record also undeletes related
detail and subdetail records. However, if you delete a detail record and later separately delete its master record, you can’t undelete
the detail record, as it no longer has a master record to relate to.

180
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• By default, records can’t be reparented in master-detail relationships. Administrators can, however, allow child records in
master-detail relationships on custom objects to be reparented to different parent records by selecting the Allow reparenting
option in the master-detail relationship definition.
• The Owner field on the detail and subdetail records isn’t available and is automatically set to the owner of the master record.
Custom objects on the detail side of a master-detail relationship can't have sharing rules, manual sharing, or queues, as these
require the Owner field.
• Detail and subdetail records inherit security settings and permissions from the master record. You can’t set permissions on the
detail record independently.
• The master-detail relationship field (which is the field linking the objects) is required on the page layout of the detail and subdetail
records.
• The master object can be a standard object, such as Account or Opportunity, or a custom object.
• As a best practice, don’t exceed 10,000 child records for a master-detail relationship.
• Each custom object can have up to two master-detail relationships and up to 40 total relationships.
• The Related To entry can’t be changed after you save the relationship.
• A profile or a permission set can have an entity, such as Account, with a master-detail relationship. A broken permission dependency
exists if the child entity has permissions that the parent should have. Salesforce updates the parent entity for a broken permission
dependency on the first save action for the profile or permission set.

If the child entity has these permissions These permissions are enabled on the parent entity
Modify All OR View All View All

View All OR Read Read

Many-to-many
You can use master-detail relationships to model many-to-many relationships between any two objects. A many-to-many relationship
allows each record of one object to be linked to multiple records from another object and vice versa. For example, you create a
custom object called Bug that relates to the standard case object such that a bug could be related to multiple cases and a case could
also be related to multiple bugs.
Lookup
Links two objects together. Lookup relationships are similar to master-detail relationships, except they don’t support sharing or
roll-up summary fields. With a lookup relationship, you can:
• Link two different objects.
• Link an object with itself (except for the user object; see Hierarchical on page 182). For example, link a custom object called Bug
with itself to show how two different bugs are related to the same problem.

Note: Lookup relationships from objects related to the campaign member object aren’t supported; however, you can create
lookup relationships from the campaign member object related to other objects.
When you create a lookup relationship, you can set these options:
• Make the lookup field required for saving a record, requiring it on the corresponding page layout as well.
• If the lookup field is optional, you can specify one of three behaviors to occur if the lookup record is deleted:
– Clear the value of this field This is the default. Clearing the field is a good choice when the field doesn’t have to contain
a value from the associated lookup record.
– Don’t allow deletion of the lookup record that’s part of a lookup relationship If you have dependencies built on the
lookup relationship, such as a workflow rule, this option doesn’t allow the lookup record to be deleted.

181
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Note: Deleting a record that has child records isn’t allowed, except when the child records are soft-deleted (sent to
the Recycle Bin). If all the child records of a parent record are soft-deleted, then the parent record is deleted. Furthermore,
any soft-deleted children are then removed from the recycle bin and permanently deleted.

– Delete this record also Available only if a custom object contains the lookup relationship, not if it’s contained by a standard
object. However, the lookup object can be either standard or custom. Choose when the lookup field and its associated record
are tightly coupled and you want to completely delete related data. For example, say that you have an expense report record
with a lookup relationship to individual expense records. When you delete the report, you probably want to delete all the
expense records, too.

Warning: Choosing Delete this record also can result in a cascade-delete. A cascade-delete bypasses security and
sharing settings, which means users can delete records when the target lookup record is deleted even if they don’t have
access to the records. To prevent records from being accidentally deleted, cascade-delete is disabled by default. Contact
Salesforce to get the cascade-delete option enabled for your org.
Cascade-delete and its related options aren’t available for lookup relationships to business hours, network, lead, price
book, product, or user objects.

When you define a lookup relationship, you can include a lookup field on the page layouts for that object and create a related list
on the associated object's page layouts. For example, if you have a custom object called PTO Requests and you want your users to
link a PTO request with the employee submitting the request, create a lookup relationship from the PTO Request custom object
with the user object.
If the parent record in a lookup relationship is deleted, the field history tracking for the child record doesn't record the deletion. For
example, if a parent account is deleted, the Account History related list for the child account doesn’t show the deletion.
You can't delete an object or record in a lookup relationship if the combined number of records between the two linked objects is
more than 100,000. To delete an object or record in a lookup relationship, first delete an appropriate number of its child records.
When you delete an object used by a lookup field, delete the field, too. To delete both the object and the field, use the Metadata
API with a delete manifest that uses purgeOnDelete. Or, use Setup in the UI to delete the field first. Otherwise, the object can’t
be deleted.
External lookup
An external lookup relationship links a child standard, custom, or external object to a parent external object. When you create an
external lookup relationship field, the standard External ID field on the parent external object is matched against the values of the
child’s external lookup relationship field. External object field values come from an external data source.
Indirect lookup
An indirect lookup relationship links a child external object to a parent standard or custom object. When you create an indirect
lookup relationship field on an external object, you specify the parent object field and the child object field to match and associate
records in the relationship. Specifically, you select a 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.
Hierarchical
A special lookup relationship available for only the user object. It lets users use a lookup field to associate one user with another that
doesn’t directly or indirectly refer to itself. For example, you can create a custom hierarchical relationship field to store each user's
direct manager.

Tip: When creating a hierarchical field in Personal, Contact Manager, Group, and Professional Editions, you can select the
Restricted Field checkbox so that only users with the Manage Internal Users permission can edit it. In Professional, Enterprise,
Unlimited, Performance, and Developer Edition, use field-level security instead.

Create a Many-to-Many Object Relationship

182
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Considerations for Object Relationships

Review these considerations before creating relationships between objects.

SEE ALSO:
Considerations for Object Relationships
External Object Relationships
Create a Many-to-Many Object Relationship
Create a Custom Object

Create a Many-to-Many Object Relationship

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
You can use master-detail relationships to model many-to-many relationships between any two Classic (not available in all
orgs) and Lightning
objects. A many-to-many relationship allows each record of one object to be linked to multiple
Experience
records from another object and vice versa. For example, you create a custom object called Bug
that relates to the standard case object such that a bug could be related to multiple cases and a Available in: Contact
case could also be related to multiple bugs. When modeling a many-to-many relationship, you use Manager, Group,
a junction object to connect the two objects you want to relate to each other. Professional, Enterprise,
Performance, Unlimited,
Junction Object
Developer, and
A custom object with two master-detail relationships. Using a custom junction object, you can
Database.com Editions
model a “many-to-many” relationship between two objects. For example, you create a custom
object called “Bug” that relates to the standard case object such that a bug could be related to Reports aren’t available in
multiple cases and a case could also be related to multiple bugs. Database.com.

Creating the many-to-many relationship consists of:

1. Creating the junction object. USER PERMISSIONS
2. Creating the two master-detail relationships. To create a many-to-many
3. Customizing the related lists on the page layouts of the two master objects. relationship:
• Customize Application
4. Customizing reports to maximize the effectiveness of the many-to-many relationship.

Creating the Junction Object

1. Create a custom object to be your junction object.
2. In the custom object wizard, consider these tips specifically for junction objects:
• Name the object with a label that indicates its purpose, such as BugCaseAssociation.
• For the Record Name field, we recommend that you use the auto-number data type.
• Don’t launch the custom tab wizard before clicking Save. Junction objects don’t need a tab.

Creating the Two Master-Detail Relationships

To create the two master-detail relationships:
1. Verify that the two objects you want to relate to each other already exist. For example, you may want to relate the standard case
object to a custom bug object.

183
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

2. On the junction object, create the first master-detail relationship field. In the custom field wizard:
a. Choose Master-Detail Relationship as the field type.
b. Select one of the objects to relate to your junction object. For example, select Case.
The first master-detail relationship you create on your junction object becomes the primary relationship. This affects the following
for the junction object records:
• Look and feel: The junction object's detail and edit pages use the color and any associated icon of the primary master object.
• Record ownership: The junction object records inherit the value of the Owner field from their associated primary master
record. Because objects on the detail side of a relationship don’t have a visible Owner field, this is only relevant if you later
delete both master-detail relationships on your junction object.
• Division: If your org uses divisions to segment data, the junction object records inherit their division from their associated
primary master record. Similar to the record ownership, this is only relevant if you later delete both master-detail relationships.

c. Select a Sharing Setting option. For master-detail relationship fields, the Sharing Setting attribute determines the sharing access
that users must have to a master record to create, edit, or delete its associated detail records.
d. For the Related List Label that will display on the page layout of the master object, don’t accept the default. Change this to use
the name of the other master object in your many-to-many relationship. For example, change this to Bugs so users see a Bugs
related list on the case detail page.

3. On the junction object, create the second master-detail relationship. In the custom field wizard:
a. Choose Master-Detail Relationship as the field type.
b. Select the other desired master object to relate to your junction object. For example, select Bug.
The second master-detail relationship you create on your junction object becomes the secondary relationship. If you delete the
primary master-detail relationship or convert it to a lookup relationship, the secondary master object becomes primary.

c. Select a Sharing Setting option. For master-detail relationship fields, the Sharing Setting attribute determines the sharing access
that users must have to a master record to create, edit, or delete its associated detail records.
d. For the Related List Label that will display on the page layout of the master object, don’t accept the default. Change this to use
the name of the other master object in your many-to-many relationship. For example, change this to Cases so users see a
Cases related list on the bug detail page.

Customizing Many-to-Many Relationship Related Lists

For a many-to-many relationship in Salesforce, each master object record displays a related list of the associated junction object records.
To create a seamless user experience, you can change the name of the junction object related list on each of the master object page
layouts to have the name of the other master object. For example, you might change the BugCaseAssociations related list to Cases
on the bugs page layout and to Bugs on the cases page layout. You can further customize these related lists to display fields from the
other master object.
To customize the fields that display in the junction object related list on each master object page layout:
1. Edit the page layout of each master object that is related to the junction object. For example, modify the BugCaseAssociations related
list for case records by editing the page layout for cases.
2. Edit the properties of the related list you want to modify. For example, on cases the BugCaseAssociations related list was renamed
to Bugs, so select the Bugs related list.
3. Add the fields to display in the related list. You can add fields from the junction object itself, but more importantly, you can add fields
from the other master object.

184
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Each field is prefixed with its object name in the window. In the related list itself, only fields from the junction object are prefixed
with the object name; fields from the other master object aren’t.

Note: The junction object related list doesn’t include an icon on the master record's detail pages because the junction object
doesn’t have a custom tab. If you make a tab for the junction object, the icon is included.

Customizing Reports for Many-to-Many Relationships

Many-to-many relationships provide two standard report types that join the master objects and the junction object. The report types
are:
• “Primary master with junction object and secondary master” in the primary master object's report category.
• “Secondary master with junction object and primary master” in the secondary master object's report category.
The order of the master objects in the report type is important. The master object listed first determines the scope of records that can
be displayed in the report.
You can create custom reports based on these standard report types. In addition, you can create custom report types to customize which
related objects are joined in the report.

SEE ALSO:
Find Object Management Settings
Object Relationships Overview
Considerations for Object Relationships
Create a Custom Object
Find Object Management Settings

Considerations for Object Relationships

Review these considerations before creating relationships between objects.
EDITIONS
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 Available in: both Salesforce
implementations. Classic () not available in all
orgs and Lightning
Relationship Limits Experience
Each custom object can have up to two master-detail relationships and many lookup
relationships. Each relationship is included in the maximum number of custom fields allowed. Available in: Contact
Manager, Group,
Converting Relationships Professional, Enterprise,
You can convert a master-detail relationship to a lookup relationship as long as no roll-up Performance, Unlimited,
summary fields exist on the master object. Developer, and
Converting a master-detail relationship to a lookup for a custom object on the “detail” side, Database.com Editions
changes the organization-wide default for the object to public read/write. Salesforce Connect external
You can convert a lookup relationship to a master-detail relationship if the lookup field in all objects are available in:
the records contains a value. Developer Edition and for
an extra cost in: Enterprise,
A lookup relationship can’t be changed to a master-detail relationship if the organization-wide Performance, and
default of the child object access level in the relationship is Controlled by Parent. Unlimited Editions
Converting a lookup to a master-detail-relationship changes the organization-wide default to
Controlled by Parent and the sharing model is updated to public read/write.

185
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Self-Relationships
You can create a relationship from an object to itself, but it must be a lookup relationship, and a single record can't be linked to itself.
However, a record can indirectly relate to itself. For example, the Holiday Promotion campaign can select the Direct Mail campaign
in the lookup relationship, and the Direct Mail campaign can select the Holiday Promotion campaign in the lookup relationship.
You can't create a many-to-many self-relationship, that is, the two master-detail relationships on the junction object can't have the
same master object.
Icons for Custom Related Lists
The icon you select for the associated custom tab also displays in any custom-related list you create based on a relationship.
Custom related lists don’t include an icon if they’re based on a relationship with a custom object that doesn't have a custom tab.
Master-Detail Relationships
To create multilevel master-detail relationships, you need the Customize Application user permission.
When you define a master-detail relationship, the custom object on which you're working is the detail side. Its data appears as a
custom related list on page layouts for the other object.
By default, records can’t be reparented in master-detail relationships. Administrators can, however, allow child records in master-detail
relationships on custom objects to be reparented to different parent records by selecting the Allow reparenting option in the
master-detail relationship definition.
You can have up to three custom detail levels.
Standard objects can't be on the detail side of a custom object in a master-detail relationship.
An object can appear one time in multilevel master-detail relationships. For example, a subdetail object in one multilevel master-detail
relationship can't also be the owner of the master object in another multilevel master-detail relationship. A subdetail object can't
also be the master object of the subdetail object’s detail object.
Multilevel master-detail relationships don’t support division transfers.
You can't create a master-detail relationship if the custom object already contains data. You can, however, create the relationship
as a lookup and then convert it to master-detail if the lookup field in all records contains a value.
Converting relationships from lookup to master-detail, or from master-detail to lookup behaves the same as for two-object master-detail
relationships. That is, the two linked objects in the detail-subdetail1, or subdetail1-subdetail2 relationship have the same conversion
limits as the master-detail relationship.
Roll-up summary fields work as in two-object master-detail relationships. A master can roll up fields on detail records; however, it
can't directly roll up fields on subdetail records. The detail record must have a roll-up summary field for the field on the subdetail
record, allowing the master to roll up from the detail's roll-up summary field.
You can use multilevel master-detail relationships in custom report types. The Allow Reports checkbox must be selected when you
create the custom object. Custom report types created for multilevel master-detail relationships count toward the organization’s
custom report type limit, and no reports generate if this limit is exceeded.
Custom junction objects can’t have detail objects. That is, a custom junction object can’t become the master object in a multilevel
master-detail relationship.
You can't delete a custom object if it is on the master side of a master-detail relationship. If you delete a custom object that is on
the detail side of a master-detail relationship, the relationship is converted to a lookup relationship.
Deleting a detail record moves it to the Recycle Bin and leaves the master record intact; deleting a master record also deletes related
detail and subdetail records. Undeleting a detail record restores it, and undeleting a master record also undeletes related detail and
subdetail records. However, if you delete a detail record and later separately delete its master record, you can’t undelete the detail
record, as it no longer has a master record to relate to.
A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following
cases.

186
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

• 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.
• 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.
As a best practice, don't exceed 10,000 child records for a master-detail relationship.
A profile or a permission set can have an entity, such as Account, with a master-detail relationship. A broken permission dependency
exists if the child entity has permissions that the parent should have. Salesforce updates the parent entity for a broken permission
dependency on the first save action for the profile or permission set.

If the child entity has these permissions These permissions are enabled on the parent entity
Modify All OR View All View All

View All OR Read Read

Many-to-Many Relationships
Junction object records are deleted when either associated master record is deleted and placed in the Recycle Bin. If both associated
master records are deleted, the junction object record is deleted permanently and can't be restored.
Sharing access to a junction object record is determined by a user's sharing access to both associated master records and the Sharing
Setting option on the relationship field. See Custom Object Security on page 191. For example, if the sharing setting on both parents
is Read/Write, then the user must have Read/Write access to both parents in order to have Read/Write access to the junction object.
If the sharing setting on both masters is Read-Only, a user with Read-Only rights on the master records would have Read access to
the junction object.
In a many-to-many relationship, a user can't delete a parent record if there are more than 200 junction object records associated
with it and if the junction object has a roll-up summary field that rolls up to the other parent. To delete this object, manually delete
junction object records until the count is fewer than 200.
The first master-detail relationship you create on your junction object becomes the primary relationship. This affects the following
for the junction object records:
• Look and feel: The junction object's detail and edit pages use the color and any associated icon of the primary master object.
• Record ownership: The junction object records inherit the value of the Owner field from their associated primary master record.
Because objects on the detail side of a relationship don’t have a visible Owner field, this is only relevant if you later delete both
master-detail relationships on your junction object.
• Division: If your organization uses divisions to segment data, the junction object records inherit their division from their associated
primary master record. Similar to the record ownership, this is only relevant if you later delete both master-detail relationships.
The second master-detail relationship you create on your junction object becomes the secondary relationship. If you delete the
primary master-detail relationship or convert it to a lookup relationship, the secondary master object becomes primary.
Roll-up summary fields that summarize data from the junction object can be created on both master objects.
Formula fields and validation rules on the junction object can reference fields on both master objects.
You can define Apex triggers on both master objects and the junction object.
A junction object can't be on the master side of another master-detail relationship.
You can't create a many-to-many self-relationship, that is, the two master-detail relationships on the junction object can't have the
same master object.

187
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Lookup Relationships
If the lookup field is optional, you can specify one of three behaviors to occur if the lookup record is deleted:
• Clear the value of this field—This is the default. Clearing the field is a good choice when the field doesn’t have to contain a value
from the associated lookup record.
• Don’t allow deletion of the lookup record that’s part of a lookup relationship—If you have dependencies built on the lookup
relationship, such as a workflow rule, this option doesn’t allow the lookup record to be deleted.

Note: Deleting a record that has child records isn’t allowed, except when the child records are soft-deleted (sent to the
Recycle Bin). If all the child records of a parent record are soft-deleted, then the parent record is deleted. Furthermore, any
soft-deleted children are then removed from the recycle bin and permanently deleted.

• Delete this record also—Available only if a custom object contains the lookup relationship, not if it’s contained by a standard
object. However, the lookup object can be either standard or custom. Choose when the lookup field and its associated record
are tightly coupled and you want to completely delete related data.

Warning: Choosing Delete this record also can result in a cascade-delete. A cascade-delete bypasses security and
sharing settings, which means users can delete records when the target lookup record is deleted even if they don’t have
access to the records. To prevent records from being accidentally deleted, cascade-delete is disabled by default. Contact
Salesforce to get the cascade-delete option enabled for your organization.
Cascade-delete and its related options aren’t available for lookup relationships to business hours, network, lead, price book,
product, or user objects.

In a chain of lookup relationships, these behaviors work independently on each target field at each level. Say, for example, field A is
the target lookup of field B, which in turn is the target lookup of field C. You can have a delete restriction on A and none on B, which
means that A can't be deleted but B can. After B is deleted, the relationship between A and B no longer exists and C holds an empty
value for the lookup.
In a multilevel lookup relationship, these options can conflict. For example, if field A is the target lookup of field B, which in turn is
the target lookup of field C, you can specify that A deletes B, but B can’t be deleted because it’s in a relationship with C. If you try to
delete A, you get an error that B can’t be deleted because it’s linked to C.
If the parent record in a lookup relationship is deleted, the field history tracking for the child record doesn't record the deletion. For
example, if a parent account is deleted, the Account History related list for the child account doesn’t show the deletion.
You can’t select indirect lookup fields in the parent field when you add the Related List - Single component to a Lightning Page.
Instead, select the related list that’s associated with the indirect lookup field. It doesn’t show data in the related list, but shows the
lookup field with no issue.
Relationships on External Objects
Lookup, external lookup, and indirect lookup relationships have some special behaviors and limitations.
• Only lookup, external lookup, and indirect lookup relationships are available for external objects. No other relationship types are
supported.
• Depending on the availability of the external system, related lists of child external objects can load slowly when users view the
parent record detail pages.
• Relationships that involve external objects allow users to create child records from the record detail pages of parent records.
However, the relationship field on each new child record isn’t automatically populated to identify the parent record.
• Syncing doesn’t create relationship fields on the external objects in your Salesforce org. However, you can change the field type
of a sync-created custom field to Lookup Relationship, External Lookup Relationship, or Indirect Lookup Relationship. Changing
the field type of an existing custom field is simpler and more efficient than manually creating a relationship field on the external
object.

188
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

For example, suppose that the external system has a foreign key relationship. Syncing the related tables creates a text field in
your org for the external column that identifies the foreign keys. To reflect the foreign key relationship within your org, change
the field type of that text field to External Lookup Relationship.

• A relationship field is a type of custom field. Therefore, like all custom fields on an external object, relationship fields can be
overwritten when you sync the external object. See the sync considerations for each Salesforce Connect adapter that you use.
• Cascade-delete isn’t available for external object relationships.
• In Salesforce Classic, indirect lookup relationship fields don’t display the expected names of parent records. Instead, each indirect
lookup relationship field displays the value of the target field on the parent object. To find related records, target field values are
matched against the values of the indirect lookup relationship field on the child object. The target field, which has the External
ID and Unique attributes, is selected when an indirect lookup relationship field is created.
• In Salesforce Classic, external lookup relationship fields don’t always display the expected names of parent records.
– In a list view, an external lookup relationship field displays the parent object ID or the value of the parent object’s External
ID standard field. The latter appears by default, but if a custom field on the parent object has the Is Name Field
attribute, the parent object ID is displayed.
– In a record detail page, an external lookup relationship field displays the name as expected if the org has previously retrieved
the parent record. If you see an ID in an external lookup relationship field, reload the page to replace the ID with the name.

• Lookup search isn’t available for external lookup relationship fields. To edit an external lookup relationship field, manually enter
the value of the External ID standard field for the parent record. This limitation doesn’t apply when the parent external object is
associated with the cross-org adapter for Salesforce Connect.
• Lookup search isn’t available for indirect lookup relationship fields. To edit an indirect lookup relationship field, manually enter
the value of the target field of the parent record. The target field is the custom field with External ID and Unique
attributes that was selected when the indirect lookup relationship was created. To determine related records, Salesforce matches
target field values against the values of the indirect lookup relationship field on the child object.
• With external lookup and indirect lookup relationships, the parent record appears as a clickable link in the relationship field on
the child record. If the child record is viewed by a user who doesn’t have access to the parent record, the parent record appears
in the relationship field as plain text instead of a link.
• Lookup filters aren’t available for external lookup relationship fields.
• Indirect lookup relationship fields can be created on external objects only.
• Only objects that have a custom field with the External ID and Unique attributes are available as parent objects in
indirect lookup relationships. If you don't see the desired object when you create an indirect lookup relationship field, add a
custom unique, external ID field to that object.
• If the external system uses case-sensitive values in the specified External Column Name, make sure that the parent object field
is also case-sensitive. When you define the parent object’s custom field, select External ID, Unique, and Treat "ABC" and "abc"
as different values (case sensitive).
Impact of Relationships on Reports
The type of relationship you create affects which standard report types are available and how they're categorized. These report types
determine which related objects can be included in the report:
• Lookup relationships allow data from the two related objects to be joined in one report.
• Master-detail relationships allow data from three objects to be joined in one report: the master object, the detail object, plus
one other lookup object. If the detail object has multiple lookup relationships, a separate report type is available based on each
lookup.
• Many-to-many relationships provide two standard report types that join the master objects and the junction object. The report
types are:The order of the master objects in the report type is important. The master object listed first determines the scope of
records that can be displayed in the report.

189
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

– “Primary master with junction object and secondary master” in the primary master object's report category.
– “Secondary master with junction object and primary master” in the secondary master object's report category.

The reporting impact of each relationship type is summarized in the following table:

Relationship Type Standard Report Types Report Type Category

Lookup Object by itself Based on the object
Object with first lookup
Object with second lookup
Object with third lookup

Master-Detail Master object by itself Master object

Master object with detail object
Master object with detail object and first
lookup
Master object with detail object and
second lookup
Master object with detail object and third
lookup

Many-to-Many Primary master object by itself Primary master object

Secondary master object by itself and
Primary master object with junction object Secondary master object
and secondary master object
Secondary master object with junction
object and primary master object

Custom report types give you more flexibility to join data from multiple objects, including lookups and master-detail relationships.

Important: Converting a relationship from lookup to master-detail or vice versa can cause existing custom reports to become
unusable due to the different standard report types available for each type of relationship. We recommend that you test your
custom reports immediately after converting the relationship type. If you revert your relationship back to the original type, the
reports are restored and become usable again.

SEE ALSO:
Object Relationships Overview
Create a Many-to-Many Object Relationship
External Object Relationships

190
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

Customize Search Layouts

Search layouts let you determine what users see when Einstein Search returns results. For each
USER PERMISSIONS
unique user profile, you can create search layouts for standard and custom objects, ensuring the
layout shows users what’s most relevant to them. Only objects with customizable layouts support To define search layouts for
profile-specific layouts. The search layout that you configure applies to global and lookup searches. custom objects:
• Customize Application
You can customize search layouts on a per-object basis. Users who don’t have a profile-specific
layout assigned to them see the default search results layout. Look at search layout guidelines,
limitations, and other layout options for your users.

SEE ALSO:
Customize Search Layouts
Search Layouts Limitations

Custom Object Security

Learn how security settings work together so you can control access to your custom objects with
EDITIONS
great flexibility.

Important: Where possible, we changed noninclusive terms to align with our company Available in: both Salesforce
value of Equality. We maintained certain terms to avoid any effect on customer Classic (not available in all
orgs) and Lightning
implementations.
Experience
Set custom object security at the following levels
Available in: Contact
• Tab—display the custom tab for the appropriate users based on their user profiles. Manager, Group,
• Object—set the access users have to create, read, edit, and delete records for each object. Professional, Enterprise,
• Records—set the default sharing model for all your users. This determines the access users Performance, Unlimited,
have to custom object records that they don’t own. Developer, and
Database.com Editions
• Relationship—for objects on the detail side of a master-detail relationship, specify the sharing
access that users must have to the master record in order to create, edit, or delete the associated Tabs aren’t available in
detail records. This is specified in the Sharing Setting attribute of the master-detail relationship Database.com.
field on the detail object.
• Fields—set the level of access users have to fields on your custom object page layout.
These requirements apply to custom objects with no master-detail relationship.

Action Required Privileges

Create a record Create permission. The user must have the tab displayed to create
a record from the Create New dropdown list in the sidebar.

View a record Read permission and Public Read Only or Public Read/Write sharing
model if not the record owner.

Edit a record Edit permission and Public Read/Write sharing model if not the
record owner.

Delete a record Delete permission and must be the record owner or above the
record owner in the role hierarchy.

191
Extend Salesforce with Clicks, Not Code Store Information That’s Unique to Your Organization

These requirements apply to custom objects that have a master-detail relationship with a standard or custom object.

Action Required Privileges

Create a record Create permission and either read or read/write access to the
related master record, depending on the value of the Sharing
Setting attribute of the master-detail relationship field on the detail
object.

View a record Read permission and read access to the related master record. If
the record has two master records in a many-to-many relationship,
the user must have read access to both master records.

Edit a record Edit permission and either read or read/write access to the related
master record, depending on the value of the Sharing Setting
attribute of the master-detail relationship field on the detail object.

Delete a record Delete permission and either read or read/write access to the
related master record, depending on the value of the Sharing
Setting attribute of the master-detail relationship field on the detail
object.
When a user deletes a record that has related custom object
records, all related custom object records are deleted regardless
of whether the user has delete permission to the custom object.

Delegated administrators can manage nearly every aspect of specified custom objects, but they can’t create or modify relationships on
the object or set organization-wide sharing defaults.

Notes on Enabling Activities for Custom Objects

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
• If you enable activities when creating a custom object, the activity related lists are added to the Classic and Lightning
Experience
default page layout automatically. If you enable activities later, after the custom object already
exists, you must add the related lists to the page layout manually. Available in: Contact
• Disabling activities for a custom object doesn’t delete existing activity records. However, activity Manager, Group,
related lists are removed from custom object pages, and reports containing activities and the Professional, Enterprise,
custom object are deleted. Performance, Unlimited,
and Developer Editions
• If a custom object has a master-detail relationship with accounts, the custom object’s activities
roll up to the account and cause the account’s Last Activity date to be updated. For custom
objects related to other types of records, the activities don’t roll up.
• The ability to send emails or create mail merge documents is available for activities on custom objects. The email must be sent to a
contact or lead.
• When you change the ownership of a custom object record, any open activities related to that custom object are also transferred
to the new record owner.
• You can’t disable activity tracking for a custom object if any workflow tasks are associated with that custom object.

192
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

• Custom object records can only be associated with a call log in Salesforce CRM Call Center if activities are enabled for the object.

SEE ALSO:
Create a Custom Object

Store Customers’ Data Privacy Preferences

Store certain data privacy preferences for your customers.
EDITIONS
Regardless of whether you’re working toward complying with data protection and privacy
regulations, data privacy records can help you track and store your customers’ consent. We’ve listed Available in: both Salesforce
some of the regulations that are important to many companies collecting and processing their Classic (not available in all
customers’ data. orgs) and Lightning
Experience
• General Data Protection Regulation (GDPR), European Union
• Gramm-Leach-Bliley Act (GLB Act), United States Available in: all editions,
including partner and
• Canada’s Anti-Spam Law (CASL)
customer community users.

Set Up Tracking and Storage of Certain Data Privacy Preferences

Let your users store and track certain data privacy preferences for your customers.
Consent Management Objects
Get familiar with the objects that you can use for managing your customers’ privacy and consent.
Tracking Customer Requests for Data Privacy Updates
If you store certain data privacy preferences in data privacy records based on the Individual object, track customers’ requests so that
you can honor their wishes.
Best Practices for Tracking Data Privacy
Keep these best practices in mind when storing certain data privacy preferences in data privacy records based on the Individual
object.
Track Certain Data Privacy Preferences for Leads and Contacts Already in Salesforce
Create data privacy records based on the Individual object for leads and contacts already in Salesforce using scripts.
Manage Duplicate Data Privacy Records
Keep your records clean and free of duplicates so that you can reach more customers and maintain better relationships with them.

Set Up Tracking and Storage of Certain Data Privacy Preferences

Let your users store and track certain data privacy preferences for your customers.
EDITIONS
Data protection details are available in all your org’s records by default. Enable the Consent Data
model in the settings. You can easily verify that they’re available or disable them from the Setup Available in: both Salesforce
page. Classic (not available in all
orgs) and Lightning
1. From Setup, in the Quick Find box, enter Data Protection and Privacy, and then
Experience
select Data Protection and Privacy.
2. Click Edit, select or unselect Make data protection details available in records, and then Available in: all editions,
including partner and
click Save.
customer community users.

193
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

You can make data protection information visible to users by adding the Individual field to Lead, Contact, and Person Accounts
page layouts. Consider renaming this field to something meaningful to your users. (Example: Manage data privacy or Track customer
consent)

Note: If you don’t see tabs for the consent management objects, set the objects’ tab settings to Default On for the profiles where
you want to enable tabs.
Consider enabling or updating these settings.
• Create custom fields for data privacy records
• Create sharing rules for data privacy records
• Encrypt personal data in certain data privacy fields (Shield customers)
• Set the organization-wide sharing default
• Track field history for individuals

SEE ALSO:
Track Certain Data Privacy Preferences for Leads and Contacts Already in Salesforce
Best Practices for Tracking Data Privacy
Respect Consent Preferences in Marketing Cloud with the Consent Data Model

Consent Management Objects

Get familiar with the objects that you can use for managing your customers’ privacy and consent.
EDITIONS
After you learn about these objects and fields, you can track and store certain data privacy
preferences. But keep in mind that you must decide how to honor your customers’ privacy, and Available in: both Salesforce
then implement a process to accomplish that. Classic (not available in all
orgs) and Lightning
For example, if you send communications to customers with Marketing Cloud, you can manage
Experience
customers’ preferences for how they want to be contacted using consent management objects.
To learn more, read the Respect Consent Preferences in Marketing Cloud with the Consent Data Available in: all editions. The
Model solution kit. Individual object is available
for partner and customer
Note: Consent management object records aren’t counted toward your storage usage. community users.

Table 1: Consent Management Objects

Object What It Tracks
Authorization Form The version number and effective dates of the authorization form.

Authorization Form Consent Information related to the customer’s consent to the authorization
form.

Authorization Form Data Use The data use purpose associated with the authorization form.

Authorization Form Text The text and language of the authorization form.

Communication Subscription The customer’s preferences for a communication subscription.

Communication Subscription Channel Type The engagement channel through which to contact a customer
for a communication subscription.

194
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Object What It Tracks

Communication Subscription Consent Information related to the customer’s consent to the
communication subscription.

Communication Subscription Timing The customer’s timing preferences for receiving a communication
subscription.

Contact Point Consent Information related to the customer’s consent to be contacted via
a specific contact point.

Contact Point Email The customer’s preference for the time that they prefer to be
contacted via email.

Contact Point Phone The customer’s preference for the time that they prefer to be
contacted via phone.

Contact Point Type Consent Customer allows contact via a specific contact point type like email,
but not through phone calls and mail.

Data Use Purpose The reason for collecting customer data.

Data Use Legal Basis The legal basis for contacting an individual or party, such as
legitimate interest.

Engagement Channel Type The channel to use to reach a customer, such as email or web.

Individual The customer’s preferences for:

• Collecting, storing, and sharing their personal data.
• Packaging their personal data so they can take ownership of
it.
• Deleting records and personal data related to them.
• Solicitation of products and services.
• Tracking their geolocation and web activity.

Party Consent Information related to an individual’s consent.

Authorization Form Objects

Keep track of data related to authorization forms, such as terms of service, privacy policy, and other consent forms. Each authorization
form object stores different data. You can use them together to create a full picture of your customer’s consent to the authorization
form.
Communication Subscription Objects
You can store and manage the data related to your customer’s communication subscriptions, such as newsletters or appointment
reminders. Different communication subscription objects store different data, such as how the customer consented to the
communication subscription and preferred contact timing.
Fields in Data Privacy Records
Get the skinny on the fields that appear in data privacy records based on the Individual object. Data privacy records store certain
privacy settings for your customers.

195
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Fields in Contact Point Consent Records

Represents a customer's consent to be contacted via a specific contact point, such as an email address or phone number.
Fields in Contact Point Email Records
Fields in contact point email records store multiple email records related to an individual.
Fields in Contact Point Phone Records
Fields in contact point phone records store multiple phone records related to an individual.
Fields in Contact Point Type Consent Records
Contact point type consent records let you enter details about how a customer has agreed to be contacted by your company. For
example, you can indicate that a customer consented to a specific contact point like email, but not phone calls and mail.
Fields in Data Use Purpose Records
Represents a category that defines the reason for contacting an individual. For example, billing, marketing, or surveys.
Fields in Data Use Legal Basis Records
Represents the legal basis for contacting an individual. For example, billing or contract.
Fields in Party Consent Records
Represents consent preferences for an individual.

Authorization Form Objects

Keep track of data related to authorization forms, such as terms of service, privacy policy, and other
EDITIONS
consent forms. Each authorization form object stores different data. You can use them together to
create a full picture of your customer’s consent to the authorization form. Available in: both Salesforce
Classic (not available in all
Authorization Form orgs) and Lightning
Experience
Stores the name, version, and effective dates of the authorization form. You can use the revision
number to determine if you’re using the current version. You can also link to a default authorization Available in: all editions
form text record to use if text isn’t available for a specific language.

Authorization Form Consent

Tracks information related to each customer’s consent to the authorization form. Indicates the individual that consented and when,
how, and to which version of the authorization form.

Authorization Form Data Use

Optionally, you can connect an authorization form to one or more data use purpose records. Indicate the data use purpose associated
with the form, such as billing or marketing, and its corresponding legal basis.

Authorization Form Text

Manages the text associated with the authorization form. You can create multiple text versions for the same authorization form to support
different languages, regions, and situations. You can also include a summary to describe the form’s purpose and display to customers
when asking for their consent.

196
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Communication Subscription Objects

You can store and manage the data related to your customer’s communication subscriptions, such
EDITIONS
as newsletters or appointment reminders. Different communication subscription objects store
different data, such as how the customer consented to the communication subscription and Available in: both Salesforce
preferred contact timing. Classic (not available in all
orgs) and Lightning
Communication Subscription Experience

Store a customer’s subscription preferences for a specific communication. Available in: all editions.

Communication Subscription Channel Type

Specify the engagement channel that you can use to contact the customer for a communication subscription.

Communication Subscription Consent

Track information related to each customer’s consent to the communication subscription. Indicate the individual or person account that
consented, when consent was captured, and through what method. You can also specify if another person consented on behalf of the
customer listed in the record. The user’s actual consent isn’t stored, but rather the action or communication types that the user chooses
to subscribe to.

Communication Subscription Timing

Manage the customer’s time preferences for receiving a communication subscription. For example, track whether to send a reminder
to a patient 2 weeks before an appointment or a newsletter to a customer every Tuesday. You can also ensure that you reach customers
when they prefer and in the correct time zone.

Engagement Channel Type

Store the channels by which you can communicate with a customer, such as email, phone, or web.

Fields in Data Privacy Records

Get the skinny on the fields that appear in data privacy records based on the Individual object. Data
EDITIONS
privacy records store certain privacy settings for your customers.
Available in: both Salesforce
Field Description Classic (not available in all
Birth Date The customer’s birth date. orgs) and Lightning
Experience
Block Geolocation Tracking Preference to not track geolocation on mobile
Available in: all editions,
devices.
including partner and
Consumer Credit Score The individual’s credit score (for example, 740). customer community users.

Consumer Credit Score Provider Name The name of the company that provided the
credit score.

Conviction Count The number of convictions for the customer.

Death Date The individual’s death date.

Don’t Market Preference to not receive marketing materials.

197
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Field Description
Don’t Process Preference to not process personal data, which can include
collecting, storing, and sharing personal data.

Don’t Profile Preference to not process data for predicting personal attributes,
such as interests, behavior, and location.

Don’t Solicit Preference to not solicit products and services.

Don’t Track Preference to not track customer web activity and whether the
customer opens email sent through Salesforce.

Export Individual’s Data Preference to export personal data for delivery to the individual.

Forget This Individual Preference to delete records and personal data related to this
individual.

Individual’s Age Indication for whether the individual is considered to be a minor.

Influencer Rating A measure of the person's influence, irrespective of how we do

business with them.

Is Homeowner Indicates whether the customer owns a home.

Military Service Indicates whether the customer has served in the military.

Number of Children The number of children the customer has.

Occupation The customer’s occupation. Maximum length is 150 characters.

OK to Store PII Data Elsewhere Indication that you can store personally identifiable information
outside of their legislation area. For example, you could store an
EU citizen’s personal data in the US.

Fields in Contact Point Consent Records

Represents a customer's consent to be contacted via a specific contact point, such as an email
EDITIONS
address or phone number.
Available in: both Salesforce
Field Description Classic (not available in all
Business Brand Represents a unique brand for a business that orgs) and Lightning
Experience
belongs to a parent entity.
Available in: all editions.
Capture Contact Point Type The contact point used to capture consent.
• Email
• Mailing Address
• Phone
• Social
• Web

Capture Date The date when consent was captured.

198
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Field Description
Capture Source The way you captured consent. For example, a website or online
form.

Contact Point The contact point record, such as for phone or email, that you want
to associate this consent with.

Data Use Purpose The data use purpose record that you want to associate this consent
with.

Double Consent Capture Date The date when double opt-in was captured. Double opt-in is
captured when the customer confirms for a second time that they
want to give consent.

Effective From The date when consent starts.

Effective To The date when consent ends.

Engagement Channel Type ID of the engagement channel record through which the customer
is consenting to be contacted.

Party Role The record, based on the individual object you want to associate
consent with.

Privacy Consent Status Whether the customer associated with this record agrees to this
form of contact.
• Not Seen
• Seen
• Opt In
• Opt Out

Fields in Contact Point Email Records

Fields in contact point email records store multiple email records related to an individual.
EDITIONS
Field Description Available in: both Salesforce
Active from Date The date when the contact’s email became Classic (not available in all
active. orgs) and Lightning
Experience
Active to Date The date when the contact’s email is no longer
Available in: all editions
active.

Best Time to Contact End Time The end time for when the customer prefers to
be contacted.

Best Time to Contact Start Time The start time for when the customer prefers to
be contacted.

Best Time to Contact Timezone The timezone for when it’s best to contact the
customer.

199
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Field Description
Email Address The email address of the contact.

Email Domain The domain of the contact’s email, which is everything after the
@ sign.

Email Latest Bounce Date Time The date and time when an email failed to reach its recipient.

Email Latest Bounce Reason Text The reason why the email didn’t reach its recipient.

Email Mail Box A subset of the contact’s email, which is everything before the @
sign.

Is Primary Indicates whether a contact’s email is their primary email (true) or

not (false).

Name The email of the contact.

Parent The ID of the contact’s parent. Only an individual or account can

be a contact’s parent.

Preference Rank Specify how this email ranks in terms of preference among the
contact’s other emails.

Usage Type Specify the usage type of this email. For instance, whether it’s a
work email or a temporary email. Possible values are:
• Home
• Temp
• Work

Fields in Contact Point Phone Records

Fields in contact point phone records store multiple phone records related to an individual.
EDITIONS
Field Description Available in: both Salesforce
Active from Date The date when the contact’s phone number Classic (not available in all
became active. orgs) and Lightning
Experience
Active to Date The date when the contact’s phone number is
Available in: all editions
no longer active.

Area Code The area code of the phone number’s location

for the contact.

Best Time to Contact End Time The end time for when the customer prefers to
be contacted.

Best Time to Contact Start Time The start time for when the customer prefers to
be contacted.

Best Time to Contact Timezone The timezone for when it’s best to contact the
customer.

200
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Field Description
Extension Number The phone number extension for the contact.

Formatted International Phone Number The internationally recognized format for the contact’s phone
number.

Formatted National Phone Number The nationally recognized format for the contact’s phone number.

Is Business Phone Indicates whether a contact’s phone number is a business number

(true) or not (false).

Is Fax Capable Indicates whether a contact’s phone number is a fax number (true)
or not (false).

Is Personal Phone Indicates whether a contact’s phone number is a personal number

(true) or not (false).

Is Primary Indicates whether a contact’s phone number is their primary phone

number (true) or not (false).

Is SMS Capable Indicates whether a contact’s phone number can receive text
messages (true) or not (false).

Name The phone number of the contact.

Parent The ID of the contact’s parent. Only an individual or account can

be a contact’s parent.

Phone Type The type of phone number for the contact. Possible values are:
• Home
• Mobile

Preference Rank Specify how this phone number ranks in terms of preference
among the contact’s other phone numbers.

Telephone Number The phone number for the contact.

Usage Type Specify the usage type of this phone number. For instance, whether
it’s a work phone or a temporary phone. Possible values are:
• Home
• Temp
• Work

201
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Fields in Contact Point Type Consent Records

Contact point type consent records let you enter details about how a customer has agreed to be
EDITIONS
contacted by your company. For example, you can indicate that a customer consented to a specific
contact point like email, but not phone calls and mail. Available in: both Salesforce
Classic (not available in all
Field Description orgs) and Lightning
Experience
Business Brand Represents a unique brand for a business that
belongs to a parent entity. Available in: all editions
Capture Contact Point Type The contact point used to capture consent.
• Email
• Mailing Address
• Phone
• Social
• Web

Capture Date The date when consent was captured.

Capture Source The way you captured consent. For example, a

website or online form.

Contact Point Type The contact method you want to apply consent
to.
• Email
• Mailing Address
• Phone
• Social
• Web

Data Use Purpose The data use purpose record that you want to
associate this consent with.

Double Consent Capture Date Date when double opt-in was captured. Double
opt-in is captured when the customer confirms
for a second time that they want to give
consent.

Data Use Purpose The data use purpose record that you want to
associate this consent with.

Effective From The date when consent starts.

Effective To The date when consent ends.

Engagement Channel Type ID of the engagement channel record through

which the customer is consenting to be
contacted.

202
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Field Description
Name The name of the contact point type consent record.

Party The record based on the Individual object you want to associate
consent with.

Party Role The party role record that you want to associate this consent with.

Privacy Consent Status Whether the individual associated with this record agrees to this
form of contact.
• Not Seen
• Seen
• Opt In
• Opt Out

Fields in Data Use Purpose Records

Represents a category that defines the reason for contacting an individual. For example, billing,
EDITIONS
marketing, or surveys.
Available in: both Salesforce
Field Description Classic (not available in all
Can Data Subject Opt Out Indication of whether an individual can decline orgs) and Lightning
Experience
contact for the described purpose.
Available in: all editions
Description Indicates the purpose for contacting a customer.

Legal Basis The legal basis record associated with this

purpose.

Name The reason for contacting an individual. For

example, “billing” or “marketing.”

Fields in Data Use Legal Basis Records

Represents the legal basis for contacting an individual. For example, billing or contract.
EDITIONS
Field Description Available in: both Salesforce
Description Description of the data use legal basis. Classic (not available in all
orgs) and Lightning
Name The name for the legal basis. For example, Experience
“billing” or “contract.”
Available in: all editions
Source The source of the legal basis. For example, the
URL of a contract.

203
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Fields in Party Consent Records

Represents consent preferences for an individual.
EDITIONS
Field Description Available in: both Salesforce
Action The action that the individual is consenting to, Classic (not available in all
such as collecting data. orgs) and Lightning
Experience
Business Brand Represents a unique brand for a business that
Available in: all editions.
belongs to a parent entity.

Capture Contact Point Type The contact point used to capture consent.
• Email
• Mailing Address
• Phone
• Social
• Web

Capture Date The date when consent was captured.

Capture Source The way you captured consent. For example, a

website or online form.

Double Consent Capture Date The date when double opt-in was captured.
Double opt-in is captured when the customer
confirms for a second time that they want to
give consent.

Effective From The date when consent starts.

Effective To The date when consent ends.

Name The name of the contact point type consent

record.

Party The record based on the Individual object you

want to associate consent with.

Party Role The party role record that you want to associate
this consent with.

Privacy Consent Status Whether the individual associated with this

record agrees to this form of contact.
• Not Seen
• Seen
• Opt In
• Opt Out

204
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Tracking Customer Requests for Data Privacy Updates

If you store certain data privacy preferences in data privacy records based on the Individual object,
EDITIONS
track customers’ requests so that you can honor their wishes.
To track customers’ requests for updates to their data privacy preferences, run an Apex trigger or Available in: both Salesforce
query records in the SOAP API. Classic (not available in all
orgs) and Lightning
Apex Triggers
Experience
From Setup, enter Individual in the Quick Find box, and then select Triggers. To create
a new trigger, select New. Available in: all editions,
including partner and
To monitor changes to a specific field, customize the trigger.
customer community users.
Example:

trigger IndividualUpdated on Individual (after update) {

for(String individualId : Trigger.newMap.keySet())
{
if( Trigger.oldMap.get(individualId).ShouldForget !=
Trigger.newMap.get(individualId).ShouldForget )
{
// Do something when ShouldForget ("Forget this Individual") changes
}
}
}

To track customers’ requests, either query for triggers in the API, or create reports on flagged items using custom report types.
Reports
Use data privacy reports to understand the information stored in data privacy records.
Standard Report: Field History - If your organization tracks field history on data privacy records based on the Individual object,
you can report on that information using the individual history report.
SOAP API
Query records for changes to data privacy flags using the SOAP API.
For more details, see SOAP API: Individual

SEE ALSO:
Best Practices for Tracking Data Privacy
Define Apex Triggers

205
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Best Practices for Tracking Data Privacy

Keep these best practices in mind when storing certain data privacy preferences in data privacy
EDITIONS
records based on the Individual object.
Available in: both Salesforce
Encrypting Personal Data Classic (not available in all
orgs) and Lightning
The Name field in data privacy records is personal data. Salesforce Shield customers can use Shield Experience
to encrypt this field. If you’ve added custom fields that contain personal data, consider encrypting
them. Available in: all editions,
including partner and
customer community users.
Helping Your Users Decode Individual
After you add the Individual field to your page layouts, consider renaming the field to something
meaningful for your users. (Example: Manage data privacy or Track customer consent)

Keeping Renamed Contacts, Leads, and Person Accounts Consistent with Data Privacy Record
Names
Renaming a contact, lead, or person account doesn’t update any corresponding privacy data. To keep the name of data privacy records
up to date, write an Apex trigger.

Converting Leads to Existing Contacts

When you convert a lead, you can decide which data privacy record you maintain between the converted lead and the contact.

To Maintain the Data You Need To

Privacy Record From the
Contact Sit back and do nothing.

Lead Edit the contact’s IndividualId to replace the ID with the one from the converted lead. If your
contact doesn’t include the ID before the conversion, the conversion process populates the field from
the converted lead.

Creating Community Users from Contacts with Associated Data Privacy Records
To create a new community member from a contact record, first disable Don’t Process and Forget this Individual
in the associated data privacy record.

SEE ALSO:
Lead Conversion Field Mapping

206
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Track Certain Data Privacy Preferences for Leads and Contacts Already in Salesforce
Create data privacy records based on the Individual object for leads and contacts already in Salesforce
EDITIONS
using scripts.
These scripts create unique data privacy records for each lead and contact. Keep in mind, if you Available in: both Salesforce
already have any data privacy records for your leads and contacts, this script creates duplicate Classic (not available in all
records. orgs) and Lightning
Experience

Create Data Privacy Records for Contacts Available in: all editions,
including partner and
Create data privacy records and link them to contacts already in Salesforce when you run this script. customer community users.

global class CreateIndividualFromContact implements Database.Batchable<sObject> {

global Database.Querylocator start(Database.BatchableContext BC) {
//Query to fetch contacts that don't have Individual created. You may modify the
query to add custom fields
//Please add "IsPersonAccount = false" condition to below query to exclude person
accounts
return Database.getQueryLocator('Select FirstName, LastName, Salutation from Contact
where IndividualId = NULL');
}

global void execute(Database.BatchableContext BC, List<Contact> contactList) {

Map<Id, Individual> individualRecordsToCreate = new Map<Id, Individual>();
for(Contact con : contactList) {
individualRecordsToCreate.put(con.Id, new Individual(FirstName = con.FirstName,
LastName = con.LastName, Salutation=con.Salutation));
}
insert individualRecordsToCreate.values();
for(Contact con : contactList) {
con.IndividualId = individualRecordsToCreate.get(con.Id).Id;
}
update contactList;
}

global void finish(Database.BatchableContext BC) {}

Create Data Privacy Records for Leads

Create data privacy records and link them to leads already in Salesforce when you run this script.
global class CreateIndividualFromLead implements Database.Batchable<sObject> {

global Database.Querylocator start(Database.BatchableContext BC) {

//Query to fetch non-converted Leads that don't have Individual created. You may
modify the query to add custom fields
return Database.getQueryLocator('Select FirstName, LastName, Salutation from Lead
where IsConverted = false and IndividualId = NULL');
}

207
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

global void execute(Database.BatchableContext BC, List<Lead> leadList) {

Map<Id, Individual> individualRecordsToCreate = new Map<Id, Individual>();
for(Lead l : leadList) {
individualRecordsToCreate.put(l.Id, new Individual(FirstName = l.FirstName,
LastName = l.LastName, Salutation=l.Salutation));
}
insert individualRecordsToCreate.values();
for(Lead l : leadList) {
l.IndividualId = individualRecordsToCreate.get(l.Id).Id;
}
update leadList;
}

global void finish(Database.BatchableContext BC) {}

}

Manage Duplicate Data Privacy Records

Keep your records clean and free of duplicates so that you can reach more customers and maintain
EDITIONS
better relationships with them.
You can work with duplicate data privacy records individually or in bulk. You can’t merge duplicate Available in: both Salesforce
data privacy records automatically. Classic (not available in all
orgs) and Lightning
You can create a custom matching rule for the Individual object to identify duplicate data privacy
Experience
records and a custom duplicate rule to handle the duplicates.
The Individual object doesn’t include standard matching and duplicate rules, so you must create Available in: all editions,
including partner and
your own custom matching and duplicate rules to manage your data privacy duplicates.
customer community users.

Merge Duplicate Data Privacy Records in Lightning Experience

Merge duplicate data privacy records based on the Individual object in Lightning Experience.

SEE ALSO:
Manage Duplicates One at a Time
Manage Duplicates Globally
Duplicate Detection and Handling Process
Customize Duplicate Management

208
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

Merge Duplicate Data Privacy Records in Lightning Experience

Merge duplicate data privacy records based on the Individual object in Lightning Experience.
EDITIONS
1. Choose a data privacy record based on the Individual object. A message tells you if duplicates
exist for that record. To see them, click View Duplicates. Available in: Lightning
Experience

Available in: all editions,

including partner and
customer community users.

USER PERMISSIONS

To merge data privacy

records based on the
Individual object:
• Delete on individuals

2. Choose up to three data privacy records to merge. Click Next.

209
Extend Salesforce with Clicks, Not Code Store Customers’ Data Privacy Preferences

3. Choose one data privacy record as the master, and choose the field values that you want to keep. Click Next.

4. Confirm your choices and merge.

210
Extend Salesforce with Clicks, Not Code Classify Sensitive Data to Support Data Management Policies

Classify Sensitive Data to Support Data Management Policies

Record data sensitivity and compliance categorization at the field level. Data classification can be
EDITIONS
used to guide decisions around access, reporting, and data compliance.
Available in: Salesforce
Set Up Data Classification Metadata Classic and Lightning
Customize your data classification settings to meet your organization’s needs. You can also Experience
upload or download data classification values. Available in: All editions
Data Classification Metadata Fields
Record the data owner, field usage, data sensitivity, and compliance categorization for any USER PERMISSIONS
standard or custom object field. You can also access data classification metadata in the Salesforce
API and Apex. To edit or view data
classification fields:
Create Reports from Data Classification Metadata
• Customize Application
Run reports to help meet your data management policies. or Modify Data
Classification

Set Up Data Classification Metadata

Customize your data classification settings to meet your organization’s needs. You can also upload
EDITIONS
or download data classification values.

Note: Data classification is automatically enabled in all orgs. Available in: Salesforce
Classic and Lightning
1. Select whether to use default data sensitivity levels. Experience
a. From Setup, in the Quick Find box, enter Data Classification Settings, and Available in: All editions
then select Data Classification Settings.
b. Select or deselect Use default data sensitivity level. Some fields contain data sensitivity USER PERMISSIONS
values by default. Those values are visible in the UI after you enable them. For example, the
email field has a confidential value. When you enable that checkbox, those default values To edit or view data
are applied and are then visible in the UI. classification fields:
• Customize Application
2. Edit data classification values. or Modify Data
Classification
a. From Setup, select Object Manager, and then select the object you want to edit.
b. Select Fields & Relationships from the sidebar. Select the field where you want to set up
data classification, and click Edit.
c. Select the value for each metadata field from the dropdown lists.
d. Click Save.

Note: To edit data classification values for fields that aren’t available in the Object Manager, use the CustomField Metadata
API or Data Classification Upload tool.

3. (Optional) Edit Data Sensitivity picklist values.

a. From Setup, in the Quick Find box, enter Data Classification Settings, and then select Data Classification
Settings.
b. Select Edit Data Sensitivity Picklist Values
c. Add, delete, rename, or reorder an existing picklist value.

211
Extend Salesforce with Clicks, Not Code Classify Sensitive Data to Support Data Management Policies

You can also add a Description or indicate that fields with this picklist value contain data highly sensitive to your company by
selecting High-risk level.

4. (Optional) Edit Compliance Categorization picklist values.

a. From Setup, in the Quick Find box, enter Data Classification Settings, and then select Data Classification
Settings.
b. Select Edit Compliance Categorization Picklist Values
c. Add, delete, rename, or reorder an existing picklist value.

5. (Optional) Upload data classification information in a CSV file.

a. From Setup, in the Quick Find box, enter Data Classification Upload, and then select Data Classification Upload.
b. Click Choose File. A CSV file can contain a maximum of 10,000 rows. Each row must include the object name, field name, and
data sensitivity level.

6. (Optional) Download data classification information in a CSV file.

a. From Setup, in the Quick Find box, enter Data Classification Download, and then select Data Classification
Download.
b. Click Download. The maximum size of the CSV file is 5 MB.
Only fields that have an associated data sensitivity value are included in the file. The file includes the first 2,000 records for each
data sensitivity value.

You can update multiple fields at once using the CustomField Metadata API.

Data Classification Metadata Fields

Record the data owner, field usage, data sensitivity, and compliance categorization for any standard
EDITIONS
or custom object field. You can also access data classification metadata in the Salesforce API and
Apex. Available in: Salesforce
You can use the data classification metadata fields on all standard and custom objects. Classic and Lightning
Experience
Field Description Available in: All editions
Compliance Categorization The compliance acts, definitions, or regulations
that are related to the field’s data. Default values: USER PERMISSIONS
• CCPA—California Consumer Privacy Act
To edit or view data
• COPPA—Children's Online Privacy classification fields:
Protection Act • Customize Application
• GDPR—General Data Protection Regulation or Modify Data
Classification
• HIPAA—Health Insurance Portability and
Accountability Act
• PCI—Payment Card Industry
• PersonalInfo—Personal information. For use
with the Enhanced Personal Information
Management feature. Only available if
Enhanced Personal Information

212
Extend Salesforce with Clicks, Not Code Classify Sensitive Data to Support Data Management Policies

Field Description
Management and Digital Experiences are enabled.
• PII—Personally Identifiable Information
The field corresponds to the ComplianceGroup field on the
FieldDefinition Tooling API.

Data Owner The person or group associated with this field. The data owner
understands the importance of the field’s data to your company
and might be responsible for determining the minimum data
sensitivity level.
The field corresponds to the BusinessOwnerId field on the
FieldDefinition Tooling API.

Data Sensitivity Level The sensitivity of the data contained in this field. Default values:
• Public—Available to the public to view but not alter.
• Internal—Available to company employees and contractors.
This data must not be shared publicly, but it can be shared
with customers, partners, and others under a non-disclosure
agreement (NDA).
• Confidential—Available to an approved group of employees
and contractors. This data isn’t restricted by law, regulation, or
a company master service agreement (MSA). It can be shared
with customers, partners, and others under an NDA.
• Restricted—Available only to an approved group of employees
and contractors. This data is likely restricted by law, regulation,
an NDA, or a company MSA.
• MissionCritical—Available only to a small group of approved
employees and contractors. Third parties who are given access
could be subject to heightened contractual requirements. This
data is almost always restricted by law, regulation, an NDA, or
a company MSA.
The field corresponds to the SecurityClassification
field on the FieldDefinition Tooling API and the
FieldSecurityClassification SOAP API.

Field Usage Tracks whether the field is in use. Default values:

• Active—In use and visible.
• DeprecateCandidate—Planned for deprecation and no longer
in use.
• Hidden—Not visible and possibly planned for deprecation.
Use with caution.

Note: Changing the value of Field Usage doesn’t hide or

expose the field.

213
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

Field Description
The field corresponds to the BusinessStatus field on the
FieldDefinition Tooling API.

You can customize the values for the Compliance Categorization, Data Sensitivity Level, and Field Usage fields.
• To edit the Compliance Categorization values, select Edit Compliance Categorization Picklist Values on the Data Classification
Settings Setup page or update the ComplianceGroup picklist using the StandardValueSet Metadata API type.
• To edit the Data Sensitivity Level values, select Edit Data Sensitivity Picklist Values on the Data Classification Settings Setup page
or update the SecurityClassification picklist using the StandardValueSet Metadata API type.
• To edit the Field Usage values, update the FieldBusinessStatus picklist using the StandardValueSet Metadata API type.

Note: You can also access data classification metadata by querying your Salesforce data. For example, this sample query retrieves
values for all data classification metadata fields in account and lead records.

SELECT Id, DeveloperName, Description, BusinessOwnerId, BusinessStatus,

SecurityClassification
FROM FieldDefinition
WHERE EntityDefinitionId in ('Account','Lead')

Create Reports from Data Classification Metadata

Run reports to help meet your data management policies.
EDITIONS
1. To expose the metadata fields, create a custom report type. From Setup, enter Report
Types in the Quick Find box, then select Report Types. Available in: Salesforce
Classic and Lightning
2. Click New Custom Report Type.
Experience
3. For Primary Object, select Entity Definition.
Available in: All editions
4. Fill in the remaining fields and click Next.
5. Add a child object. Click the box under the primary object and select Field Definitions.
USER PERMISSIONS
6. Click Save.
To edit or view data
7. Exit Setup and click the Reports tab. Build a report in Lightning Experience or Classic using the classification fields:
report type you made. • Customize Application
or Modify Data
Classification

Design Your Own Data Model With Schema Builder

Schema Builder provides a dynamic environment for viewing and modifying all the objects and
EDITIONS
relationships in your app. This greatly simplifies the task of designing, implementing, and modifying
your data model, or schema. Schema Builder is enabled by default. Available in: both Salesforce
Important: Where possible, we changed noninclusive terms to align with our company Classic and Lightning
Experience
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: All Editions

214
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

You can view your existing schema and interactively add new custom objects, custom fields, and relationships, simply by dragging and
dropping. Schema Builder automatically implements the changes and saves the layout of your schema any time you move an object.
This eliminates the need to click from page to page to find the details of a relationship or to add a new custom field to an object in your
schema.
Schema Builder provides details like the field values, required fields, and how objects are related by displaying lookup and master-detail
relationships. You can view the fields and relationships for both standard and custom objects.
To access Schema Builder, from Setup, enter Schema Builder in the Quick Find box, then select Schema Builder.
Schema Builder lets you add the following to your schema:
• Custom objects
• Lookup relationships
• Master-detail relationships
• All custom fields except: Geolocation

Create Objects with Schema Builder

Create Fields with Schema Builder
Delete Custom Objects with Schema Builder
You can delete the custom objects that you no longer need by using Schema Builder.
Delete Custom Fields with Schema Builder
Avoid custom field clutter by using Schema Builder to delete custom fields that you no longer need.
Schema Builder Custom Object Definition
Schema Builder Considerations
Keep these items in mind when working with Schema Builder.

SEE ALSO:
Create Objects with Schema Builder
Custom Field Types
Change Sets

Create Objects with Schema Builder

To create a custom object with Schema Builder:
EDITIONS
1. Click the Elements tab.
Available in: both Salesforce
2. Click Object and drag it onto the canvas.
Classic (not available in all
3. Enter information to define your object. For a list of object definitions, see Schema Builder orgs) and Lightning
Custom Object Definition on page 217. Experience
4. Click Save. Available in: All Editions

SEE ALSO:
USER PERMISSIONS
Schema Builder Custom Object Definition
To create new custom
objects in Schema Builder:
• Customize Application

215
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

Create Fields with Schema Builder

To create a custom field with Schema Builder:
EDITIONS
1. From Setup, enter Schema Builder in the Quick Find box, then select Schema Builder.
Available in: both Salesforce
2. Click the Elements tab.
Classic (not available in all
3. Click a field and drag it onto an object on the canvas. orgs) and Lightning
4. Enter a Field Label. Experience

Salesforce populates Field Name using the field label. This name can contain only underscores Available in: All Editions
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.
USER PERMISSIONS
When creating a custom field, ensure that its name and label are unique for that object.
To create fields in Schema
• If a standard and custom field have identical names or labels, the merge field displays the Builder:
custom field value. • Customize Application
• If two custom fields have identical names or labels, the merge field can display an
unexpected value.
If you create a field label called Email and a standard field labeled Email exists, the merge field is unable to distinguish between
the fields. Adding a character to the custom field name makes it unique. For example, Email2.

5. Enter a Description of the custom field.

6. Enter Help Text to detail the purpose and function of a custom field.
7. Enter a Default Value to automatically insert a value of a custom field when a new record is created.
8. Depending on the custom field type you choose, enter any remaining field attributes.
9. Click Save.
Any field you add through Schema Builder isn’t automatically added to the page layout. You must edit the page layout to specify where
the field should be displayed.

Beyond the Basics

By default, the field level security for custom fields is set to visible and editable for internal profiles. Fields that aren’t normally
editable, such as formulas and roll-up summary fields, are visible and read-only. To manage permissions of a custom field, click
the element name or label and select Manage Field Permissions. Use the dialog box that appears to manage the field’s visibility
and writeability for all standard and custom profiles.

216
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

Delete Custom Objects with Schema Builder

You can delete the custom objects that you no longer need by using Schema Builder.
EDITIONS
Schema Builder displays a list of side effects when you try to delete a custom object. Be sure you’re
ready to accept these side effects before finalizing the deletion. See Delete Custom Objects on page Available in: both Salesforce
169 and Manage Deleted Custom Objects on page 171. Classic (not available in all
orgs) and Lightning
1. Click on the custom object’s icon. Experience
2. Select Delete Object....
Available in: All Editions
A dialog box displays that explains the side effects of deleting an object. Read this information
carefully.
USER PERMISSIONS
3. If you accept the conditions, select Yes, I want to delete the custom object.
To delete custom objects in
4. Click Delete.
Schema Builder:
• Customize Application

Delete Custom Fields with Schema Builder

Avoid custom field clutter by using Schema Builder to delete custom fields that you no longer need.
EDITIONS
Schema Builder displays a list of side effects when you try to delete a custom field. Be sure you’re
ready to accept these side effects before finalizing the deletion. Available in: both Salesforce
Classic (not available in all
1. Right-click on the custom field.
orgs) and Lightning
2. Select Delete Field.... Experience
A dialog box displays that explains the side effects of deleting a custom field. Read this
Available in: All Editions
information carefully.

3. If you accept the conditions, select Yes, I want to delete the custom field. USER PERMISSIONS
4. Click Delete.
To delete custom fields in
Schema Builder:
• Customize Application

Schema Builder Custom Object Definition

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
Classic (not available in all
Field Description orgs) and Lightning
Experience
Label A name used to refer to the object in any user
interface pages. Available in: All Editions

Plural Label The plural name of the object. If you create a

tab for this object, this name is used for the tab.

217
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

Field Description
Starts with a vowel sound If it’s appropriate for your org’s default language, check if your label
should be preceded by "an" instead of "a".

Object Name A unique name used to refer to the object when using the API. In
managed packages, this unique name prevents naming conflicts
on package installations. The Object Name field 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.

Description An optional description of the object. A meaningful description

helps you remember the differences between your custom objects
when you’re viewing them in a list.

Record Name The name used in page layouts, list views, related lists, and search
results.

Data Type The type of field (text or auto-number) for the record name. Records
that have unique IDs instead of names use auto-numbers. An
auto-number is a unique number assigned automatically. It’s always
a read-only field.

Allow Reports Makes the data in the custom object records available for reporting
purposes.
To create reports on custom objects, choose the Other Reports
report type category, unless the custom object has a relationship
with a standard object. When the custom object has a master-detail
relationship with a standard object or is a lookup object on a
standard object, select the standard object for the report type
category instead.

Allow Activities Allows users to associate tasks and scheduled calendar events
related to the custom object records.

Track Field History Enables your org to track changes to fields on the custom object
records, such as who changed the value of a field, when it was
changed, and what the value of the field was before and after the
edit. History data is available for reporting, so users can easily create
audit trail reports when this feature is enabled.

Enable Divisions If your org has divisions enabled, select this option to enable the
custom object for divisions. Divisions group records for simplified
search results, list views, reports, and other areas within Salesforce.
Salesforce adds a Division field to the custom object. If the
custom object is the master in a master-detail relationship, custom
objects on the detail side also get the Division field and inherit
their division from the master record.

Available for Customer Portal This option makes the custom object available through the
Salesforce Customer Portal.

218
Extend Salesforce with Clicks, Not Code Design Your Own Data Model With Schema Builder

Field Description
Namespace Prefix 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. It keeps your managed
package under your control exclusively.

Deployment Status Indicates whether the custom object is visible to other users.

Add Notes & Attachments... Allows users to attach notes and attachments to custom object
records. This allows you to attach external documents to any object
record, in much the same way that you can add a PDF or photo as
an attachment to an email.
This option is only available when you’re creating a new object.

Schema Builder Considerations

Keep these items in mind when working with Schema Builder.
EDITIONS
• Schema Builder saves the layout of your schema anytime you move an object.
• If your schema contains many objects and fields, loading can take a long time. Click Hide Available in: both Salesforce
Relationships to improve Schema Builder performance. Classic (not available in all
orgs) and Lightning
• When creating a custom field, ensure that its name and label are unique for that object. Experience
– If a standard and custom field have identical names or labels, the merge field displays the
Available in: All Editions
custom field value.
– If two custom fields have identical names or labels, the merge field can display an
unexpected value.
If you create a field label called Email and a standard field labeled Email exists, the merge field is unable to distinguish between
the fields. Adding a character to the custom field name makes it unique. For example, Email2.
• You can’t export your schema from Schema Builder (for example, to use the schema in another org).
• When you click Auto-Layout, you can’t undo it.
• Objects created outside of Schema Builder, such as through an app or the API, don’t automatically display on the canvas. Select the
checkbox for the object created outside Schema Builder to display it on the canvas.
• By default, the field-level security for custom fields is set to visible and editable for internal profiles—those not cloned from Partner
User or Customer Portal Manager. Fields that aren’t normally editable, such as formulas and roll-up summary fields, are visible and
read only.
• You can’t save the level of zoom when closing Schema Builder.

219
Extend Salesforce with Clicks, Not Code Create Custom Settings

Create Custom Settings

Use custom settings to create custom sets of data, or to create and associate custom data for an
EDITIONS
org, profile, or user.
Custom settings are similar to custom objects in that they let you customize org data. Unlike custom Available in: Salesforce
objects, which have records based on them, custom settings let you utilize custom data sets across Classic and Lightning
your org. Custom settings also let you distinguish particular users or profiles based on custom Experience.
criteria.
Available in: Group,
Custom settings data is exposed in the application cache, which enables efficient access without Professional, Developer,
the cost of repeated queries to the database. This data can then be used by formula fields, validation Enterprise, Performance,
rules, flows, Apex, and SOAP API Unlimited, and
Database.com Editions.
Note: If you're thinking of using List Custom Settings, consider using Custom Metadata
Packages are not available
Types instead. Unlike List Custom Settings, you can migrate the records of Custom Metadata
in Database.com.
Types using Packages or Metadata API tools.
The following examples illustrate how you can use custom settings:
• A shipping application requires users to fill in the country codes for international deliveries. By USER PERMISSIONS
creating a list setting of all country codes, users have quick access to this data without needing Customize Application
to query the database. •
• An application calculates and tracks compensation for its sales reps, but seniority determines
commission percentages. By creating a hierarchy setting, the administrator can associate a
different commission percentage for each profile in the sales organization. Within the application, one formula field can then be
used to calculate compensation for all users. The personalized setting at the profile level inserts the correct commission percentage.
• An application displays a map of account locations, the best route to take, and traffic conditions. This information is useful for sales
reps, but account executives only want to see account locations. By creating a hierarchy setting with custom checkbox fields for
route and traffic, you can enable this data for just the “Sales Rep” profile.
To create and use custom settings:
1. Review the protection and privacy options.
2. Create the custom setting.
3. Add fields and data.
4. Reference the custom setting data in your application using formula fields, validation rules, Apex, or SOAP API.

Protection and Privacy Options for Custom Settings

Manage the visibility and permissions of custom settings.
Define Custom Settings
Create custom sets of data.
View and Edit Custom Settings
After you create a custom setting, you can view the details of the custom setting, manage the custom setting, and add fields.
View Custom Settings Usage and Data
View the percentage of custom settings data your org has used.
Grant Permissions on Custom Settings
By default, access to custom settings is limited through the Restrict access to custom settings org-wide preference.
Admins can grant API Read access through profiles and permission sets to users without the Customize Application permission.

220
Extend Salesforce with Clicks, Not Code Create Custom Settings

Grant Read Access to All Custom Settings

Admins with the Customize Application permission can grant API read access to all custom settings.
Access Custom Settings with Code
You can access custom settings from Apex, SOAP API, and formulas.
Custom Settings Limits and Considerations
When working with custom settings, be aware of the following considerations and limits on the amount of cached data.

Protection and Privacy Options for Custom Settings

Manage the visibility and permissions of custom settings.
EDITIONS

Packages Available in: Salesforce

Classic and Lightning
Only custom settings definitions are included in packages, not data. To include data, populate the Experience.
custom settings using a standard Apex or API script run by the subscribing organization after they
install the package. Available in: Group,
Professional, Developer,
When a custom setting is contained in a managed package, and the visibility is set to Protected, Enterprise, Performance,
access is allowed only through the Apex code that is part of that managed package. Subscriber Unlimited, and
organizations can’t directly access, read, or modify the protected custom settings. Database.com Editions.
Note: Protected custom settings in an unmanaged package behave like public custom Packages are not available
settings. Make sure that secrets, personally identifying information, or any private data are in Database.com.
stored in protected custom metadata types that are installed as part of a managed package.
Outside of a managed package, use named credentials or encrypted custom fields to store
secrets like OAuth tokens, passwords, and other confidential material.

Visibility
You can create protected custom settings in developer and scratch orgs. The options for custom settings are.
• Protected—Custom settings in a managed package are visible through Apex and formulas within the same package and namespace.
However, they are not visible to subscribing organizations through Apex and API. Custom settings contained in an unmanaged
package behave like public custom settings and don’t provide protection.
• Public—Regardless of the type of package (managed or unmanaged), the following have access:
– Apex
– Formulas
– Flows
– API for users with Customize Application permission or permissions granted through profiles or permission sets.

Schema Settings
The schema setting options for custom settings are.
• Restrict access to custom settings—This org-wide preference is enabled by default and limits access to custom setting values. Admins
with Customize Application permission can grant Read access to users through profiles and permission sets using the Custom Setting
Definitions or View All Custom Settings permissions.
• Enable SOSL on custom settings—Custom settings values are not returned in Salesforce Object Search language (SOSL) queries. If
your Apex operations require this functionality, enable this option.

221
Extend Salesforce with Clicks, Not Code Create Custom Settings

Grant Permissions on Profiles or Permission Sets

The Restrict access to custom settings org-wide preference is enabled by default and Read access to custom settings must be explicitly
granted.
Admins with Customize Application permission can grant Read permission through profiles and permission sets to users without the
Customize Application permission.
• To grant permission to specific custom settings, use the Custom Setting Definitions permission.
• To grant permission to all custom settings, use the View All Custom Settings permission.

Behavior of Apex, Visualforce, and Aura

There are different execution code modes within Salesforce that affect the accessibility of custom settings.
Apex code that is run in system mode ignores user permissions and your Apex code is given access to all objects and fields. Object
permissions, field-level security, and sharing rules aren't applied for the current user. Running in system mode ensures that the code
doesn’t fail because of hidden fields or objects for a user.
In user mode, functionality such as Visualforce Components, Visualforce Email templates, and Aura, is run with respect to the user's
permissions and sharing of records.

Note: Functionality that runs in system mode, such as Apex, is not affected by the Restrict access to custom settings org preference.
Also, the with sharing modifier in the Apex class, doesn’t affect query behavior such as, isAccessible() and
isCreatable(). If a field value is retrieved in Apex and assigned to a non-sObject variable, the behavior is the same whether
the preference is enabled or not.
When functionality is run in user mode, such as Visualforce Components, Visualforce Email templates, and Aura, you must have permission
to access the custom settings. For example, without permission, the fields on Visualforce pages that you don't have access to aren’t
displayed. The $Setup global variable (available in Visualforce and formulas) continues to load values by direct reference (meaning,
data that is assigned to an sObject type) regardless of the running user.
Consider the following scenario:
1. Apex loads a record that is a row included in a variable such as MySetting__c.
2. What Visualforce displays is MySetting__c.MyPath__c.
3. Access checks are run when the page is loaded.
4. However, the checks are not run in system mode, which is the standard Visualforce behavior. Users without permission to the custom
settings can’t display the Visualforce page because Visualforce is reinitiating the access check.
In this scenario, if a user isn’t allowed permission to the custom setting, there are two workarounds. You can create a string for each
object, which can be passed through, or create a wrapper class. Use these options instead of assigning a variable such as MySetting__c,
then rendering mySetting.Path__c mySetting.Name. For example,
class DataHolder{
public string path {get;set;}
public boolean active {get;set;}
}

When you load the rows into a collection, the Visualforce checks are bypassed because the type is a data type instead of an sObject.
Here’s an example that includes the @AuraEnabled annotation for an Aura or Lightning components controller.
class with sharing MyController {
@AuraEnabled
public static List<My__mdt> thisWillNotWork() {

222
Extend Salesforce with Clicks, Not Code Create Custom Settings

return [select developername from my__mdt];

}
@AuraEnabled
public static List<String> thisWill() {
List<String> retVal = new List<String>();
for(My__mdt config: [select developername from my__mdt]) {
retVal.add(config.DeveloperName);
}
return retVal;
}
}

SEE ALSO:
Grant Permissions on Custom Settings
Access Custom Settings with Code
Grant Permissions on Custom Settings
Grant Read Access to All Custom Settings

Define Custom Settings

Create custom sets of data.
EDITIONS
Note: We strongly suggest using custom metadata types instead of custom settings. Unlike
list custom settings, you can migrate the records of custom metadata types using Available in: Salesforce
second-generation packages or Metadata API tools. Classic and Lightning
Experience.
To create a custom setting:
Available in: Group,
1. From Setup, enter Custom Settings in the Quick Find box, then select Custom
Professional, Developer,
Settings. Enterprise, Performance,
2. Click New. Unlimited, and
Database.com Editions.
Note: A icon indicates that the custom setting is in an installed managed package.
Packages are not available
You can’t edit or delete a protected custom setting installed from a managed package.
in Database.com.
3. Define the following:
• Label—Enter the label displayed in the application. USER PERMISSIONS
• Object Name—Enter the name to be used when the custom setting is referenced by
formula fields, validation rules, Apex, or SOAP API. To manage, create, edit,
and delete custom settings:
Note: Salesforce recommends using ASCII for the Object Name. The name can't • Customize Application
exceed 38 ASCII characters. If you use double byte, there are additional limits on the
number of characters allowed.

• Setting Type—Select a type of List or Hierarchy. After you save a custom setting, you can’t change this value.
– List—Defines application-level data, such as country codes or state abbreviations, and provides a reusable set of static
data that can be accessed across your organization. If you use a particular set of data frequently within your application,
putting that data in a list custom setting streamlines access to it. Data in list settings does not vary by profile or user, but it
is available organization-wide. Examples of list data include two-letter state abbreviations, international dialing prefixes, and

223
Extend Salesforce with Clicks, Not Code Create Custom Settings

catalog numbers for products. Because the data is cached, access is low-cost and efficient—you don't have to use SOQL
queries that count against your governor limits.
– Hierarchy—Uses a built-in hierarchical logic that lets you personalize settings for specific profiles or users. The hierarchy
logic checks the organization, profile, and user settings for the current user and returns the most specific, or lowest, value.
In the hierarchy, settings for an organization are overridden by profile settings, which, in turn, are overridden by user settings.

• Visibility—(Available in developer and scratch orgs) Select the visibility. After you save a custom setting, you cannot
change this value.
– Protected—If the custom setting is contained in a managed package, subscribing organizations can't see the custom
setting—it doesn't display as part of the package list. In addition, subscribing organizations can't access the custom setting
using Apex or the API. Custom settings can only be accessed by the Apex code that is part of the managed package. If the
custom setting is contained in an unmanaged package, they behave like public custom settings.
– Public—Regardless of the type of package (managed or unmanaged), the following have access:
• Apex
• Formulas
• Flows
• API for users with Customize Application permission or permissions granted through profiles or permission sets.

4. Enter an optional description of the custom setting. A meaningful description helps you remember the differences between your
custom settings when you view them in a list.
5. Click Save.
After you create a custom setting, add fields to the custom setting.

Add Custom Settings Fields

After you define custom settings, add fields to them. The custom fields contain the data used by the custom setting.
Create Custom Settings Records
After you define your custom settings and add fields, you can populate the fields with data.
Manage Custom Settings Data
After creating custom setting and adding fields, you can add records, then use the values in these records in your Apex code and
validation rules.

224
Extend Salesforce with Clicks, Not Code Create Custom Settings

Add Custom Settings Fields

After you define custom settings, add fields to them. The custom fields contain the data used by
EDITIONS
the custom setting.
1. From Setup, enter Custom Settings in the Quick Find box, then select Custom Available in: Salesforce
Settings. Classic and Lightning
Experience.
2. Click the custom setting that you want to add fields to. (If you just created the custom setting,
the Custom Setting Detail page appears.) Available in: Group,
3. Click New. Professional, Developer,
Enterprise, Performance,
4. Select a field type and click Next. Unlimited, and
Database.com Editions.
Note: Record size is based on the maximum field size of each field type, not the actual
storage that’s used in each field. When adding fields to a custom setting definition, use Packages are not available
the appropriate type and specify a length that doesn’t exceed what’s needed for your in Database.com.
data. This action helps you avoid reaching the cached data limit. For example, if you create
a US social security number (SSN) field, select the Text data type and specify a length
of 9. If you select a Text Area data type, the field would add 255 characters to the USER PERMISSIONS
usage count for each record, regardless of the number of characters entered. To manage, create, edit,
and delete custom settings:
5. Enter the details for the field.
• Customize Application
6. Confirm the information, and then click Save or Save & New.
After you add fields, add data, and for hierarchy custom settings, specify the access level.

SEE ALSO:
Create Custom Settings Records

Create Custom Settings Records

After you define your custom settings and add fields, you can populate the fields with data.
EDITIONS
You can define one or more data sets. For list custom settings, each data set is named and can be
accessed by that name using Apex, formula fields, and so on. Available in: Salesforce
Classic and Lightning
For custom settings that are hierarchies, the access level—user, profile, or organization—determines
Experience.
how you access the data. The user level is the lowest level, so it is used first, unless otherwise specified
in your application. For example, you can specify different contact numbers for your application: Available in: Group,
one for the general user, and one that is only displayed for system administrators. Professional, Developer,
Enterprise, Performance,
To add data to custom setting fields:
Unlimited, and
1. From Setup, enter Custom Settings in the Quick Find box, select Custom Settings, Database.com Editions.
then click Manage next to a custom setting. Or from the detail page for a custom setting, click
Packages are not available
Manage.
in Database.com.
2. Click New or Edit next to an existing data set.
3. Add or change data.
USER PERMISSIONS
For custom settings that are lists:
Customize Application
a. Specify or change the name for the data set. This name is used by Apex, formula fields, and
•
so on.
b. Enter or change data for all fields.

225
Extend Salesforce with Clicks, Not Code Create Custom Settings

c. Click Save.
For custom settings that are hierarchies:
a. For the default organization level values, enter or change the data for the fields. The default organization location is automatically
populated.
b. For profile or user level values, select either Profile or User from the Location picklist. Enter the name of the profile
or user, or use the lookup dialog search. Then enter or change the data for the fields.
c. Click Save.

Note: For a hierarchy custom setting, you can add only one record for a profile or user. Adding two records for the same
profile or user results in an error.

SEE ALSO:
Manage Custom Settings Data
Add Custom Settings Fields

Manage Custom Settings Data

After creating custom setting and adding fields, you can add records, then use the values in these
EDITIONS
records in your Apex code and validation rules.
1. From Setup, enter Custom Settings in the Quick Find box, then select Custom Available in: Salesforce
Settings. Classic and Lightning
Experience.
2. Click Manage next to a custom setting, or from the detail page for a custom setting.
3. Provide or change values for the custom setting. Available in: Group,
Professional, Developer,
• If you are managing a list setting: Enterprise, Performance,
– To add data to the fields, click New. Unlimited, and
Database.com Editions.
– To change the name of the data set or to change the data, click Edit next to the name
of an existing set of data. Packages are not available
in Database.com.
– To delete the data set, click Delete next to the name of an existing set of data.

• If you are managing a hierarchy setting, decide where in the permission hierarchy you want
to add default data (organization, profile, or user). USER PERMISSIONS
To add default data at the organization level, click New in the Default Organization Level Customize Application
Value section. If data has already been defined for the organization, you can only edit or •
delete it.
To add default data at the profile or user level, click New in the lower section of the page,
near the Setup Owner.

After you define data:

• To change the default data set at the organization level, click Edit in the Default Organization Level Value section.
• To delete the data set (only for hierarchical custom settings), click Delete in the Default Organization Level Value section.

226
Extend Salesforce with Clicks, Not Code Create Custom Settings

• To view the data (only for hierarchical custom settings), click View next to the name of an existing set of data.

SEE ALSO:
Custom Settings Limits and Considerations

View and Edit Custom Settings

After you create a custom setting, you can view the details of the custom setting, manage the
EDITIONS
custom setting, and add fields.
From Setup, enter Custom Settings in the Quick Find box, then select Custom Settings, Available in: Salesforce
then click the name of the custom setting you'd like to view. While viewing a custom setting, you Classic and Lightning
can: Experience.

• To change a custom setting, click Edit. Available in: Group,

• To delete a custom setting, click Delete. Professional, Developer,
Enterprise, Performance,
Note: A icon indicates that the custom setting is in an installed managed package. Unlimited, and
You can’t edit or delete a protected custom setting installed from a managed package. Database.com Editions.

• To add data to a custom setting, click Manage. Packages are not available
in Database.com.
• To add fields and data to the custom setting, click New.

SEE ALSO: USER PERMISSIONS

Create Custom Settings Records To manage, create, edit,
Add Custom Settings Fields and delete custom settings:
• Customize Application

View Custom Settings Usage and Data

View the percentage of custom settings data your org has used.

View the System Usage Data

View the number of custom objects and custom settings in your org, including installed objects from AppExchange.
View the Percentage of Custom Settings Data
View the percentage of custom settings data used in your organization, out of an allowed limit.

227
Extend Salesforce with Clicks, Not Code Create Custom Settings

View the System Usage Data

View the number of custom objects and custom settings in your org, including installed objects
EDITIONS
from AppExchange.
1. From Setup, enter System Overview in the Quick Find box, then select System Available in: Salesforce
Overview. Classic and Lightning
Experience.
2. In the Schema section, you see the number of custom object and custom settings:
• Your Custom Objects and Custom Settings—The number of custom object and custom Available in: Group,
settings you created. The edition of Salesforce used determines the limit. Professional, Developer,
Enterprise, Performance,
• Total Custom Objects and Total Custom Settings—Total number of custom objects and Unlimited, and
custom settings in your org, and it includes objects installed from AppExchange managed Database.com Editions.
packages.
Packages are not available
in Database.com.

View the Percentage of Custom Settings Data

View the percentage of custom settings data used in your organization, out of an allowed limit.
EDITIONS
1. From Setup, enter Custom Settings in the Quick Find box, then select Custom
Settings. Available in: Salesforce
Classic and Lightning
2. To view the percentage of custom settings data your org has used, click Get Usage. Once the
Experience.
usage information is returned, the button no longer appears on the page.
3. To manage a custom setting, click Manage next to a previously defined custom setting, and Available in: Group,
click View next to the data set you want to view. (only for hierarchical custom settings.) Professional, Developer,
Enterprise, Performance,
Unlimited, and
Database.com Editions.
Packages are not available
in Database.com.

Grant Permissions on Custom Settings

By default, access to custom settings is limited through the Restrict access to custom
EDITIONS
settings org-wide preference. Admins can grant API Read access through profiles and permission
sets to users without the Customize Application permission. Available in: Salesforce
1. From Setup, enter Schema Settings in the Quick Find box, and make sure that the Classic and Lightning
Restrict access to custom settings org permission is enabled. Experience.

2. Enter User Management Settings in the Quick Find box, and enable Enhanced Available in: Group,
Profile User Interface. Professional, Developer,
This setting provides a uniform and streamlined interface, but isn’t a requirement for granting Enterprise, Performance,
Unlimited, and
permissions.
Database.com Editions.
3. Enter Profiles or Permission Sets in the Quick Find box. Packages are not available
4. Click the name of the profile or permission set that you want to edit. in Database.com.

5. Click Custom Setting Definitions.

6. Click Edit.

228
Extend Salesforce with Clicks, Not Code Create Custom Settings

7. Add the custom setting to the Enabled Custom Setting Definitions list.
8. Click Save.

Grant Read Access to All Custom Settings

Admins with the Customize Application permission can grant API read access to all custom settings.
EDITIONS
1. From Setup, enter Schema Settings in the Quick Find box, and make sure that the
Restrict access to custom settings org permission is enabled. Available in: Salesforce
Classic and Lightning
2. Enter User Management Settings in the Quick Find box, and enable Enhanced
Experience.
Profile User Interface.
This setting provides a uniform and streamlined interface, but isn’t a requirement for granting Available in: Group,
permissions. Professional, Developer,
Enterprise, Performance,
3. Enter Profiles or Permission Sets in the Quick Find box. Unlimited, and
4. Click the name of the profile or permission set that you want to edit. Database.com Editions.
Packages are not available
5. Click System permissions.
in Database.com.
6. Check the View All Custom Settings permission.
7. Click Save.
USER PERMISSIONS

To grant access to custom

settings:
• Customize Application

Access Custom Settings with Code

You can access custom settings from Apex, SOAP API, and formulas.
EDITIONS
Note: Formulas include: flows, workflow rules, approval processes, validation rules, formula
fields, and Process Builder processes. Available in: Salesforce
Classic and Lightning
Here are some sample code segments: Experience.
Formula Fields
Available in: Group,
Formula fields only work for hierarchy custom settings; they can’t be used for list custom settings.
Professional, Developer,
Enterprise, Performance,
Unlimited, and
Database.com Editions.
Packages are not available
in Database.com.

{!$Setup.CustomSettingName__c.CustomFieldName__c}

Apex
Apex can access both custom setting types.

229
Extend Salesforce with Clicks, Not Code Create Custom Settings

Samples for List Custom Settings

When you add data to a custom setting, name each data set so that you can distinguish them. The following returns a map of
custom settings data. The getAll method returns values for all custom fields associated with the list setting.

Map<String_dataset_name, CustomSettingName__c> mcs = CustomSettingName__c.getAll();

The following example uses the getValues method to return all the field values associated with the specified data set. This
method can be used with list and hierarchy custom settings, using different parameters.

CustomSettingName__c mc = CustomSettingName__c.getValues(data_set_name);

Samples for Hierarchy Custom Settings

The following example uses the getOrgDefaults method to return the data set values for the organization level:

CustomSettingName__c mc = CustomSettingName__c.getOrgDefaults();

The following example uses the getInstance method to return the data set values for the specified profile. The
getInstance method can also be used with a user ID.

CustomSettingName__c mc = CustomSettingName__c.getInstance(Profile_ID);

SOAP API
Custom settings that have Privacy defined as Public have the same type of exposure to the API as custom objects. When a
custom setting is contained in a managed package, and Privacy for a custom setting is Protected, the settings can only be
accessed by the Apex code or formulas that are part of the managed package.

Note: You can also access custom settings data through a Standard Object Query Language (SOQL) query, but this method
doesn't use the application cache. It’s similar to querying a custom object.

SEE ALSO:
Grant Permissions on Custom Settings

Custom Settings Limits and Considerations

When working with custom settings, be aware of the following considerations and limits on the amount of cached data.
• Custom settings are a type of custom object. Each custom setting counts against the total number of custom objects available for
your organization.
• The total amount of cached data allowed for your org is the lesser of these two values:
– 10 MB
– 1 MB multiplied by the number of full-featured user licenses in your org
For example, if your org has three full licenses, you have 3 MB of custom setting storage. If your org has 20 full licenses, you have 10
MB of storage.
Each certified managed package gets a separate limit in addition to your org limit. Each certified managed package gets the same
limit as the org, based on the number of licenses up to 10 MB. For example, let’s say your org has two certified managed packages
installed and you have three full licenses. Each certified managed package can have 3 MB of custom setting storage in addition to
your org’s 3 MB custom setting storage limit.
The org custom setting limits and certified managed package custom setting limits aren’t shared.
– Custom settings that are added to an org via a certified managed package count against that package’s storage limit.
– Custom settings that are added to an org directly or from a non-certified managed package count against the org’s storage limit.

230
Extend Salesforce with Clicks, Not Code Customize Fields

Using the previous example, if you have three full licenses, one non-certified managed package, and two certified managed packages,
your custom settings storage limits are: 3 MB combined for the org and non-certified managed package, and 3 MB for each certified
managed package.

• You can add up to 300 fields per custom setting, unless your field limit for custom objects is lower than 300. If your custom objects
field limit is lower than 300, your field limit for custom settings is equal to your custom objects field limit.
• You can’t share a custom setting object or record.
• No owner is assigned when a custom setting is created, so the owner can’t be changed.
• Accessing an undeleted custom setting in a formula field results in an error if the user doesn’t have the “Customize Application”
permission. To prevent this error, redeploy this custom setting to the organization. Alternatively, delete this custom setting, re-create
it with the same name and data, and then delete and re-create all formula fields that use this setting.
• If a cross-object formula references a currency field from a custom setting, this field value isn’t converted to the currency of the
record containing the formula. An inaccurate formula result is possible if the custom setting field’s currency and the record's currency
are different.
• You can’t disable specific permissions with a muting permission set.
To see how much custom settings data your organization is using, from Setup, enter Custom Settings in the Quick Find
box, then select Custom Settings. For each custom setting, this page lists the size of one record, the number of records created, and
the total size used for each custom setting.
Record size is based on the maximum field size of each field type, not the actual storage that’s used in each field. When adding fields to
a custom setting definition, use the appropriate type and specify a length that doesn’t exceed what’s needed for your data. This action
helps you avoid reaching the cached data limit. For example, if you create a US social security number (SSN) field, select the Text data
type and specify a length of 9. If you select a Text Area data type, the field would add 255 characters to the usage count for each
record, regardless of the number of characters entered.

Note: A icon indicates that the custom setting is in an installed managed package. You can’t edit or delete a protected custom
setting installed from a managed package.

Customize Fields
Customize standard and custom fields to tailor your org to your own unique requirements.
EDITIONS
You can:
Available in: both Salesforce
• Modify some aspects of standard fields
Classic and Lightning
• Change or add values to standard and custom picklist fields Experience
• Define dependency rules between fields
Available in: All Editions
• Create custom fields to capture additional information
Standard Fields and Page
• Create formula fields that automatically calculate values based on the contents of other fields Layouts are not available in
• Define default values for custom fields Database.com
• Define validation rules for your fields
• Make a field required
USER PERMISSIONS
• Set fields to track changes, including the date, time, nature of the change, and who made the
change To create or change custom
fields:
• Create page layouts to control the display of fields
• Customize Application
• Set field-level security to control access to fields
• Create or modify field sets

231
Extend Salesforce with Clicks, Not Code Customize Fields

Customize Standard Fields

You can customize several aspects of standard fields, such as the values in picklists, the format for auto-number fields, tracking field
history, lookup filters on relationship fields, and field-level help.
Capturing Gender-Related Data with Standard Fields
Represent the diversity of your customer base by recording gender-related data in Salesforce. Use standard, optional fields with
vetted value sets to help you personalize your data, build trust, and close data gaps in your system of record.
Modify Standard Auto-Number Fields in Salesforce Classic
Custom Fields
Create Custom Fields
Capture your unique business data by storing it in custom fields. When you create a custom field, you configure where you want it
to appear and optionally control security at the field level.
Define Default Field Values
Define a default value for a field. Use a formula to generate dynamic values or constants for static values.
Validation Rules
Examples of Validation Rules
Review examples of validation rules for various types of apps that you can use and modify for your own purposes. Validation rules
verify that the data a user enters in a record meets the standards you specify before the user can save the record.
Require Field Input to Ensure Data Quality
Improve the quality of data that users enter in Salesforce by creating universally required fields.
About Field Sets
Roll-Up Summary Field
A roll-up summary field calculates values from related records, such as those in a related list. You can create a roll-up summary field
to display a value in a master record based on the values of fields in a detail record. The detail record must be related to the master
through a master-detail relationship. For example, you want to display the sum of invoice amounts for all related invoice custom
object records in an account’s Invoices related list. You can display this total in a custom account field called Total Invoice Amount.
Lookup Filters
Improve user productivity and data quality with lookup filters. Lookup filters are administrator settings that restrict the valid values
and lookup dialog results for lookup, master-detail, and hierarchical relationship fields.
Fields: What’s Different or Not Available in the Salesforce Mobile App
Not every Lightning Experience feature is in the Salesforce mobile app. Find out what’s different.

232
Extend Salesforce with Clicks, Not Code Customize Fields

Customize Standard Fields

You can customize several aspects of standard fields, such as the values in picklists, the format for
EDITIONS
auto-number fields, tracking field history, lookup filters on relationship fields, and field-level help.

Tip: You can’t delete standard fields, but you can remove them from your page layouts. Available in: both Salesforce
Classic and Lightning
1. Navigate to the fields page for your object. Experience
2. Click the field label. Available in: All Editions
3. To add custom help text, click Edit. except for Database.com.

4. On the field’s information page, you can—depending on your Edition—set field-level security,
view accessibility settings, and configure validation rules. USER PERMISSIONS
You can also do more, depending on the field’s type. For example, if the field is a picklist, you To change standard fields:
can add, delete, and reorder its values, and set dependencies. You can’t increase the field length • Customize Application
of a standard field. If you need a longer text area, consider creating a custom field.

Note: What does that Indexed checkbox mean on a field, and how did it get there?
If a field is indexed, you can use sidebar search or advanced search to find values in the field.
Having a field indexed can also speed up other operations on the field, such as reporting.
Check out this blog post to find out more: Know Thy Salesforce Field Indexes for Fast Reports,
List Views, and SOQL.

SEE ALSO:
Custom Fields
Add or Edit Picklist Values
Rename Object, Tab, and Field Labels
Field-Level Help
Lookup Filters

Capturing Gender-Related Data with Standard Fields

Represent the diversity of your customer base by recording gender-related data in Salesforce. Use standard, optional fields with vetted
value sets to help you personalize your data, build trust, and close data gaps in your system of record.

Considerations and Guidelines for Capturing Gender-Related Data

Capturing demographic information boosts data quality, builds trust, and allows you to personalize offerings to retain and attract
new customers. But release of gender information could result in safety concerns for individuals, or liability issues for your company.
It’s important to classify your data correctly so you can protect it.
Capture Gender-Related Data
Set up the Gender Identity and Pronouns fields on the Lead, Contact, and Person Account objects to record gender-related data.
And, add nonbinary honorifics like Mx. to the Salutation picklist value list to keep the data in sync. You can customize aspects of
these fields to suit the unique needs of your company.

233
Extend Salesforce with Clicks, Not Code Customize Fields

Considerations and Guidelines for Capturing Gender-Related Data

Capturing demographic information boosts data quality, builds trust, and allows you to personalize
EDITIONS
offerings to retain and attract new customers. But release of gender information could result in
safety concerns for individuals, or liability issues for your company. It’s important to classify your Available in: both Salesforce
data correctly so you can protect it. Classic (not available in all
Pronouns and Gender Identity are standard fields on the Lead, Contact, and Person Account objects. orgs) and Lightning
Non-binary picklist values on the Salutation field help keep all your data in sync. Before setting up Experience
these fields, ask yourself if it’s necessary for your use cases. Discuss your goals with project Available in: All editions
stakeholders, and take measures to ensure the data can’t inadvertently be used to discriminate.
Always review the privacy and legal ramifications with your legal department, and refer to your
industry’s standards for guidance. USER PERMISSIONS
When you’ve decided to gather pronouns or gender identity data from your customers, follow To customize standard
these guidelines: fields:
• Explain why you’re asking for this specific information. • Customize Application

• Describe how the data is used.

• Offer how it benefits them to share their personal information with you.
• Indicate how their data is protected.
• Give customers an option to opt out.
• Set up data classification levels.
• Manage access to the fields and to the data within them.
• To prevent mismatched data, add custom business processes.

SEE ALSO:
Classify Sensitive Data to Support Data Management Policies
Store Customers’ Data Privacy Preferences
Manage Data Access
Control User Access to Fields
Capture Gender-Related Data

Capture Gender-Related Data

Set up the Gender Identity and Pronouns fields on the Lead, Contact, and Person Account objects
EDITIONS
to record gender-related data. And, add nonbinary honorifics like Mx. to the Salutation picklist value
list to keep the data in sync. You can customize aspects of these fields to suit the unique needs of Available in: both Salesforce
your company. Classic (not available in all
orgs) and Lightning
Note: Review your data classification settings and assess legal and privacy considerations
Experience
before collecting and storing gender-related data.
1. From the object management settings for the object, go to Fields and Relationships. Next, click Available in: All editions
the name of the field you want to set up.
2. Customize the Data Sensitivity Level field, Compliance Categorization field, and Help Text field. USER PERMISSIONS
3. Add or edit picklist values. To customize standard
4. Add the fields to page layouts. fields:
• Customize Application

234
Extend Salesforce with Clicks, Not Code Customize Fields

5. Set the field level security.

SEE ALSO:
Considerations and Guidelines for Capturing Gender-Related Data
Customize Standard Fields
Add or Edit Picklist Values
Page Layouts
Field-Level Security

Modify Standard Auto-Number Fields in Salesforce Classic

The unique identifiers for solution, case, and contract records are standard auto-number fields. Each
EDITIONS
record is assigned a unique number with a specified format upon creation. You can modify the
format and numbering for these auto-number fields in Salesforce Classic. Available in: Salesforce
1. From Setup, enter the name of the object whose field you want to modify in the Quick Find Classic (not available in all
box, then select Fields. orgs)

2. Click Edit next to the name of the auto-number field. Available in: Contact
For example, for cases, edit the Case Number field. Manager, Group,
Professional, Enterprise,
3. Enter a Display Format to control such formatting details as the minimum number of leading Performance, Unlimited,
zeros as well as any prefix or suffix for the number. For more information, see Custom Field and Developer Editions
Attributes on page 252.
Format changes don’t affect existing records; they’re applied only to new records. USER PERMISSIONS

4. Enter the number to be assigned to the next record that is created after you save your changes. To modify standard
auto-number fields:
5. Click Save.
• Customize Application
Warning: Salesforce warns you if the next number you enter isn’t higher than existing
numbers. However, it‘s possible to create duplicate numbers if you change the auto-number
format multiple times using similar formats each time.

SEE ALSO:
Custom Field Types

235
Extend Salesforce with Clicks, Not Code Customize Fields

Custom Fields
You can add custom fields for each of the objects that your Salesforce org uses.
EDITIONS
The number of custom fields allowed per object varies according to your Salesforce Edition. For the
total custom fields that you can create, see Custom Fields Allowed Per Object on page 250. Available in: both Salesforce
Classic (not available in all
When your org is close to the limit of 800 custom fields and you delete or create fields, field creation
orgs) and Lightning
can fail. The physical delete process reclaims and cleans fields, making them count temporarily
Experience
toward the limit. The delete process runs only when the queue is full, so it can take days or weeks
to start. In the meantime, the deleted fields are still counted as part of the limit. To request immediate Available in: All Editions
deletion of fields, contact Salesforce Support.
Don’t add a field dependency between managed custom fields in your org, as it can cause errors. USER PERMISSIONS

To create or change custom

SEE ALSO: fields:
Create Custom Fields • Customize Application
Edit Custom Fields
Additional Custom Field Options
Custom Field Attributes

236
Extend Salesforce with Clicks, Not Code Customize Fields

Create Custom Fields

Capture your unique business data by storing it in custom fields. When you create a custom field,
EDITIONS
you configure where you want it to appear and optionally control security at the field level.

Important: Where possible, we changed noninclusive terms to align with our company Available in: both Salesforce
value of Equality. We maintained certain terms to avoid any effect on customer Classic (not available in all
orgs) and Lightning
implementations.
Experience
Watch a Demo: How to Create a Custom Field in Salesforce
Available in: Contact
Want to customize Salesforce so it captures all your business data? This short video walks you Manager,Essentials, Group,
through how to create a custom picklist field, from choosing the correct field type to applying field Professional, Enterprise,
level security. Performance, Unlimited,
Watch a Demo: How to Add a Custom Field in Salesforce (Lightning Experience) Developer, and
Database.com Editions
Want to add and arrange a new field while viewing an individual record for an object? This short
video walks you through creating a picklist field while viewing a contact, and then changing the Salesforce Connect external
objects are available in:
page layout for the field.
Developer Edition and for
Before you begin, determine the type of field you want to create. an extra cost in: Enterprise,
Performance, and
Note: When you’re close to the limit of 800 custom fields and you delete or create fields,
Unlimited Editions
field creation can fail. The physical delete process reclaims and cleans fields, making them
count temporarily toward the limit. The delete process runs only when the queue is full, so Custom fields aren't
it can take days or weeks to start. In the meantime, the deleted fields are still counted as part available on Activities in
of the limit. To request immediate deletion of fields, contact Salesforce Support. Group Edition
Custom settings aren't
1. From the management settings for the object you want to add a field to, go to Fields. Custom
available in Professional
task and event fields are accessible from the object management settings for Activities.
Edition
2. Click New.
Layouts aren't available in
Tip: On custom objects, you can also set field dependencies and field history tracking in Database.com
this section.

3. Choose the type of field and click Next. Note these considerations. USER PERMISSIONS
• Some data types are available for certain configurations only. For example, the To create or change custom
Master-Detail Relationship option is available for custom objects only when fields:
the custom object doesn’t already have a master-detail relationship. • Customize Application
• Custom settings and external objects allow only a subset of the available data types. To add field-level security to
• You can’t add a multi-select picklist, rich text area, or dependent picklist custom field to profiles or permission sets:
opportunity splits. • Manage Profiles and
Permission Sets
• Relationship fields count toward custom field limits.
• Additional field types can appear if an AppExchange package using those field types is
installed.
• The Roll-Up Summary option is available on certain objects only.
• Field types correspond to API data types.
• If your organization uses Shield Platform Encryption, ensure that you understand how to encrypt custom fields using the Shield
Platform Encryption offering.

4. For relationship fields, associate an object with the field and click Next.

237
Extend Salesforce with Clicks, Not Code Customize Fields

5. For indirect lookup relationship fields, select a unique, external ID field on the parent object, and then click Next. The parent field
values are matched against the values of the child indirect lookup relationship field to determine which records are related to each
other.
6. To base a picklist field on a global picklist value set, select the value set to use.
7. Enter a field label.
Salesforce populates Field Name using the field label. 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. Use the field name for merge fields in custom links, custom s-controls, and when referencing the field
from the API.

Tip: Ensure that the custom field name and label are unique for that object.
• If standard and custom fields have identical names or labels, the merge field displays the custom field value.
• If two custom fields have identical names or labels, the merge field can display an unexpected value.
If you create a field label called Email and a standard field labeled Email exists, the merge field is unable to distinguish
between the fields. Adding a character to the custom field name makes it unique. For example, Email2.

8. To specify whether the field must be populated and what happens if the record is deleted, enter field attributes and select the
appropriate checkboxes.
9. For master-detail relationships on custom objects, optionally select Allow reparenting to allow a child record in the master-detail
relationship to be reparented to a different parent record.
10. For relationship fields, optionally create a lookup filter to limit search results for the field. Not available for external objects.
11. Click Next.
12. In Enterprise, Unlimited, Performance, and Developer Editions, specify the field’s access settings for each profile or permission set,
and click Next.

Note: To specify the field’s access settings for permission sets instead of profiles, enable Field-Level Security for Permission
Sets during Field Creation on the User Management Settings page.
If you specify access for permission sets, select Permission sets with object permissions to filter the list to permission sets
that have Create, Read, Edit, or Delete access on the field’s object. To show all permission sets, deselect this option. If no
permission sets have object permissions for the field’s object, the list contains all permission sets.

Access Level Enabled Settings (Profiles) Enabled Settings (Permission Sets)

Users can read and edit the field. Visible Edit Access (Read Access is selected
automatically)

Users can read but not edit the field. Visible and Read-Only Read Access

Users can’t read or edit the field. None None

• When you create a custom field, by default the field isn’t visible or editable for portal profiles, unless the field is universally
required.

13. To show the editable field, choose the page layouts and click Next.

238
Extend Salesforce with Clicks, Not Code Customize Fields

Field Location on Page Layout

Normal Last field in the first two-column section.

Long text area End of the first one-column section.

User Bottom of the user detail page.

Universally required Can’t remove it from page layouts or make read only.

14. For relationship fields, optionally click Related List Label and enter a new name to create an associated records related list, then
add it to page layouts for that object. To add the related list to customized page layouts, select Append related list to
users’ existing personal customizations.
15. Click Save to finish or Save & New to create more custom fields.

Note: Creating fields can require changing a large number of records at once. If your request is queued to process these changes
efficiently, you receive an email notification when the process has completed.

Create a Custom Picklist Field

Create custom picklist fields to let your users select values from lists that you define.
Create a Global Picklist Value Set
Use global picklist value sets to share values across objects and custom picklist fields, and to restrict the picklists to only the values
that you specify.
Make Your Custom Picklist Field Values Global
When you create a custom picklist, it’s only available to the current object. To share the values with other objects, promote the
picklist to a global value set. The original custom picklist references the global value set for its values, and the global value set is also
available to other custom picklists.
Custom Field Types
Salesforce supports many different field types. Pick the right type, or convert an existing one.
What’s the Difference between Standard Fields and Custom Fields?
You can add custom fields to standard and custom objects in Salesforce, allowing you to infinitely customize your organization.
Although custom fields are similar to the standard fields that come built-in to Salesforce, there are some differences between standard
fields and custom fields.
Custom Fields Allowed Per Object
The number of custom fields allowed per object varies according to your Salesforce Edition.
Custom Field Attributes
A custom field entry consists of several attributes.
Custom Address Fields
Improve address data accuracy and the end-user experience with Custom Address Fields. Users can populate a custom address fields
manually or they can use the Google lookup to search for an address. Admins and APIs can access each address stored in a custom
address field as a structured compound data type as well as individual address components.
Geolocation Custom Field
The geolocation custom field allows you to identify locations by their latitude and longitude and to calculate distances between
locations.

239
Extend Salesforce with Clicks, Not Code Customize Fields

Time Custom Field

Track time, unbound to a date, with this custom field type. The time type is useful for time management, event planning, and project
management.
Manage Fields for a Specific Object
Edit Custom Fields
Delete Fields
Manage Deleted Custom Fields
Deleted custom fields and their data are stored until your org permanently deletes them or 15 days have elapsed, whichever happens
first. Until that time, you can restore the field and its data.
Purge Deleted Custom Fields
Deleted fields are available for 15 days until they’re hard deleted. During that time, the field continues to count toward your custom
field allocation. You can use the Purge button to initiate the hard-delete process and free up custom field allocation for your org.
Additional Custom Field Options
Editing Rich Text Area Fields in Records
Use rich text area fields to improve the appearance of text, including adding images and hyperlinks.
Rich Text Area Field Limitations
Keep these limitations in mind when working with rich text area fields.
Valid Range for Date Fields
Classic Encryption for Custom Fields
Restrict other Salesforce users from seeing custom text fields that you want to keep private. Only users with the View Encrypted Data
permission can see data in encrypted custom text fields.
Add or Edit Picklist Values
Add or edit values in a custom picklist from the fields area of an object. If the picklist uses a global picklist value set, you can change
its values only by editing the global value set. Your changes affect all picklists that inherit their values from that global value set.
Define Dependent Picklists
Specify the dependent picklists and their values for your org.
Rich Text Editor
Use the rich text editor to format text in custom fields with the rich text area type. You can also use the rich text editor in many other
features, such as Chatter publisher and groups.

240
Extend Salesforce with Clicks, Not Code Customize Fields

Change the Custom Field Type

SEE ALSO:
External Object Relationships
Which Standard Fields Can I Encrypt?
Which Custom Fields Can I Encrypt?
What’s the Difference Between Classic Encryption and Shield Platform Encryption?
Encrypt New Files and Attachments
Find Object Management Settings
Map Custom Lead Fields for Lead Conversion
Specify Lookup Search Filter Fields
Enable Field-Level Security for Permission Sets during Field Creation
Set Field-Level Security for a Field on All Permission Sets

Create a Custom Picklist Field

Create custom picklist fields to let your users select values from lists that you define.
EDITIONS
Watch a Demo: Custom Fields: Picklists
Available in: Salesforce
You can create these types of picklist fields:
Classic and Lightning
• Local picklist—Lets users select a single value from a list that you define. This picklist is unique Experience
and had its own set of values.
Available in: All Editions
• Shared picklist—Lets users select a single value from a global picklist value set that you define
in Setup. All custom picklist fields that use a global value set inherit its values and can’t have
additional values. USER PERMISSIONS
• Multi-select picklist—Allows users to select more than one picklist value from a list that you To create or change custom
define. These fields display each value separated by a semicolon. fields:
Note: You can’t add a multi-select picklist, rich text area, or dependent picklist custom field • Customize Application
to opportunity splits.
1. Go to the fields area of the object you want to create a picklist field for.
2. In the custom fields related list, click New.
3. Select Picklist or Picklist (Multi-Select), and then click Next.
4. Enter a label for the picklist field.
5. To use the values from an existing global picklist, select Use global picklist value set. To use values that you create specifically for
this picklist, select Enter values for the picklist, with each value separated by a new line.

Tip: Provide feedback and suggestions for global picklists in the Global, Restricted Custom Picklists group in the Salesforce
Trailblazer Community.

6. If you didn’t use a global picklist value set, enter picklist values.
Put each value on a separate line. Values can be up to 255 characters long.

7. Optionally, sort the values alphabetically or use the first value in the list as the default value, or both.
If you select both options, Salesforce alphabetizes the entries and then sets the first alphabetized value as the default.

241
Extend Salesforce with Clicks, Not Code Customize Fields

Note: Don’t assign default values to fields that are both required and unique, because uniqueness errors can result. See Default
Field Values on page 316.
You can use a formula to assign a default value dynamically. For example, you can assign a value based on the current user. The
following formula sets an Opportunity priority to High for all users in the Fast Response Sales profile. Other users see the default
listed in the Values set.
IF($Profile.Name = "Fast Response Sales", "High", "")
For picklists, a valid formula result is either a constant or the API name of an entry in the Values list. The formula result has higher
precedence than the default assigned in the Values list. If the formula doesn’t generate a valid result, the default assigned in the
Values list is entered in the field. If a default isn’t assigned to the Values list, no value is entered in the picklist field.

8. Choose whether to restrict this picklist’s values to an admin-approved list. Selecting Restrict picklist to the values defined in the
value set prevents users from loading unapproved values through the API. When you set a picklist to be unrestricted, users can't
enter new values through the user interface, but they can add new values via the API, automation, or other apps.
9. If you’re creating a multi-select picklist, enter how many values you want displayed at a time on edit pages. The number of values
determines the box height.
10. Enter description or help text if desired, and then click Next.
11. Set field-level security for the picklist field, and then click Next.
12. Choose the page layouts on which to include the picklist field.
13. Save your changes.

SEE ALSO:
Create Custom Fields
Add or Edit Picklist Values
Create a Global Picklist Value Set
Make Your Custom Picklist Field Values Global

Create a Global Picklist Value Set

Use global picklist value sets to share values across objects and custom picklist fields, and to restrict
EDITIONS
the picklists to only the values that you specify.

Note: Give your feedback and suggestions for global picklists in the Global, Restricted Custom Available in: Salesforce
Picklists group in the Salesforce Trailblazer Community. Classic and Lightning
Experience
A custom picklist is tied to a particular object as a field on the object. Unlike a custom picklist field,
a global picklist exists independently as a global picklist value set. Its values are shared with any Available in: All Editions
picklist that’s based on it.
A global picklist is a restricted picklist by nature. Only a Salesforce admin can add to or modify its USER PERMISSIONS
values. Users can’t add unapproved values, even through the API.
To create or change custom
Note: Global picklist value sets limits: fields:
• Customize Application
• Global picklist value sets have a combined active and inactive limit of 1,000.
• You can have up to 500 picklist global value sets in an org.
• There’s no limit on the number of custom picklists that use global picklist value sets.

242
Extend Salesforce with Clicks, Not Code Customize Fields

• If you apply a global picklist value set to more than 13 different objects, you can deactivate values from the picklist value set,
but you can’t replace any picklist values or delete values from the set.

1. From Setup, enter Picklist in the Quick Find box, then select Picklist Value Sets.
2. Next to Global Value Sets, click New.
3. Enter a label for the global value set. This name appears in Setup, and when users create a picklist based on this global value set.
4. To tell users what these values are for, enter a specific description of the global value set. This text appears on the Picklist Value Sets
list page in Setup.
5. Enter the values, one per line.
6. Optionally choose to sort the values alphabetically or to use the first value in the list as the default value, or both.
If you select both options, Salesforce alphabetizes the entries and then sets the first alphabetized value as the default.

7. Click Save.
Your global value set is ready to be used in custom picklist fields. To arrange values or re-alphabetize them, use Reorder.
To create a picklist that uses a global picklist value set, see Create a Custom Picklist Field.
To see all the fields where this value set is used, look under Fields Where Used on the global picklist’s detail page.
You can’t undo a custom picklist field’s association with a global value set. If you need a picklist field to use a different global value set
or different individual values, delete the custom picklist field, and create a new one in its place.
As you add new values to an existing global picklist, you can add the new values to all record types that use the picklist. Select Add the
new picklist values to all Record Types that use this Global Value Set; otherwise, you have to add the new values to existing records
types manually.

SEE ALSO:
Manage Inactive Picklist Values
Create a Custom Picklist Field
Make Your Custom Picklist Field Values Global

Make Your Custom Picklist Field Values Global

When you create a custom picklist, it’s only available to the current object. To share the values with
EDITIONS
other objects, promote the picklist to a global value set. The original custom picklist references the
global value set for its values, and the global value set is also available to other custom picklists. Available in: Salesforce
Note: After a picklist is promoted to a global value set, you can’t demote it. You manage the Classic and Lightning
Experience
values in the global value set or edit the custom picklist field to use different values.
1. Go to the fields area of the object you want to create a picklist field for. Available in: All Editions

2. In the Custom Fields related list, click Edit.

3. Click Promote to Global Value Set.
USER PERMISSIONS

To create or change custom

fields:
• Customize Application

243
Extend Salesforce with Clicks, Not Code Customize Fields

4. Enter a label for the global value set.

5. Accept the Field Name or edit it.
6. Optionally, enter a description to identify it when using the values for other custom picklists.
7. Click Promote to Global Value Set, again.
You can use the new global value set for other fields and manage the values in Picklist Value Sets.
When promoting a custom picklist, be aware of the following.
• You can promote fields that have up to 1,000 values (both active and inactive).
• You can promote only restricted picklists. To promote an unrestricted picklist, convert it to a restricted picklist.
• You cannot promote a field to an existing global value set.
• Picklist values translated using Translation workbench have a limit of 40 characters.
• For an app to help manage picklist values, see Picklist Field Merge Salesforce Lab App.
• You can’t undo a custom picklist field’s association with a global value set. If you need a picklist field to use a different global value
set or different individual values, delete the custom picklist field, and create a new one in its place.

SEE ALSO:
Create a Custom Picklist Field
Create a Global Picklist Value Set

Custom Field Types

Salesforce supports many different field types. Pick the right type, or convert an existing one.

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 you have data that doesn’t match any of the standard fields, your administrator can create a custom field for that data. For example,
use a Middle Name field for contacts.
The first step in creating a custom field is choosing the type of the field. This table includes a description of each custom field type.
Additional field types can appear if an AppExchange package using those field types is installed.

244
Extend Salesforce with Clicks, Not Code Customize Fields

Type Description
Address Lets users enter a street, city, state or province, zip or postal code, and country, or to search for an address
with an external tool. When a user selects an address using the tool, the street, city, state or province, zip
or postal code, and country are populated.

Auto Number Automatically assigns a unique number to each record. The maximum length of any auto-number field is
30 characters, 20 of which are reserved for prefix or suffix text. Not available for external objects.

Checkbox Lets users check a box, indicating a true or false attribute of a record. When using a checkbox field for a
report or list view filter, use “True” for checked values and “False” for unchecked values. The Data Import
Wizard and the weekly export tool use “1” for checked values and “0” for unchecked values.

Currency Lets users enter a currency amount. The system automatically formats the field as a currency amount. This
formatting is useful if you export data to a spreadsheet application. Not available for external objects.
Salesforce uses the round-half-to-even tie-breaking rule for currency fields. For example, 23.5 becomes 24,
22.5 becomes 22, −22.5 becomes −22, and −23.5 becomes −24.
Values lose precision after 15 decimal places.

Date Lets users enter a date or pick a date from a popup calendar. In reports, you can limit the data by specific
dates using any custom date field.

Date/Time Lets users enter a date or pick a date from a popup calendar and enter a time of day. There are visual and
behavioral differences for Date/Time fields in Lightning Experience and Salesforce Classic. In Lightning
Experience, the date and time fields are separate, and the initial time is set to 12:00 PM when you select a
date in the calendar. In Salesforce Classic, the date/time field is a single field. You can set the field to the
current date and time by clicking the date and time link next to the field. The time of day includes AM or
PM notation. In reports, you can limit the data by specific dates and times using any custom date field.

Email Lets users enter an email address of up to 80 characters, which is validated to ensure proper format. If this
field is specified for contacts or leads, users can choose the address when clicking Send an Email.
You can't use custom email addresses for mass emails or list emails.
Emails sent to a record's custom email address fields aren't logged against that record.
This field can be encrypted using Shield Platform Encryption.

External Lookup When you create an external lookup relationship field, the standard External ID field on the parent external
Relationship object is matched against the values of the child’s external lookup relationship field. External object field
values come from an external data source.

Formula Lets users automatically calculate values based on other values or fields such as merge fields. Not available
for external objects.
Salesforce uses the round half up tie-breaking rule for numbers in formula fields. For example, 12.345
becomes 12.35 and −12.345 becomes −12.35.

Geolocation Lets users specify a location by its latitude and longitude. Geolocation is a compound field that counts
toward your org’s limits as three custom fields: one for latitude, one for longitude, and one for internal use.
Not available for external objects.

Hierarchical Relationship Creates a hierarchical lookup relationship between users. Lets users use a lookup field to associate one user
with another that doesn’t directly or indirectly refers to itself. For example, you can create a custom
hierarchical relationship field to store each user's direct manager.

245
Extend Salesforce with Clicks, Not Code Customize Fields

Type Description
Indirect Lookup An indirect lookup relationship links a child external object to a parent standard or custom object. When
Relationship you create an indirect lookup relationship field on an external object, you specify the parent object field
and the child object field to match and associate records in the relationship. Specifically, you select a custom
unique, external ID field on the parent object to match against the child’s indirect lookup relationship field.
The child lookup field’s value comes from an external data source.

Lookup Relationship Creates a relationship between two records so you can associate them with each other. For example,
opportunities have a lookup relationship with cases that lets you associate a particular case with an
opportunity.
• On a standard or custom object, a lookup relationship creates a field that allows users to click a lookup
icon and select another record from a window.
• On an external object, the lookup relationship field references 18-character Salesforce IDs that are stored
in an external data source. Those IDs are matched against the parent object to determine which records
are related to each other.
On the parent record, you can display a related list to show all the records that are linked to it. You can
create lookup relationship fields that link to users, standard objects, or custom objects. If a lookup field
references a record that has been deleted, Salesforce clears the value of the lookup field by default.
Alternatively, you can choose to prevent records from being deleted if they’re in a lookup relationship.
Lookup relationship fields aren’t available in Personal Edition.
Lookup relationship fields to campaign members aren’t available; however, lookup relationship fields from
campaign members to standard or custom objects are available.

Master-Detail Creates a relationship between records where the main record controls certain behaviors of the detail record
Relationship such as record deletion and security.
Not available for standard objects or external objects, although you can create a master-detail relationship
field on a custom object that links to a standard object.
Master-detail relationships can’t be used with campaign members.

Number Lets users enter any number. This number is treated as a real number and any leading zeros are removed.
Salesforce uses the round half up tie-breaking rule for number fields. For example, 12.345 becomes 12.35
and −12.345 becomes −12.34.
Salesforce rounds numbers referenced in merge fields according to the user’s locale, not the number of
decimal spaces specified in the number field configuration.
When you use Einstein Prediction Builder to build a prediction, a custom field is created for storing and
displaying the prediction scores on records. Or, you can create a predictive custom field manually, enable
it as an AI prediction field, and enter its name and label when building a prediction in Einstein Prediction
Builder. For example, display how likely a customer is to pay an invoice on time.
In Lightning Experience, custom objects can store more decimal places than you define. If you enter
90.678 on a field that accepts 2 decimal places, the number is displayed as 90.68 on the record form.
When you inline edit, the field shows the original input, 90.678. Similarly, the value is stored as 90.678 in
the database. In Salesforce Classic, the input 90.678 is saved as 90.68.

246
Extend Salesforce with Clicks, Not Code Customize Fields

Type Description
Percent Lets users enter a percentage number as a decimal—for example, 0.10. The system automatically converts
the decimal to a percentage—for example, 10%
Values lose precision after 15 decimal places. Also, if you enter a value with more than 15 decimal places
and add a percent sign to the number, a runtime error occurs.

Phone Lets users enter any phone number. Character limit is 40.
Salesforce automatically formats it as a phone number.
If you use Salesforce CRM Call Center, custom phone fields are displayed with the button, allowing
click-to-dial functionality. Therefore, Salesforce recommends that you don’t use a custom phone field for
fax numbers.
This field can be encrypted using Shield Platform Encryption.

Picklist Lets users select a single value from a list that you define. Available for external objects only with the
cross-org adapter for Salesforce Connect.

Picklist (Multi-select) Lets users select more than one picklist value from a list that you define. These fields display each value
separated by a semicolon. Available for external objects only with the cross-org adapter for Salesforce
Connect.

Roll-Up Summary Automatically displays the record count of related records or calculates the sum, minimum, or maximum
value of related records. The records must be directly related to the selected record and on the detail side
of a custom master-detail relationship with the object that contains the roll-up summary field. For example,
a custom field called “Total Number of Guests” displays the number of guest custom object records in the
Guests related list. Not available for external objects.

Text Lets users enter any combination of letters, numbers, or symbols. You can set a maximum length, up to
255 characters.
This field can be encrypted using Shield Platform Encryption.

Text (Encrypted) Lets users enter any combination of letters, numbers, or symbols that are stored in encrypted form. You
can set a maximum length of up to 175 characters. Encrypted fields are encrypted with 128-bit master keys
and use the Advanced Encryption Standard (AES) algorithm. You can archive, delete, and import your master
encryption key. To enable master encryption key management, contact Salesforce. Not available for external
objects.
This field can be encrypted using Classic Encryption. If your org uses Shield Platform Encryption, use Text
to create an encrypted text field.

Text Area Lets users enter up to 255 characters that display on separate lines similar to a Description field.

Text Area (Long) Lets users enter up to 131,072 characters that display on separate lines similar to a Description field.
You can set the length of this field type to a lower limit, if desired. Any length from 256 to 131,072 characters
is allowed. The default is 32,768 characters. Every time you press Enter within a long text area field, a
line break, and a return character are added to the text. These two characters count toward the 131,072
character limit. This data type isn’t available for activities or products on opportunities. The first 999 characters
in a standard rich text area or a long text area are displayed in a report. For custom fields, only the first 255
characters are displayed. If you download the report as Details Only, the entire field is available.
This field can be encrypted using Shield Platform Encryption.

247
Extend Salesforce with Clicks, Not Code Customize Fields

Type Description
Text Area (Rich) With the use of a toolbar, users can format the field content and add images and hyperlinks. The toolbar
allows the user to undo, redo, bold, italicize, underline, strike-out, add a hyperlink, upload or link to an
image, modify alignment, add a numbered or non-numbered list, indent, and outdent. The maximum field
size is 131,072 characters, inclusive of all the formatting and HTML tags. The first 999 characters in a standard
rich text area or a long text area are displayed in a report. For custom fields, only the first 255 characters are
displayed. If you download the report as Details Only, the entire field is available. The maximum size for
uploaded images is 1 MB. Only gif, jpeg, and png file types are supported. Not available for external
objects. There are visual and formatting differences for rich text areas in Lightning Experience and the
Salesforce mobile app, compared to Salesforce Classic.

Time Lets users enter a time of day, including hours, minutes, seconds, and milliseconds. Append a “Z” at the
end to denote Greenwich Mean Time (GMT).17:30:45.125, 17:30:45, 17:30, and 17:30:45Z are all examples
of valid entries. The time displays in a 12-hour notation with AM or PM. The displayed time depends on the
Locale setting on the Company Information page in Setup.

URL Lets users enter up to 255 characters of any valid website address. Only the first 50 characters are displayed
on the record detail pages. When a user clicks the field in Salesforce Classic, the URL opens in a separate
browser window. In Lightning Experience, internal URLs open in the same window and external URLs open
in a separate browser window. In Salesforce console apps, the URL opens in a new workspace tab. In
Lightning console apps, internal URLs open in a new workspace tab and external URLs open in a separate
browser window.
When opening an external URL, a message asks for the user’s permission. To prevent the window from
displaying every time you open an external URL, disable your browser’s popup blocker.
This field can be encrypted using Shield Platform Encryption.

Set an AI Prediction Field

When you use Einstein Prediction Builder to build a prediction, a custom field is created for storing and displaying the prediction
scores on records. Or, you can create a predictive custom field manually, and enter its name and label when building a prediction
in Einstein Prediction Builder.

SEE ALSO:
Custom Field Attributes
Set an AI Prediction Field
Einstein Prediction Builder Editions and Permissions

Set an AI Prediction Field

When you use Einstein Prediction Builder to build a prediction, a custom field is created for storing and displaying the prediction scores
on records. Or, you can create a predictive custom field manually, and enter its name and label when building a prediction in Einstein
Prediction Builder.
The recommended way to create a custom field for storing prediction scores is through the setup flow in Einstein Prediction Builder,
which creates the field for you. If you choose to create the custom field manually instead, choose the Number type. As you name the
field, select the AI Prediction checkbox. After the field is enabled, use Einstein Prediction Builder to build a prediction, entering the
custom field's exact name and label when setting up the location for storing your prediction scores.

248
Extend Salesforce with Clicks, Not Code Customize Fields

Custom formula fields can also reference AI prediction fields. For example, create a number field to predict the payment for a service
named LikelyCost__c. Select the AI Prediction checkbox. Then, create a formula field called InitialOffer__c with a
formula of LikelyCost__c * 1.5. In this case, LikelyCost__c is a numeric AI Prediction field and InitialOffer__c is just a custom
formula field. Once the field is used in a prediction, the resulting value is powered by Einstein Prediction Builder.
Whether Einstein Prediction Builder creates the field for you, or you do it on your own, these fields have some limitations. These limitations
apply to both AI prediction fields and custom formula fields that reference AI prediction fields:
• An AI prediction field can be used for only one prediction. Once it’s being used for a prediction, whether created automatically or
manually, you can’t use it for another prediction.
• The field value changes only when new predictions are made about the corresponding object. Value changes in this field do not
trigger Process Builder, Apex triggers, or workflows.
• The Roll-Up Summary field type does not support AI prediction fields.
• Fields enabled as AI prediction fields included in packages are not uploaded, so they can’t be distributed in packages.
• We don’t recommend using a custom number field that Einstein Prediction Builder manages in a validation rule. If the prediction
changes the field value in a way that violates the validation rule, you can’t save changes to a record that uses the field.
These limitations are specific to AI prediction number fields:
• The number of decimal places and the character length of the number field must match the settings in Einstein Prediction Builder.
Einstein Prediction Builder handles these settings for you when it creates the field. If you create the field, ensure that the number
and length match the prediction in Einstein Prediction Builder.

Note: If the field being predicted is a Boolean field type, the number of decimal places defaults to 0 and the character length
defaults to 3.

• To create and grant permissions to the field, the Manage Profiles and Permission Sets permission is required. Typically, this permission
is set as part of the Customize App permission, but large orgs sometimes keep Manage Profiles and Permission Sets separate.
• You can’t disable the field setting. If you have to replace it, delete it and create another field.
• You can’t delete a prediction field if Einstein Prediction Builder is still referencing it.
• You can’t convert number fields enabled as AI prediction fields to other field types.
• The custom field setting, as well as the prediction results (scores) from Einstein Prediction Builder, are available in Salesforce Classic.
The Einstein Prediction Builder setup flow is available only in Lightning Experience.

Note: When you let Einstein Prediction Builder create the field for you while building a prediction, it ensures proper scale and
precision. If you create the field manually and try to use it when building a prediction, you may get an error message if the custom
field is invalid.

Note: When creating the custom predictive field manually, be sure to give field-level security permissions to the Admin role.
Otherwise, prediction scores won't be able to be stored in this field.

SEE ALSO:
Einstein Prediction Builder Editions and Permissions

249
Extend Salesforce with Clicks, Not Code Customize Fields

What’s the Difference between Standard Fields and Custom Fields?

You can add custom fields to standard and custom objects in Salesforce, allowing you to infinitely
EDITIONS
customize your organization. Although custom fields are similar to the standard fields that come
built-in to Salesforce, there are some differences between standard fields and custom fields. Available in: both Salesforce
Custom objects and fields let you tailor which data is stored to fit your organization’s needs. Though Classic and Lightning
the Lightning Platform database provides several standard objects and accompanying standard Experience
fields, you can easily customize how you track and report on your data.
Available in: All Editions
Custom objects give you the flexibility to store any type of enterprise data that’s relevant to your
app, by creating objects. For example, if you’re building a recruiting app, you can create custom
objects called Position and Candidate to track information on job openings and candidates, respectively.
Categorize and track your data even more granularly by using custom fields. Like standard objects, custom objects have fields that define
the data for those object records. You can, for example, add a custom number field Years of Experience to the custom candidate
object or a custom text field Description to the custom position object. You can add custom fields to both custom and standard
objects.
See the following for more information:
• Create Custom Fields
• Edit Custom Fields
• Manage Fields for a Specific Object
• Build a Formula Field
• Define Default Field Values
• Additional Custom Field Options
• Custom Field Attributes
• Change the Custom Field Type

Custom Fields Allowed Per Object

The number of custom fields allowed per object varies according to your Salesforce Edition.

Personal Contact Group Essentials Professional Enterprise Unlimited Developer

Edition Manager Edition Editions Edition Edition and Edition
Performance
Edition
5 25 100 100 100 500 800 500

There is a 900 maximum hard limit on the total custom fields per object allowed. In addition to the limits listed above, you can install
fields from the AppExchange for a total of 900 custom fields. For example, for the Unlimited Edition, you can create 800 custom fields
on an object plus install 100 fields from a managed package and 100 of the fields are limited to specific objects. For the Enterprise Edition,
you can create 500 custom fields on an object plus install 400 fields from a managed package and 100 of those fields are limited to
specific objects.
Beyond 800 fields, you are limited to the following objects.
• Account
• AccountContactRelation
• Asset

250
Extend Salesforce with Clicks, Not Code Customize Fields

• Campaign
• CampaignMember
• Case
• Contact
• ContentVersion
• Contract
• Custom Object
• Individual
• KnowledgeArticleVersion
• Lead
• Opportunity
• OpportunityLineItem
• Order
• OrderItems (Order Product)
• Product2 (Products)
• Solution
• Users
• UserRole (Role)

Custom Field Type Allocations

The maximum number of activities, long text area fields, rich text area fields, relationship fields, and roll-up summary fields varies.

Field Type Essentials Personal Contact Group Professional Enterprise Developer Unlimited
Edition Edition Manager Edition Edition Edition Edition and
Performance
Edition
Activities No additional allocation 20 100

Long text An object can contain unlimited rich text area and long text area fields, although your edition’s allocation for total
area custom fields allowed on an object, regardless of field type, applies. Each object can contain 1,638,400 characters across
Rich text area long text area and rich text area fields. When you create a long text area or rich text area field, you set a character limit
for the field—the maximum length of the text that can be entered. The default character limit for long text area and
rich text area fields is 32,768 (32 KB). The maximum character limit for long text area and rich text area fields is 131,072
(128 KB). The minimum character limit is 256. The maximum size of an image that can be uploaded in a rich text area
field is 1 MB.

Relationship No 40

Roll-up additional
allocation 25
summary

Note: For custom compound fields, each component counts as one custom field toward your org’s limits. Each geolocation field
counts as three custom fields: one for latitude, one for longitude, and one for internal use. Similarly, each custom address field

251
Extend Salesforce with Clicks, Not Code Customize Fields

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.

SEE ALSO:
Salesforce Features and Edition Allocations

Custom Field Attributes

A custom field entry consists of several attributes.

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.

Field Description
# Visible Lines For long text area fields, set the number of lines to be displayed on edit pages.
You can display between 2 and 50 lines (the default is 6 lines). If the text does not
fit in the specified number of visible lines, scroll bars appear. Long text area fields
are fully displayed on detail pages and printable views.

Calculation Options Determines how a roll-up summary field is recalculated after its properties change.
Choose Automatic calculation to recalculate a field the next time it’s
displayed. Choose Force a mass recalculation of this field
as a safety net option to force recalculation of the roll-up summary field values.

Child Relationship Name The name used in API SOQL relationship queries.

Data Type The data type of a field determines what type of information is in the field. For
example, a field with the Number data type contains a positive or negative integer.
For more information on data types, see Custom Field Types on page 244.

Decimal Places For currency, geolocation, number, and percent fields, this field represents the
number of digits you can enter to the right of a decimal point. The system rounds
the decimal numbers you enter, if necessary. For example, if you enter 4.986
in a field with Decimal Places set to 2, the number rounds to 4.99.

Default Value The value to apply when a user creates a record. For checkbox custom fields,
choose Checked or Unchecked as the default value to indicate the default when
creating records. Don’t assign default values to fields that are both required and
unique, because uniqueness errors can result. See Default Field Values on page
316.

Description Text that describes the custom field. This description is for administration purposes
only and doesn’t display to users on record detail and edit pages that include the
field.

Display Format For auto-number fields, enter a Display Format to control formatting
details such as the minimum number of leading zeros and any prefix or suffix for
the number.
Begin by entering the required minimum {0} as a placeholder for the auto-number
without any leading zeros. Add any prefix to your number before this placeholder
and insert any suffix text after the placeholder. Insert any date prefixes or suffixes

252
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description
in the form of {YY}, {YYYY}, {MM}, or {DD}, which represent the record creation
date in Greenwich Mean Time (GMT).
For information on using auto-number formats when entering your Display
Format, see Auto-Number Formatting Examples on page 257.

Encrypted If checked, this custom field is encrypted using Shield Platform Encryption.

Note: This page is about Shield Platform Encryption, not Classic

Encryption. What's the difference?

External Column Name Available on external objects only. Maps the custom field to an external data
source’s table column.
For a lookup relationship field, specify the external table column that contains
18-character Salesforce IDs.

External ID For each object that can have custom fields, you can set up to 25 custom
auto-number, email, number, or text fields as external IDs. An external ID field
contains record identifiers from a system outside of Salesforce.
You can use an external ID field to update or upsert records using the API. When
using the API or the Data Import Wizard for custom objects and solutions, you
can use this field to prevent duplicates by also marking the field as Unique.

Note: Custom fields marked as Unique count against an object's limit

of 25 External ID fields. Custom indexing that occurs automatically
in the background by Salesforce does not count against External ID limits.
Not available for external objects. Each external object has an External ID
standard field. Its values uniquely identify each external object record in your org.

Filter Criteria The criteria used to select a group of records to calculate the value of a roll-up
summary field.

Filtering Disabled For custom fields on external objects, determines whether the field is available
in filters.

Formulas Enter the formula for the custom formula field or custom summary formula for
reports.

Help Text The text that displays in the field-level help hover text for this field.

Is Name Field For external object fields of type text, specifies this custom field as the name field
for the external object. Not available for text area fields. By default, the External
ID standard field is the name field for the external object.
If you select this checkbox, make sure that the External Column Name specifies
a table column that contains name values. Each external object can have only
one name field.
For internal use only, Salesforce stores the value of the name field from each row
that’s retrieved from the external system. This behavior doesn’t apply to external
objects that are associated with high-data-volume external data sources.

253
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description
Label The name of the custom field as you want it to appear.

Latitude and Longitude Display Notation For geolocation fields, determines how the latitude and longitude notation appears
in the Salesforce interface.
Degrees, Minutes, Seconds
A notation for angular measurement that is based on the number 60: there
are 360 degrees to a circle, 60 minutes to a degree, and 60 seconds to a
minute.
Decimal
Expresses the value as degrees, and converts the minutes and seconds to a
decimal fraction of the degree. Decimal notation doesn’t use cardinal points.
North and East are positive values; South and West are negative values.
For example, the coordinates for San Francisco can be expressed as follows:
Latitude: 37° 46' 30" N, Longitude: 122° 25' 5" W or
Latitude: 37.794016°, Longitude: –122.395016°
Regardless of the notation you choose to display in the interface, latitude and
longitude are stored in Salesforce as decimals.

Length (for text fields) For text fields, the maximum number of characters that a user can enter in a field
(up to 255 characters).

Length (for number, currency, percent fields) For number, currency, and percent fields, the number of digits you can enter to
the left of the decimal point, for example, 123.98 for an entry of 3.

Note: Changing the number of digits (either manually or through

workflow rules) can result in truncated values in Salesforce Classic and no
value changes in Lightning Experience. The following example shows this
behavior.
• Create a percentage field with a length of 16 and 2 decimal places.
• Create a record that includes the field with set the value to 1235689.22.
• Change the percent field digits to a length of 3.
In Lightning Experience, the record shows the percentage as 1,235,689.22%
and in Salesforce Classic, the percentage is shown as 689.22%.

Mask Character For encrypted text fields, determines the character to use for hidden characters.
Available options are * and X.

Mask Type For text fields encrypted with Classic Encryption, determines which characters
are hidden and the use of dashes in the field. Masked characters are hidden using
the character selected in Mask Character. Available options are:
Mask All Characters
All characters in the field are hidden.
Last Four Characters Clear
All characters are hidden but the last four display.

254
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description

Credit Card Number

The first 12 characters are hidden and the last four display. Salesforce
automatically inserts a dash after every fourth character.
National Insurance Number
All characters are hidden. Salesforce automatically inserts spaces after each
pair of characters if the field contains nine characters. Use this option for UK
NINO fields.
Social Security Number
The first five characters are hidden and the last four display. Salesforce
automatically inserts a dash after the third and fifth characters.
Social Insurance Number
All characters are hidden but the last three display. Salesforce automatically
inserts a dash after the third and sixth characters.

Master Object The object on the master side of a master-detail relationship used to display the
value of a roll-up summary field.

Related List Label For relationship fields, the title for the related list that displays associated records
on the parent record.

Related To For relationship fields, the name of the associated object.

Required Makes the field required everywhere in Salesforce. Not available for external
objects.
You must specify a Default Value for required campaign member custom
fields.
Don’t assign default values to fields that are both required and unique, because
uniqueness errors can result. See Require Field Input to Ensure Data Quality on
page 360.

Roll-Up Type For roll-up summary fields, choose the type of calculation to make:
• COUNT: Totals the number of related records.
• SUM: Totals the values in the field you select in the Field to
Aggregate option. Only number, currency, and percent fields are available.
• MIN: Displays the lowest value of the field you select in the Field to
Aggregate option for all directly related records. Only number, currency,
percent, date, and date/time fields are available.
• MAX: Displays the highest value of the field you select in the Field to
Aggregate option for all directly related records. Only number, currency,
percent, date, and date/time fields are available.

Starting Number For auto-number fields, enter a Starting Number that’s less than 1 billion.
Select Generate Auto Number for existing records to
automatically number all current records that begin with the starting number
that you enter. If deselected, the next record that you enter is assigned the starting

255
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description
number and your older records are blank in this field. For leads, only unconverted
leads are assigned a number.
When you create records, Starting Number’s value increments to store
the number that will be assigned to the next auto-number field created. You can’t
edit Starting Number after creating an auto-number field. To edit a
Starting Number value, change your auto-number field to a text field and
then back to an auto-number field. To restart Starting Number values for
fields on objects from a managed package, uninstall and then reinstall the package.

Warning: Be sure that you don’t create records with duplicate

auto-number values.
An auto-number field can contain up to 10 digits and up to 20 extra characters
for your prefix or suffix.

Note:
• You can’t retrieve the starting number of an auto-number field through
Metadata API. To specify a Starting Number while deploying,
add a startingNumber tag for your field to your package.xml
file. For example:
<startingNumber>42</startingNumber>
• If you deploy without specifying a Starting Number value in
your package.xml file, the default starting number for standard
fields is 0. The default starting number for custom fields is 1.

Sharing Setting For master-detail relationship fields, the Sharing Setting attribute
determines the sharing access that users must have to a master record to create,
edit, or delete its associated detail records.

Sorting Disabled For custom fields on external objects, determines whether the field is sortable.

Summarized Object The object on the detail side of a master-detail relationship used to provide the
values calculated in a roll-up summary field.

Unique If checked, prevents duplicate field values.

For text fields, you can control whether values that are identical except for their
case are considered unique. Select Treat "ABC" and "abc" as
duplicate values to enforce case-insensitive uniqueness, or select Treat
"ABC" and "abc" as different values to enforce case-sensitive
uniqueness.

Note: Some characters have both single-byte and double-byte versions.

For example, all the following characters have single-byte and double-byte
versions: “!@#$%^&*(){}[]\|:";',.<>?/~`”.
For the purpose of unique field value comparison, the single-byte and
double-byte versions of these characters are considered identical.
Superscript characters are not treated as unique characters. Text such as
ABC² and ABC2 are considered identical.

256
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description

Note: Custom fields marked as Unique count against an object's limit

of 25 External ID fields. Custom indexing that occurs automatically
in the background by Salesforce does not count against External ID limits.

Values For picklist fields, a list of available values (up to 255 characters for each value).
For picklists, optionally choose to alphabetize the picklist entries. You can also
set the first value as the default selection. If you select both options, Salesforce
alphabetizes the entries and then sets the first alphabetized value as the default.
For multi-select picklists, enter a list of values, select the sorting options that apply,
and then enter how many values you want displayed at a time on edit pages.
The number of values determines the box height.

Auto-Number Formatting Examples

Use these examples when setting the display format for auto-number fields.

Format Displayed Values

{0} 3 66 103

{000} 003 066 103

Sample- {00000} Sample- 00003 Sample- 00666 Sample- 10023

Value- {00} {MM} {DD} {YY} Value- 03 12 02 04 Value- 76 03 03 04 Value- 123 11 09 04

PO #{0} {MM}-{DD}-{YY} PO #12233 12-20-04 PO #25 06-07-04 PO #3 07-07-04

SEE ALSO:
Create Custom Fields
Create a Many-to-Many Object Relationship
Object Reference for Salesforce and Lightning Platform

Custom Address Fields

Improve address data accuracy and the end-user experience with Custom Address Fields. Users
EDITIONS
can populate a custom address fields manually or they can use the Google lookup to search for an
address. Admins and APIs can access each address stored in a custom address field as a structured Available in: both Salesforce
compound data type as well as individual address components. Classic (not available in all
orgs) and Lightning
Note: Before you enable custom address fields, review the requirements and limitations. To
Experience
discuss the feature and ask questions, join the Custom Address Fields Discussion group on
the Trailblazer Community. Available in: All editions
Use the Address field type to create custom fields that store address data in a structured
compound data type. Compound fields are an abstraction that can simplify application code
that handles the values, leading to more concise, understandable code. With Custom Address
Fields, custom addresses are accessible as a single, structured field, or as individual component

257
Extend Salesforce with Clicks, Not Code Customize Fields

fields. Users can edit the custom address field data in records and view custom address data in list views and reports.

Note: 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.

Supported Functionality
With Custom Address Fields, your Salesforce end users can add and retrieve address data via custom Address compound fields on
standard and custom objects. Users can edit the custom address field data in records and view custom address data in list views and
reports.
Custom Address Fields supports these features.
Google Address Lookup
When users populate a custom address field, they can enter an address manually or they can use the Google lookup to search for
an address. When a user selects an address from Google’s lookup, the street, city, state or province, zip or postal code, and country
are populated.
State and Country/Territory Picklists
End users select state, province, country, and territory values from picklists when adding or editing addresses in custom address
fields. Standard address fields work in parallel with new custom address fields. If State and Country/Territory Picklists aren’t enabled
in your org, the State and Country components of the standard Address fields remain free text fields.
Validation rules
For example, require that street, city, state, and ZIP code are all populated before you can save a custom address field.
Apex classes and triggers
For example, you create a custom address field, Office Address, on the Opportunity object, and you want the Office Address to always
have a value. You then create an Apex trigger that is invoked when the Office Address field is unpopulated upon saving an Opportunity.
The trigger populates the unpopulated Office Address field with the Billing Address on the parent Account before the Opportunity
record is saved.
List Views
For example, you create a custom address field, Warehouse Address, on the Account object. Include the individual components of
the Warehouse Address, such as the street or state, in an Accounts list view.
Reports
For example, a report that sums the number of opportunities by the state or ZIP code within a custom address field.
Field History Tracking
Track and display the history of a custom address field in the History related list of an object.
Managed Packages
For example, include a custom address field in a managed package, or use a package to deploy that field to a sandbox.
Change sets
Move objects with address fields created using Custom Address Fields from one Salesforce org to another.
Apex and API
To create, edit, or delete records with custom address field data, use Apex. To create a custom address field on an object, use Metadata
API. To create, update, or delete a record with custom address data, use SOAP API or REST API. To retrieve information about custom
address fields, such as the developer name, use Tooling API. For more information see the Custom Address Fields Developer Guide.
Change Data Capture
Receive real-time events for changes in custom address fields for new, updated, and undeleted records.

258
Extend Salesforce with Clicks, Not Code Customize Fields

Skinny Tables
To avoid joins and improve the performance of certain read-only operations, include custom address fields in skinny tables, which
contain frequently used fields. For more information, see Skinny Tables in Best Practices for Deployments with Large Data Volumes.
Custom Indexes
To speed up queries, create custom indexes for custom fields created with the Address type. For more information, see Indexes in
Best Practices for Deployments with Large Data Volumes.
Geocode
To give your users precise geographical information, add geocode information to custom address fields.

Custom Address Fields Requirements and Limitations

Before you enable custom address fields, configure State and Country/Territory picklists and review the limitations of this feature.
Enable Custom Address Fields
After you review the feature limitations and configure the State and Country/Territory picklists, enable the custom address fields.
Then you can add custom fields to standard and custom objects in Object Manager using the compound Address field type.
Create a Custom Address Field
Use the Address field type to create a custom address field that mimics the behavior of standard address fields. For example, add a
Warehouse Address field to a standard or custom object. Users can populate a custom address field manually, or they can use the
Google lookup to search for an address. Then you can access each address that’s stored in a custom address field, either as a structured
compound data type or as individual address components.
Add Geocode to a Custom Address Field
The method to get geocodes differs between standard and custom address fields. To give your users precise geographical information,
add geocode information to custom address fields with Apex, Visualforce, and a map API.

Custom Address Fields Requirements and Limitations

Before you enable custom address fields, configure State and Country/Territory picklists and review
EDITIONS
the limitations of this feature.

Note: To discuss the feature and ask questions, join the Custom Address Fields Discussion Available in: both Salesforce
group on the Trailblazer Community. Classic (not available in all
orgs) and Lightning
Experience
Requirements for State and Country/Territory Picklists
Available in: All editions
Custom address fields use picklists for the State and Country address fields.
If State and Country/Territory Picklists are enabled, those picklist values are used in standard address
fields. With Custom Address Fields, the same picklist values are automatically available in custom address fields. You can’t specify separate
picklist values for standard and custom address fields.
If State and Country/Territory Picklists aren’t enabled, those picklists are enabled for custom address fields with Custom Address Fields.
By default, all countries, territories, and their states and provinces are visible to users. To specify the available picklist values in Salesforce,
configure State and Country/Territory Picklists.
When you configure these picklist values, the behavior of standard address fields is unaffected unless you enable State and Country/Territory
Picklists for standard fields through Setup. Enabling the picklists for standard fields isn’t required to use Custom Address Fields.
For more information on configuring the picklists, see Configure State and Territory/Country Picklists in Salesforce Help. For details on
enabling the picklists for standard address fields, see Let Users Select States, Countries, and Territories from Picklists in Salesforce Help.

259
Extend Salesforce with Clicks, Not Code Customize Fields

Requirement for Package Deployment

If a package contains a custom field with the Address field type, package deployment requires that Custom Address Fields 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

Before you enable Custom Address Fields or add a custom address field, understand the limitations of this feature.
These items aren’t supported with custom address fields.
• The conversion of address data into custom fields of type Address from custom fields of other types.
• Approvals
• Data Import Wizard
• Fuzzy matching
• Composite API
• Field Encryption
• Field Sets
• Flow Screen Input Component: Address
• Lead Conversion
• Lightning Web Components
• Mass Update Addresses
• Merge Fields
• Visualforce pages
• Workflow
Salesforce hasn’t validated custom address fields with these items.
• Schema Builder
• Web-to-Case and Email-to-Case
• Generating Leads from Your Website
• Export Backup Data from Salesforce
• Export Data
• Filtering in a related list
• Bulk API 1.0
• Community profile
This functionality is either unavailable or limited with custom address fields.
• As with standard address fields, you can’t mark a custom address field as required.
• You can’t use the DISTANCE function with a custom address field.

260
Extend Salesforce with Clicks, Not Code Customize Fields

• 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, including Global Search, lookup search, search manager, and SOSL queries, isn’t supported.
• In Skinny Tables, you can’t select a component of a custom address field as a partition column.
• 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.
• When using a custom address field in a Data Integration Rule, the Country and State components are unavailable for field mapping.
• You can’t rename the labels for the individual components of a custom address field.
• 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.

SEE ALSO:
Salesforce Features and Edition Allocations
Custom Address Fields
Enable Custom Address Fields
Create a Custom Address Field

Enable Custom Address Fields

After you review the feature limitations and configure the State and Country/Territory picklists,
EDITIONS
enable the custom address fields. Then you can add custom fields to standard and custom objects
in Object Manager using the compound Address field type. Available in: both Salesforce
Note: Before you enable custom address fields, review the requirements and limitations. To Classic (not available in all
orgs) and Lightning
discuss the feature and ask questions, join the Custom Address Fields Discussion group on
Experience
the Trailblazer Community.
1. In Setup, in the Quick Find box, enter User Interface, and then select User Interface. Available in: All editions

2. In the Setup section, select Use custom address fields and save your changes.
After you enable custom address fields, the Address data type is available when you add a field USER PERMISSIONS
via Object Manager. To modify user interface
settings:
Note: This feature can’t be disabled.
• Customize Application

SEE ALSO:
Custom Address Fields
Create a Custom Address Field
Salesforce Features and Edition Allocations

261
Extend Salesforce with Clicks, Not Code Customize Fields

Create a Custom Address Field

Use the Address field type to create a custom address field that mimics the behavior of standard
EDITIONS
address fields. For example, add a Warehouse Address field to a standard or custom object. Users
can populate a custom address field manually, or they can use the Google lookup to search for an Available in: both Salesforce
address. Then you can access each address that’s stored in a custom address field, either as a Classic (not available in all
structured compound data type or as individual address components. orgs) and Lightning
Experience
Note: Before you create a custom address field, review the requirements and limitations. To
discuss the feature and ask questions, join the Custom Address Fields Discussion group on Available in: All editions
the Trailblazer Community.
Before you can create a custom address field, enable this feature in User Interface Settings. For more USER PERMISSIONS
information, see Enable Custom Address Fields.
To create or change custom
For custom compound fields, each component counts as one custom field toward your org’s
fields:
allocations. Thus each custom address field counts as nine custom fields: one each for street, city,
• Customize Application
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.
1. In your Salesforce org, click and select Setup.
2. Click the Object Manager tab. If you don’t see it, enter Object Manager in the Quick Find box and select Object Manager.
3. From the Object Manager page, select the object to which you want to add the custom address field.
4. From the sidebar, click Fields & Relationships.
5. To create a custom field, click New.
6. Choose Address as the data type.

262
Extend Salesforce with Clicks, Not Code Customize Fields

Address is at the bottom of the data type list.

7. Click Next.
8. Enter the field label and field name.
The field label appears above the custom address field and at the beginning of each component label. When you specify your field
label, consider whether the word Address is needed. In many cases, the field label doesn’t require the word Address. To help API
users, you can add it the word Address to the field name.
Here’s the label field when building or editing a field in Object Manager.

And here’s the field on the Account object.

9. Optionally, enter a description and help text, and select whether to add the new field to custom reports. Then click Next.
10. Select the field’s visibility and edit access.
11. Click Next. Then click Save.
12. To edit the placement of the custom address field on the pages associated with this object, click Page Layouts.

263
Extend Salesforce with Clicks, Not Code Customize Fields

For more information, see Page Layouts in Salesforce Help.

SEE ALSO:
Custom Address Fields
Custom Address Fields Requirements and Limitations
Page Layouts

Add Geocode to a Custom Address Field

The method to get geocodes differs between standard and custom address fields. To give your
EDITIONS
users precise geographical information, add geocode information to custom address fields with
Apex, Visualforce, and a map API. Available in: both Salesforce
1. Create an Apex class that retrieves latitude and longitude from your preferred map API. This Classic (not available in all
example calls the Google Map API in the String endpoint. orgs) and Lightning
Experience

Available in: All editions

USER PERMISSIONS

To modify user interface

settings:
• Customize Application

public class GeoCodeExample {

@future(callout=true)
public static void parseJSONResponse() {
double lat;
double lng;
String city = null;
String street = null;
String stateCode = null;
String countryCode = null;

Account record = [SELECT Mailing_Address__c FROM Account WHERE Id = 'Account

ID'];
Address customAddress = record.Mailing_Address__c;

//Remove white spaces from address components

if(customAddress.getCity() != null){
city = customAddress.getCity().deleteWhitespace();
}
if(customAddress.getStreet() != null){
street = customAddress.getStreet().deleteWhitespace();
}
if(customAddress.getStateCode() != null){
stateCode = customAddress.getStateCode();
}
if(customAddress.getCountryCode() != null){
countryCode = customAddress.getCountryCode();

264
Extend Salesforce with Clicks, Not Code Customize Fields

//concatenate strings
String address = street+city+stateCode+countryCode;

String key='API key';

Http httpProtocol = new Http();
// Create HTTP request to send.
HttpRequest request = new HttpRequest();
// Set the endpoint URL.
// USING GOOGLE MAP API
String endpoint =
'https://maps.googleapis.com/maps/api/geocode/json?address='+address+'&key='+key;
request.setEndPoint(endpoint);
// Set the HTTP verb to GET.
request.setMethod('GET');
// Send the HTTP request and get the response.
// The response is in JSON format.
HttpResponse response = httpProtocol.send(request);

// Parse JSON response to get all the totalPrice field values.

JSONParser parser = JSON.createParser(response.getBody());

while (parser.nextToken() != null) {

if ((parser.getCurrentToken() == JSONToken.FIELD_NAME) &&
(parser.getText() == 'lat')) {
parser.nextToken();
// Get latitude
lat = parser.getDoubleValue();

parser.nextToken();
parser.nextToken();
//Get longitude
lng = parser.getDoubleValue();
}
}
// Update lat long of account record
record.Mailing_Address__Latitude__s=lat;
record.Mailing_Address__Longitude__s=lng;
update record;
}
}

2. Create a Visualforce page that triggers the geocode service from the map API.
<apex:page id="pg" controller="GeoCodeExample">
<apex:form >
<apex:pageBlock id="pb">
<apex:pageBlockButtons >
<apex:commandButton value="Get GeoCode For Custom Address Field"
action="{!parseJSONResponse}"/>
</apex:pageBlockButtons>
</apex:pageBlock>

265
Extend Salesforce with Clicks, Not Code Customize Fields

</apex:form>
</apex:page>

3. On the Visualforce page, click GeoCode For Custom Address Field to trigger the code. To see the latitude and longitude values
populated, query the account information in Developer Console.

To automate the process of updating custom address fields with latitude and longitude, set up a trigger to invoke the Apex class.

Note: The example in this topic uses a third-party map API to retrieve latitude and longitude. Using a Salesforce trigger to invoke
this Apex class calls the map API each time the class is invoked. This action can result in charges from your API provider.

SEE ALSO:
Apex Developer Guide: Adding an Apex Class
Apex Developer Guide: Triggers
Visualforce Developer Guide: Creating Your First Page

Geolocation Custom Field

The geolocation custom field allows you to identify locations by their latitude and longitude and
EDITIONS
to calculate distances between locations.
You can calculate the distance between two geolocation fields, such as between a warehouse and Available in: both Salesforce
a store. Or you can calculate the distance between a geolocation field and a pair of latitude and Classic and Lightning
longitude coordinates, such as between a warehouse and 37.794016°, -122.395016°—the location Experience
also known as San Francisco. Latitude values must be within -90 and 90. Longitude values must
Available in: All Editions
be within -180 and 180.
Geolocation is a compound field that counts toward your org’s limits as three custom fields: one
for latitude, one for longitude, and one for internal use. Support for the compound field (geolocation) versus the field’s components
(latitude and longitude) varies depending on the functionality you’re using in Salesforce. For example, you can create list views that
show the field and its components, but you can’t select the compound geolocation field in Apex. You can run SOQL queries only on a
geolocation field’s components.
Compound fields, including geolocation fields, have the following limitations.
• Compound fields are read-only. To update field values, modify the individual field components.

266
Extend Salesforce with Clicks, Not Code Customize Fields

• Compound fields are accessible only through the SOAP API, REST API, and Apex. The compound versions of fields aren’t accessible
anywhere in the Salesforce user interface.
• Although compound fields can be queried with the Location and Address Apex classes, they’re editable only as components
of the actual field. Read and set geolocation field components by appending “__latitude__s” or “__longitude__s” to the field name,
instead of the usual “__c.” For example:
Double theLatitude = myObject__c.aLocation__latitude__s;
myObject__c.aLocation__longitude__s = theLongitude;

You can’t access or set the compound value.

• You can’t use compound fields in Visualforce—for example, in an <apex:outputField>. To access or update field values, use
the individual field components.
• If you select compound fields for export in the Data Loader, they cause error messages. To export values, use individual field
components.
• Custom geolocation and location fields on standard addresses aren’t supported with email templates.
• You can’t use compound fields in lookup filters, except to filter distances that are within or not within given ranges. You can use
distance lookup filters only in the Metadata API.
• The only formula functions that you can use with compound fields are ISBLANK, ISCHANGED, and ISNULL. You can’t use
BLANKVALUE, CASE, NULLVALUE, PRIORVALUE, or the equality and comparison operators with compound fields. The
equality and comparison operators include = and == (equal), <> and != (not equal), < (less than), > (greater than), <= (less
than or equal), >= (greater than or equal), && (AND), and || (OR).
Other limitations of geolocation fields include:
• Geolocation fields aren’t supported in custom settings.
• Geolocation fields aren’t available in dashboards or Schema Builder.
• Geolocation fields are available in Visual Workflow and in formula-based workflow and approvals, but they can’t be used in filter-based
workflow updates and approvals.
• DISTANCE formulas are supported in:
– Entry criteria for workflow rules and approval processes
– Field update actions in workflow rules and approval processes
– Custom validation rules
– Lookup filters (in the Metadata API only)

• Geolocation fields and latitude and longitude on standard addresses aren’t supported in Salesforce to Salesforce.
• In Developer, Professional, Enterprise, Unlimited, and Performance editions, Salesforce can automatically add or update geolocation
fields for Account, Contact, Lead, and WorkOrder records. To use this feature, your administrator must enable the geo data integration
rule for each object. For all other objects and editions, set values for latitude and longitude by using SOQL, Workbench, SOAP or
REST API, or a geocoding service. You can then use address fields as locatable values. To find geocoding services, search AppExchange.
• Geolocation fields are supported in SOQL with the following limitations.
– DISTANCE and GEOLOCATION are supported in WHERE and ORDER BY clauses in SOQL, but not in GROUP BY.
DISTANCE is supported in SELECT clauses.
– DISTANCE supports only the logical operators > and <, returning values within (<) or beyond (>) a specified radius.
– When using the GEOLOCATION function in SOQL queries, the geolocation field must precede the latitude and longitude
coordinates. For example, DISTANCE(warehouse_location__c, GEOLOCATION(37.775,-122.418),
'km') works but DISTANCE(GEOLOCATION(37.775,-122.418), warehouse_location__c, 'km')
doesn’t work.

267
Extend Salesforce with Clicks, Not Code Customize Fields

– Apex bind variables aren’t supported for the units parameter in the DISTANCE function. This query doesn’t work.
String units = 'mi';
List<Account> accountList =
[SELECT ID, Name, BillingLatitude, BillingLongitude
FROM Account
WHERE DISTANCE(My_Location_Field__c, GEOLOCATION(10,10), :units) < 10];

For more information and examples, see the SOQL and SOSL Reference.

SEE ALSO:
Custom Field Types
Custom Field Attributes

Time Custom Field

Track time, unbound to a date, with this custom field type. The time type is useful for time management, event planning, and project
management.
You can select the time field type when you create a custom field. The time type is a timestamp without the date included. But a time
field value’s precision is in milliseconds. A date/time field value’s precision is in seconds. Use the time field type when you require a time
of day that isn’t specific to a single date. For example, use it to show business hours, or if you want to compare times of day to calculate
a duration.

Time Field Behavior

The display and management of time field values observes these behaviors.
• In formulas, get a time value from the TIMEVALUE function. Use TIMENOW, HOUR, MINUTE, SECOND, and MILLISECOND
functions with time in formulas.
• The time field type is represented in the Metadata API as a FieldType enumeration value.
• A time field value is saved according to the saving user's current time zone. When the time value is displayed in Salesforce, the value
matches what's saved. It isn't converted to a user's local time zone per the user's Locale setting on the Language & Time Zone page.
• The unit for adding or subtracting time values is milliseconds. For example,
Timefield1__c has the value “5:00pm”:
Timefield1__c + 600000 is “5:10pm”
Timefield1__c - 600000 is “4:50pm”
Time fields don’t include a date. So, adding 25 hours to a time value is the same as adding one hour. The clock restarts after 24 hours.

• You can subtract one time field from another in a formula. The result is in milliseconds. For example,
TimeField1__c has the value “10:00pm” and TimeField2__c has the value “9:00pm”:
TimeField1__c - TimeField2__c is 3600000
The result is never a negative number. Subtraction is the difference between two time values, using a 24-hour clock.
For example, when calculating the number of hours a business is open, you use the following formula: (ClosedTime -
OpenTime) / 3600000.
ClosedTime = 5 PM, OpenTime = 8 AM, ClosedTime - OpenTime = 9 hours
ClosedTime = 5 AM, OpenTime = 7 AM, ClosedTime - OpenTime = 22 hours

268
Extend Salesforce with Clicks, Not Code Customize Fields

Time Field Limitations

Be aware of these limitations when using a time field type. The time field:
• Isn’t supported in Flow Builder, Process Builder, and Schema Builder
• Doesn't support the creation of custom index for SOQL queries
• Isn’t available for standard lookup relationships in external objects

Note: In formula expressions, use the international date format (ISO) for text arguments. For example, use TIMEVALUE("11:30:00.000")
instead of TIMEVALUE("11:30 AM").

Time Fields in Salesforce Classic

In Salesforce Classic, you have several formatting options when setting time values. For example, you can set time values to include
seconds, milliseconds, time zone, and use 24-hour notation.
Time Fields in Lightning Experience
In Salesforce Lightning Experience, you can choose a time from a dropdown list of selectable options.

SEE ALSO:
Create Custom Fields
Locales Overview
Formula Operators and Functions by Context
Using Date, Date/Time, and Time Values in Formulas
Custom Field Attributes
Define Default Field Values

Time Fields in Salesforce Classic

In Salesforce Classic, you have several formatting options when setting time values. For example, you can set time values to include
seconds, milliseconds, time zone, and use 24-hour notation.

Time Field Format

• The time custom field type can use 24-hour notation. You can save a time value in HH:MM, for example, 14:40.
• Time fields support the following input formats.

Format Example
hh:mm:ss aa 10:30:25 AM

hh:mm:ss.SSS a 10:30:25.125 AM

HH:mm:ss.SSS 14:30:25.125

HH:mm:ss.SSSZ 14:30:25.125Z displays as GMT

hh:mm a 10:30 AM

hh:mma 10:30AM

ha 4 PM

269
Extend Salesforce with Clicks, Not Code Customize Fields

Format Example
ha 4PM

H:mm 1:23 is 1:23 AM

H 14 is 2:00 PM

Hmm 123 is 1:23 AM

HHmm 1434 is 2:34 PM

h= Hour of day (1-12), H = Hour of day (0-23), m= minute, s= seconds, S= milliseconds, a= AM or PM, Z= GMT time zone.
• Use the 11:30:00.000Z format when loading values with Data Loader.

• Use the HH:MM:SS.MS format to set a default value for a field, such as TIMEVALUE("10:30:00.000") for 10:30 AM.

Time Fields in Lightning Experience

In Salesforce Lightning Experience, you can choose a time from a dropdown list of selectable options.
The following example shows the check-in and check-out times for a hotel in Lightning Experience.

270
Extend Salesforce with Clicks, Not Code Customize Fields

Manage Fields for a Specific Object

1. From the object management settings for the object whose fields you want to view, go to
EDITIONS
Fields.
2. Click the field label. Available in: both Salesforce
Classic and Lightning
3. To modify a custom field, add custom help text, or change the data type, click Edit.
Experience
4. If a custom field exists in a Managed - Released package, click Delete to delete the custom field
component from future installations. Available in: Contact
Manager, Group,
5. To set users’ access to the field, click Set Field-Level Security. This option is available depending Professional, Enterprise,
on the edition that you have. Performance, Unlimited,
6. To view who can access the field based on permissions and record type, click View Field Developer, and
Accessibility. This option is available depending on the edition that you have. Database.com Editions

7. If the custom field is a dependent picklist, click Change next to the controlling field to edit the Standard fields are not
dependency rules. available in Database.com
Salesforce Connect external
8. To change External ID, Required, or other attributes under the General Options
objects are available in
section, see Custom Field Attributes.
Developer Edition and, for
9. To restore the field and its data, click Undelete. This option is available only if the field has been an extra cost, in Enterprise,
deleted but not permanently erased. The field’s behavior may be different after restoring it. Performance, and Unlimited
Editions.
Note: If your organization uses person accounts, the Account Fields page lists both person
account and business account fields.
Person accounts use a combination of account and contact fields. The following contact fields
are available for person accounts, but not for business accounts.
• Fields in the Account Standard Fields list that display with a person account icon.
• Fields in the Contact Custom Fields & Relationships list.

Find Where a Field Is Used

Find out where a custom field is referenced, such as in a formula or Apex class, with a click of the Where is this used? button. You
can see where a field is used and where changes to the field appear before you edit it.

SEE ALSO:
Create Custom Settings

271
Extend Salesforce with Clicks, Not Code Customize Fields

Find Where a Field Is Used

Find out where a custom field is referenced, such as in a formula or Apex class, with a click of the
EDITIONS
Where is this used? button. You can see where a field is used and where changes to the field
appear before you edit it. Available in: Salesforce
On a custom field’s detail page, click Where is this used? to see the field reference details. To view Classic and Lightning
the settings for the layout, formula, or other reference, click a reference label. Experience

The list can include these references. Available in: Professional,

• Active validation rule Enterprise, Performance,
and Unlimited Editions
• Layout
• Formula field
USER PERMISSIONS
• Visualforce page
• Apex class To view references:
• View Setup
• Apex trigger
• Email template (Salesforce Classic, text based)
• Field set
• Flow (query)
• Lightning component markup (attr)
• Process Builder (criteria)
• URL button (formula)
• Lightning page (Related List–Single and Dynamic Related List–Single components)
• Lookup filter (lookup and master detail)
• Report (column, filter)

Note: References to reports on objects where there’s a foreign key relationship don’t appear. For example, if a custom object
has a lookup relationship to Account or any standard object, and the custom fields of Account are added to a report of type
CustomObject with Account, then the report isn’t listed for the custom fields on Account.

Considerations
• Reference labels link to more information only if there‘s a known settings page for the reference. For example, a report name links
to the report settings. But a criteria formula created within a flow doesn’t link to the flow settings.
• Within a subscriber org, references in a managed package aren’t included in the list of results. For example, a number field is referenced
in a formula. If you add the field to a package and then install the package in a subscriber org, the subscriber org’s field reference
detail page doesn’t show that this number field is referenced in a formula field. But new references that are created after installing
the managed package in the subscriber org do appear. For example, after you install the managed package and you add the number
field to another formula in the subscriber org, the new reference appears.
• Only the IDs of reports that are accessible to the user initiating the query are returned. For example, if an admin creates a report and
saves the report in a private folder, then the report isn’t listed in the reference detail page for a standard user.
• Joined reports aren’t supported and aren’t displayed in the reference detail page.
• The list of field references is limited to the first 2,000 entries and sorted alphabetically by reference type.

SEE ALSO:
Manage Fields for a Specific Object

272
Extend Salesforce with Clicks, Not Code Customize Fields

Edit Custom Fields

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
1. From the management settings for the field’s object, go to Fields. Classic and Lightning
Experience
2. Click Edit next to the field’s name.
Available in: All Editions
3. Modify the field attributes. The attributes differ depending on the field type.
Standard Objects are not
If you’re editing a picklist, you can change its definition and its values. For picklist settings, see available in Database.com
Add or Edit Picklist Values on page 288.
To change the type of this custom field, see Change the Custom Field Type on page 312.
USER PERMISSIONS
4. Optionally, define custom help text for the field.
To create or change fields:
5. For lookup and master-detail relationship fields, optionally define a lookup filter.
• Customize Application
6. For formula fields, click Next to modify the formula.
7. In Enterprise, Unlimited, Performance, and Developer Editions, click Next to set the field-level
security for the field.

Note:
• Editing fields can require changing a large number of records at once. To process these changes efficiently, your request can
be queued and you receive an email notification when the process has completed.
• To customize the way a custom object’s related list appears on a parent record’s detail page, edit the parent record’s page
layout. For example, if you want to edit which fields appear on a custom object’s related list on accounts, you would edit the
account page layout.
• You cannot change the Field Name if a custom field is referenced in Apex.
• When editing fields for accounts, opportunities, cases, contacts, or custom objects, check for any criteria-based sharing rules
that use the field in the rules. A field change may affect which records are shared.

SEE ALSO:
Define Default Field Values
Find Object Management Settings

273
Extend Salesforce with Clicks, Not Code Customize Fields

Delete Fields
1. From the management settings for the field’s object, go to Fields.
EDITIONS
2. Click Del next to the name of the field.
Available in: both Salesforce
3. When prompted, select the Yes, I want to delete the custom field
Classic and Lightning
checkbox to confirm, and click Delete.
Experience
Deleted custom fields and their data are stored until your org permanently deletes them or 15
days has elapsed, whichever happens first. Until that time, you can restore the field and its data. Available in: All Editions
For information on restoring deleted custom fields and relationships, see Manage Deleted
Custom Fields on page 275. USER PERMISSIONS

Note: To delete custom fields:

• Customize Application
• Before deleting a custom field, consider where it’s referenced. You can’t delete a custom
field that’s referenced elsewhere. For example, you can’t delete a custom field that’s AND
referenced by a field update or Apex. View All Data
• You can’t delete a field if that field is being updated by a background job, such as an
update to a roll-up summary field. Wait until the background job finishes, and then try
again.
• When you delete a custom field, all of the field history data is deleted and changes are
no longer tracked.
• A background process periodically runs that cleans up metadata associated with deleted
custom fields. This process affects the Last Modified Date and Last
Modified By fields on page layouts, record types, and custom objects.

SEE ALSO:
Find Object Management Settings

274
Extend Salesforce with Clicks, Not Code Customize Fields

Manage Deleted Custom Fields

Deleted custom fields and their data are stored until your org permanently deletes them or 15 days
EDITIONS
have elapsed, whichever happens first. Until that time, you can restore the field and its data.
The field counts against the maximum number of custom fields allowed in your org until the Available in: both Salesforce
hard-delete process permanently deletes it (see Notes on Hard Deleting Custom Fields). A deleted Classic and Lightning
field also counts against the applicable limit for its field type. For example, a deleted custom roll-up Experience
summary field counts against the maximum number of roll-up summary fields for your Salesforce
Available in: Contact
edition. If you receive the error message “Unable to access page” or “No clean data columns available Manager, Group,
for custom fields” when trying to create or edit custom fields, you must erase some fields. Professional, Enterprise,
Performance, Unlimited,
Notes on Restored Custom Fields Developer, and
Database.com Editions
• When deleted, the following characters are appended to the end of a custom field's developer
Page Layouts and Lead
name unless a deleted field already has that developer name: “_del”. These characters remain
Fields aren’t available in
when you restore the custom field.
Database.com
• Formula fields are restored in a disabled state, which means they don’t contain updated data
until you edit and save them. While a formula field is disabled, “#Error!” displays in place of the
formula value. USER PERMISSIONS
• Restored fields don’t display in search results immediately after you restore them. It can take a
To restore deleted custom
short time before the restored custom field and its data are available in search results.
fields and relationships:
• Lead fields that are mapped to account, contact, or opportunity fields for lead conversion are • Customize Application
still mapped accordingly when restored.
To permanently delete
• Auto number fields continue to increment after they’re deleted and contain the correct values custom fields or
when restored. relationships:
• Field history data for the deleted custom field is restored. • Customize Application

Notes on Hard Deleting Custom Fields

• The estimated time for a hard-delete process varies, and depends on the system demand to maintain overall performance. However,
you can monitor and view the details of a hard delete of a custom field by going to the Background Jobs page. From Setup, enter
Background Jobs in the Quick Find box, then select Background Jobs. A row with the name “Cleanup of custom field
data when a custom field definition is hard deleted” indicates that a hard delete job is in progress. The Background Jobs page also
shows the details of background jobs, including a percentage estimate of the progress.
• When an org is at or above 75% of its custom field allocation limit for the current object, Salesforce displays a value for the custom
fields that are ready for the hard-delete process value. This value increments when you click Erase or when a field is beyond the
15-day grace period, until the field is moved into the hard-delete process by Salesforce. The value changes only while Salesforce is
actively hard deleting the field.
• Performance and Unlimited Edition orgs can use a Purge button to initiate the hard-delete process immediately.

Manage Deleted Fields in Lightning Experience

Restore or permanently delete a custom field in Lightning Experience.
Manage Deleted Fields in Salesforce Classic
Restore or permanently delete a custom field in Salesforce Classic.

275
Extend Salesforce with Clicks, Not Code Customize Fields

Manually Restore Attributes of Deleted Fields

Custom fields consist of several attributes that provide additional information about the field. Some of these attributes are not
restored automatically after a field is undeleted and must be restored manually.

SEE ALSO:
Purge Deleted Custom Fields
Find Object Management Settings

Manage Deleted Fields in Lightning Experience

Restore or permanently delete a custom field in Lightning Experience.
EDITIONS
1. From the Object Manager page, click the name of the custom object.
Available in: Lightning
2. Click Fields & Relationships.
Experience
3. To see a list of soft deleted fields, click Deleted Fields at the top of the Custom Fields &
Relationships page. Available in: Contact
Manager, Group,
4. From the list of deleted fields, perform the following actions: Professional, Enterprise,
a. To permanently remove the custom field and its data, click Erase. Performance, Unlimited,
Developer, and
b. To restore the field and its data, click Undelete.
Database.com Editions
Note: If you undelete a custom field, manually restore attributes of the deleted field Page Layouts and Lead
that were not automatically restored. Fields are not available in
Database.com

SEE ALSO:
Manually Restore Attributes of Deleted Fields
USER PERMISSIONS

To restore deleted custom

fields and relationships:
• Customize Application
To permanently delete
custom fields or
relationships:
• Customize Application

276
Extend Salesforce with Clicks, Not Code Customize Fields

Manage Deleted Fields in Salesforce Classic

Restore or permanently delete a custom field in Salesforce Classic.
EDITIONS
1. From the management settings for the field’s object, go to Fields.
Available in: Salesforce
2. Click Deleted Fields at the bottom of the list of custom fields and relationships. The number
Classic
in parentheses indicates the total number of deleted custom fields for this object. For
Performance and Unlimited Editions, the Deleted Fields link always displays. For other editions, Available in: Contact
this link displays only after you’ve deleted a custom field. Manager, Group,
3. Use the list of deleted fields to perform the following actions: Professional, Enterprise,
Performance, Unlimited,
a. To view details about a field, click the field label. Developer, and
b. To permanently remove the custom field and its data, click Erase. Database.com Editions

c. To restore the field and its data, click Undelete. Page Layouts and Lead
Fields are not available in
Note: If you undelete a custom field, manually restore attributes of the deleted field Database.com
that were not automatically restored.

USER PERMISSIONS
SEE ALSO:
To restore deleted custom
Manually Restore Attributes of Deleted Fields fields and relationships:
• Customize Application
To permanently delete
custom fields or
relationships:
• Customize Application

277
Extend Salesforce with Clicks, Not Code Customize Fields

Manually Restore Attributes of Deleted Fields

Custom fields consist of several attributes that provide additional information about the field. Some
EDITIONS
of these attributes are not restored automatically after a field is undeleted and must be restored
manually. Available in: both Salesforce
Important: Where possible, we changed noninclusive terms to align with our company Classic and Lightning
Experience
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: Contact
1. Add the field to any page layouts that changed during the time the custom field was deleted. Manager, Group,
If reports and page layouts were not edited, the restored field remains on them. Professional, Enterprise,
Performance, Unlimited,
2. Make the field unique if necessary. Salesforce automatically removes the unique attribute from Developer, and
any deleted custom field. Database.com Editions
3. Make the field required if necessary. Salesforce automatically removes the required attribute Page Layouts and Lead
for any deleted custom field. Fields are not available in
4. Add the custom field to any appropriate Salesforce AppExchange packages. Salesforce Database.com
automatically removes deleted custom fields from packages that contain them.
5. Convert lookup relationships to a master-detail relationship if necessary. Salesforce converts all USER PERMISSIONS
relationships to lookup relationships when they are deleted. To convert a lookup relationship
to a master-detail relationship, populate all the applicable records with the appropriate data. To restore deleted custom
fields and relationships:
6. Redefine any field dependencies that Salesforce removed when the field was deleted.
• Customize Application
7. Edit and save any formula fields. Saving prompts a syntax check; if necessary, resolve errors. To permanently delete
8. Set up field history tracking if necessary. If the list of fields enabled for history tracking was custom fields or
modified during the deletion process, the restored field is no longer setup to track field history. relationships:
• Customize Application

Purge Deleted Custom Fields

Deleted fields are available for 15 days until they’re hard deleted. During that time, the field continues
EDITIONS
to count toward your custom field allocation. You can use the Purge button to initiate the hard-delete
process and free up custom field allocation for your org. Available in: Salesforce
An object’s Deleted Fields detail page lists the recently deleted fields. These fields are removed Classic
from the object but remain in the system until they’re hard deleted. When you’re at or above 75
Available in: Enterprise,
percent of your custom field allocation limit and have fields that are ready to hard delete, Salesforce
Performance, and
displays the Purge button. Click the button to free up custom fields faster than the automated Unlimited Editions
process.
After you click Purge, Salesforce asks you to confirm the action. The custom fields that are in the
ready for the hard-delete state move to the hard-delete process state. The hard-delete process completely removes the field and the
associated system data. If changing the status of the fields takes longer than 30 seconds, Salesforce sends an email with more information
to the user who clicked the button.

SEE ALSO:
Manage Deleted Custom Fields

278
Extend Salesforce with Clicks, Not Code Customize Fields

Additional Custom Field Options

Changing Page Layouts
To change the location of a new custom field, edit the page layout for the appropriate tab.
Using Record Types
If your organization uses record types, edit the record type to modify which picklist values are visible for the record type.
Tracking Custom Field History
You can select which custom fields to track on the History related list of custom objects and most standard objects. All entries include
the date, time, nature of the change, and who made the change. History data does not count against your organization’s storage
limit.
Using the Translation Workbench
If your organization uses the Translation Workbench, notify your translators that new fields need translations.
Activity Custom Fields
Activity custom fields can apply only to tasks or only to events, or to both tasks and events. For example, you can create one Time
Spent field and then add it to both the event page layout and the task page layout.
Mapping Custom Lead Fields
For lead custom fields, you can click Map Lead Fields to specify which custom lead fields to map to custom account, contact, and
opportunity fields during a lead conversion.

SEE ALSO:
Which Standard Fields Can I Encrypt?
Which Custom Fields Can I Encrypt?

Editing Rich Text Area Fields in Records

Use rich text area fields to improve the appearance of text, including adding images and hyperlinks.
EDITIONS
Rich text area fields use the rich text editor to format content. The rich text editors for custom fields
in Lightning Experience and the Salesforce mobile app have a few differences compared to rich Available in: the Salesforce
text editors in Salesforce Classic. mobile app, Salesforce
Classic, and Lightning
In Lightning Experience and the Salesforce mobile app, rich text editors for custom fields use the
Experience
open-source Quill library. In Salesforce Classic, rich text editors for custom fields use CKEditor. In
Lightning Experience, Salesforce Knowledge and emails also use the CKEditor. The rich text editors Available in: Essentials,
have the following toolbar buttons. Contact Manager, Group,
Professional, Enterprise,
Rich Text Editor Toolbar In Lightning Experience In Salesforce Classic Performance, Unlimited,
Button for Custom Fields and the Salesforce mobile and Developer Editions
app
Color USER PERMISSIONS

Format Font (Bold, Italic, To create or change custom

Underline, Strikethrough) fields:
• Customize Application
Format Body (Bulleted List,
Numbered List, Indent, and
Outdent)

279
Extend Salesforce with Clicks, Not Code Customize Fields

Rich Text Editor Toolbar Button for In Lightning Experience and the In Salesforce Classic
Custom Fields Salesforce mobile app
Align Text (Left Align, Center Align, and
Right Align)

Insert Link

Insert Image

Remove Formatting

Undo and Redo Last Action

Note: We recommend using the toolbar to format your content. The rich text editor provides only a WYSIWYG interface. You
can’t edit HTML tags. When you copy content from a web page or another source and paste it into the editor, unsupported tags
are removed. Text enclosed in unsupported tags is preserved as plain text. HTML markup counts against the character limit of the
field. For more information, see Rich Text Area Field Limitations.
Note these differences across rich text editors in Lightning Experience and the Salesforce mobile app compared to Salesforce Classic.
In Lightning Experience and the Salesforce mobile app:
• Spaces are considered non-empty values.
• The default font family is Salesforce Sans, Arial, sans-serif.
• The Insert Link button enables you to enter a URL with the _blank target value by default. This button appears disabled when
the record edit page is loaded, and is enabled after you activate the editor with your keyboard or mouse.
• The Insert Image button enables you to insert an image by uploading it or by selecting one that has been previously uploaded to
your org.
• Use keyboard shortcuts to undo and redo content formatting. In Windows, undo your last action by pressing Ctrl+Z, and reverse
your last undo by pressing Ctrl+Y. On Mac OS, use Cmd+Z and Cmd+Y. Alternatively, use the Edit menu in your browser to undo
or redo your changes.
In Salesforce Classic:
• Spaces are considered empty values.
• The default font family is Arial, Verdana, Trebuchet MS, sans-serif.
• Color formatting is preserved when you switch to Salesforce Classic to edit a custom field that’s been formatted in Lightning Experience
or the Salesforce mobile app. This occurs even though the Color button isn’t available in Salesforce Classic.
• The Insert Link button lets you enter a URL with a selection of protocols and target values. When you switch to Lightning Experience
or the Salesforce mobile app and edit the custom field, unsupported protocols or target values aren’t preserved.
• The Insert Image button lets you insert an image by uploading it or reference one that’s hosted on another server.

Implementation Tips
• Specify the size of the editor box for a rich text field by configuring the Number of lines displayed property in the field’s setup.
• When you view or print content, Salesforce preserves the formatted version of the rich text.
• Searches of content that contains rich text area fields ignore images and tags.
• Deleting a rich text area field moves it to the Deleted Fields section on the custom object or Salesforce Knowledge article types.

280
Extend Salesforce with Clicks, Not Code Customize Fields

• You can convert rich text area fields into long text area fields only. Any images get deleted the next time you save the long text area
field. After converting, markup is hidden in the long text area field but it isn’t removed from the record, so if you change your mind,
you can restore the markup before you save the record.
• The text part of a rich text area field counts toward data storage for the object that contains the field.

Pasting Content from External Sources

• You can copy and paste text from external sources, such as Microsoft® Word, but sometimes doing so requires reapplying the
formatting.
• Text from external sources can include HTML tags and special formatting that you can’t see and don’t need. The tags are counted
against the character limit of a field. We recommend pasting text into a plain text editor such as Notepad on Windows or TextEdit
on macOS first. Copy the text from the plain text editor, paste it into a rich text field, and apply formatting using the rich text field’s
buttons.
• JavaScript and CSS are treated as text. For example, if you’re creating an Idea through the API, the JavaScript or CSS code is removed
without warning. Salesforce supports a limited number of approved HTML tags.
• When a rich text area field is used in a formula, the HTML tags are stripped out before the formula is run.
• Rich text area fields can be filtered and summarized in reports, but HTML tags and special formatting aren’t included in report results.
For example, <b>some</b> <i>text</i> becomes “some text” instead of <b>some</b> <i>text</i> or some text.
• You can use a rich text area field in a mail merge, but the HTML tags are included as text in the resulting document. Images aren’t
merged.

Images in Rich Text Area Fields

• The maximum size of an image that can be uploaded in a rich text area field is 1 MB. You can upload only .gif, .jpg, and .png
file types.
• To upload many images, use API version 20 or later.

Note: When you upload images via the API, the alt attribute isn’t populated unless you specified it separately.

• Images uploaded into a rich text area field are extracted in your org’s weekly export and included in the exported data.
• Images in rich text area fields count toward file storage for the object that contains the field.
• You can’t add a hyperlink to an image.
• You can’t upload an image to a rich text area using the file:// protocol in the URL field. Instead, use http:, https:, data:,
//, /, or a relative URL.
• You can’t resize images in Lightning Experience and the Salesforce mobile app. An exception to this is in Lightning Knowledge when
using the Chrome browser.

Formatting Support
The power of the rich text editor is in its WYSIWYG interface. Type in the editor and use the toolbar to format your content as much as
you can. When you paste formatted content from another source, you can expect some formatting differences in Lightning Experience
and the Salesforce mobile app. Here are formatting considerations to look out for.

Warning: If you add a custom rich text area field in Salesforce Classic and edit it in Lightning Experience, you can also expect the
formatting differences. Saving your changes in Lightning Experience overwrites the original formatting you had in Salesforce
Classic and conversely. Alternatively, you can fix some of the formatting using the toolbar or switch to Salesforce Classic to perform
your edits.

281
Extend Salesforce with Clicks, Not Code Customize Fields

Colors
The Color button is available in Lightning Experience only. Color formatting is preserved when you edit the rich text field in Salesforce
Classic. The rich text field in Lightning Experience handles color formatting in RGB format, which adds the <span style="color:
rgb(255, 0, 0);"></span> tag around your text. The rich text field in Salesforce Classic handles color formatting in
hexadecimal format, which adds the <span style="color: #ff0000;"></span> tag around your text. The RGB and
hexadecimal value depends on the color you choose.
Definition lists
Formatting for definition lists is preserved, but the styling appears different in Lightning Experience and the Salesforce mobile app.
Definition terms are not bold.
Fonts
Pasting text with a predefined font face, color, or size converts the font tag into a span tag with the style attribute.
Headings
Heading styles are different in Lightning Experience and Salesforce Classic. Headings in Salesforce Classic are bold and become
smaller in size as the header level increases in number. Headings in Lightning Experience have the following font size and weight.
• h1: 24 px (not bold)
• h2: 18 px (bold)
• h3: 18 px (not bold)
• h4: 14 px (bold)
• h5: 14 px (not bold)
• h6: 12 px (bold)
Inline styles on h1, h2, h3, h4, h5, and h6 tags are not supported and are ignored.
Hyperlinks
Hyperlinks always open in a new window or tab in Lightning Experience and the Salesforce mobile app using target=”_blank”.
In Salesforce Classic, you can use different target values in hyperlinks in the rich text field. If you edit a rich text field with such a
link in Lightning Experience or the app, the target value is converted to _blank.
Inline styles
In Salesforce Classic, inline styles are supported on div, span, p, br, and hr tags. In Lightning Experience and the Salesforce
mobile app, inline styles are supported only on span tags.
Lists
Nested ordered lists in rich text fields are numbered differently in Salesforce Classic than they are in Lightning Experience and the
Salesforce mobile app. In Salesforce Classic, nested ordered lists are numbered with this pattern: 1, 1, 1. In Lightning Experience and
the Salesforce mobile app, nested ordered lists are numbered with this pattern: 1, a, i.
In Lightning Experience and the Salesforce mobile app, you can’t nest a bulleted list within a numbered list. The nested bulleted list
is converted to a numbered list when you paste it into the editor.
You also can’t nest a numbered list within a bulleted list. The nested numbered list is converted to a bulleted list when you paste it
into the editor.

Warning: Nesting lists of different types is supported in Salesforce Classic only. Don’t edit an existing rich text area field
containing a nested list of a different type in Lightning Experience and the Salesforce mobile app. If you do, the nested list is
converted to the same type as its parent list, even if you don’t edit the list itself.
Nested lists of the same type are supported. However, pasting a nested list into the editor flattens the list into one list in Lightning
Experience and the Salesforce mobile app. For example, a nested bulleted list within a bulleted list becomes a single bulleted list
when pasted. For nested lists of the same type, use the toolbar to adjust your list formatting. You can also press the Tab key or
Shift+Tab to create a nested list item or remove a nested list item.

282
Extend Salesforce with Clicks, Not Code Customize Fields

Note: In Lightning Experience and the Salesforce mobile app, pasting lists that are copied from Microsoft® Word is not
supported and results in list items getting converted into paragraphs. Although they look visually like lists, they are pasted as
p tags.
Paragraphs and line breaks
Pressing the Enter key creates a paragraph in Lightning Experience and the Salesforce mobile app. However, pressing the Enter key
in Salesforce Classic adds a <br> element inside the current paragraph. The visual difference is minor.
Markup for blank lines is <p><br></p> in Lightning Experience and the Salesforce mobile app, and <br> in Salesforce Classic.
If you create text in a rich text field in Lightning Experience or the Salesforce mobile app and later edit it in Salesforce Classic, markup
for the blank lines is converted to <p>&nbsp;</p>. Subsequent edits in Lightning Experience or the Salesforce mobile app don’t
change blank lines back to their original markup.
Paragraphs in rich text editors add extra characters to the text when saved in Lightning Experience and the Salesforce mobile app.
Each paragraph contributes seven characters <p> </p> to the character count. For example, if your admin specifies a 5000
character limit, you can enter only 4993 characters in the rich text editor of a custom field in Lightning Experience. Breaking the text
into multiple paragraphs further reduces the number of characters you can enter. Blank lines contribute no visible characters, but
contribute several characters with their markup.
Special Characters
Rich text field values are returned in HTML format. Some characters are escaped when the custom field value is retrieved through
the API.
• Ampersand character & is returned as &amp;
• Greater than character > is returned as &gt;
• Less than character < is returned as &lt;
• Quote character " is returned as &quot;
• Single quote character ' is returned as &#39;
Tables
In Salesforce Classic, Lightning Experience, and the Salesforce mobile app, pasting tables is supported, but you can edit only the
content within the tables.
Text-level markup
• Addresses with address tags cause enclosing list formatting to be removed.
• Nested quotes using q tags are not supported.
• Strikethrough text uses strike tags.
• Teletype text within tt tags is converted to use code tags.
This table lists supported HTML tags and formatting considerations in Lightning Experience and the Salesforce mobile app. When you
edit a rich text field or paste text with unsupported tags in Lightning Experience and the Salesforce mobile app, those tags are removed.
Text that was enclosed in unsupported tags is preserved as plain text.

HTML Tags Supported in Custom Fields in Comments for Lightning Experience and the Salesforce
Supported in Lightning Experience and the Mobile App
Salesforce Classic Salesforce Mobile App?
a The target attribute is always set to _blank. This tag is
removed if href has no value.

abbr

acronym This tag is converted into an abbr tag.

283
Extend Salesforce with Clicks, Not Code Customize Fields

HTML Tags Supported in Custom Fields in Comments for Lightning Experience and the Salesforce
Supported in Lightning Experience and the Mobile App
Salesforce Classic Salesforce Mobile App?
address When text with this tag is nested in a list and pasted in the editor,
the list tags,ol, li, and ul, are removed. Some tags before the
address tag get nested in address.

bdo

big

blockquote Consecutive block quotes are merged.

br Line breaks are nested in p tags.

caption

cite

code

col

colgroup

dd

del

dfn

div

dl

dt Definition terms are not bold.

em

font Pasting text with a predefined font face, color, or size converts the
font tag into a span tag with the style attribute.

h1 Inline styles on headings are not supported.

h2 Inline styles on headings are not supported.

h3 Inline styles on headings are not supported.

h4 Inline styles on headings are not supported.

h5 Inline styles on headings are not supported.

h6 Inline styles on headings are not supported.

hr

284
Extend Salesforce with Clicks, Not Code Customize Fields

HTML Tags Supported in Custom Fields in Comments for Lightning Experience and the Salesforce
Supported in Lightning Experience and the Mobile App
Salesforce Classic Salesforce Mobile App?
i

img

ins

kbd

li Pasting a nested list of the same type flattens the list into one list,
for example, a nested bulleted list within a bulleted list. Use the
toolbar to adjust your list formatting.

ol Nesting an ordered list (numbered) in an unordered list (bulleted)

converts the ordered list into an unordered list.

p Pressing Enter creates a new p.

pre

q Nested quotes are not supported.

s This tag is converted into a strike tag.

samp

small

span This tag is nested in a p tag, which adds extra padding around
the text.

strike

strong

sub Nested sub tags are merged.

sup Nested sup tags are merged.

table

tbody

td

tfoot

th

thead

tr

tt This tag is converted into a code tag.

285
Extend Salesforce with Clicks, Not Code Customize Fields

HTML Tags Supported in Custom Fields in Comments for Lightning Experience and the Salesforce
Supported in Lightning Experience and the Mobile App
Salesforce Classic Salesforce Mobile App?
ul Nesting an unordered list (bulleted) in an ordered list (numbered)
converts the unordered list into an ordered list.

var

SEE ALSO:
Create Custom Fields
Rich Text Fields in Knowledge Articles

Rich Text Area Field Limitations

Keep these limitations in mind when working with rich text area fields.
EDITIONS
Rich text area fields aren’t available in self-service portals and they aren’t supported for external
objects. Also, consider the following limitations. Available in: the Salesforce
mobile app, Salesforce
Character Limits
Classic, and Lightning
• Salesforce supports up to 131,072 characters for each rich text area field, including the Experience
HTML tags. If desired, you can set a lower limit.
Available in: Essentials,
• An object can contain unlimited rich text area and long text area fields, although your Contact Manager, Group,
edition’s allocation for total custom fields allowed on an object, regardless of field type, Professional, Enterprise,
applies. Each object can contain 1,638,400 characters across long text area and rich text Performance, Unlimited,
area fields. When you create a long text area or rich text area field, you set a character limit and Developer Editions
for the field—the maximum length of the text that can be entered. The default character
limit for long text area and rich text area fields is 32,768 (32 KB). The maximum character
limit for long text area and rich text area fields is 131,072 (128 KB). The minimum character limit is 256.
• You can’t paste special characters, such as bullets or curly quotes, into a rich text field from another application. It’s best to type
or paste in plain text and use the rich text editor to format it.
• HTML code isn’t supported in the Salesforce HTML editor. HTML code is treated as text.
• The character count includes HTML markup that is not visible in the editor. The HTML markup is returned through the API.
Depending on how much formatting you apply, the number of characters you can type into the rich text field is fewer than the
specified limit. This is because the HTML markup counts against the character limit of a field. For example, bold formatting
includes the <b></b> tag around your text and adds up to 7 more characters. Special characters like & are encoded as &amp;
which adds up to 5 more characters. Also, the rich text field in Lightning Experience and Salesforce Classic can vary in HTML
markup, such as with using RGB or hexadecimal values when color formatting is applied. Paragraph and line breaks also insert
the <p></p> and <br> tags, counting against the character limit. See Editing Rich Text Area Fields in Records for information
on formatting support.
Formatting and Toolbar Differences Between Lightning Experience and Salesforce Classic
The rich text editors for custom fields in Lightning Experience and the Salesforce mobile app come with a few differences, as compared
to rich text editors in Salesforce Classic. See Editing Rich Text Area Fields in Records.
Images and Hyperlinks
• You can’t disable specific rich text area features. For example, you can't disable support for hyperlinks or images on certain fields.

286
Extend Salesforce with Clicks, Not Code Customize Fields

• You can’t upload an image to a rich text area using the file:// protocol in the URL field. Instead, use http:, https:,
data:, //, /, or a relative URL.
• When uploading an image to a rich text area, you must enter a URL that is valid and well-formed.
Reports
• Only the first 254 characters in a rich text area or a long text area are supported with the “contains” operator in a report filter.
• The first 999 characters in a standard rich text area or a long text area are displayed in a report. For custom fields, only the first
255 characters are displayed. If you download the report as Details Only, the entire field is available.

Valid Range for Date Fields

Only dates within a certain range are valid. The earliest valid date is 1700-01-01T00:00:00Z GMT, or just after midnight on January 1,
1700. The latest valid date is 4000-12-31T00:00:00Z GMT, or just after midnight on December 31, 4000. These values are offset by your
time zone. For example, in the Pacific time zone, the earliest valid date is 1699-12-31T16:00:00, or 4:00 PM on December 31, 1699.

Classic Encryption for Custom Fields

Restrict other Salesforce users from seeing custom text fields that you want to keep private. Only
EDITIONS
users with the View Encrypted Data permission can see data in encrypted custom text fields.
Before you begin working with encrypted custom fields, review these implementation notes, Available in: both Salesforce
restrictions, and best practices. Classic and Lightning
Experience

Implementation Notes Available in: Developer,

Enterprise, Performance,
• Encrypted fields are encrypted with 128-bit master keys and use the Advanced Encryption
Unlimited, and
Standard (AES) algorithm. You can archive, delete, and import your master encryption key. To
Database.com Editions
enable master encryption key management, contact Salesforce.
• You can use encrypted fields in email templates but the value is always masked regardless of
whether you have the View Encrypted Data permission.
• If you have the View Encrypted Data permission and you grant login access to another user, the user can see encrypted fields in
plain text.
• Only users with the View Encrypted Data permission can clone the value of an encrypted field when cloning that record.
• Only the <apex:outputField> component supports presenting encrypted fields in Visualforce pages.

Restrictions
Encrypted text fields:
• Can’t be unique, have an external ID, or have default values.
• Aren’t available for mapping leads to other objects.
• Are limited to 175 characters because of the encryption algorithm.
• Aren’t available for use in filters such as list views, reports, roll-up summary fields, and rule filters.
• Can’t be used to define report criteria, but they can be included in report results.
• Aren’t searchable, but they can be included in search results.
• Aren’t available for Connect Offline, Salesforce for Outlook, lead conversion, workflow rule criteria or formulas, formula fields, outbound
messages, default values, and Web-to-Lead and Web-to-Case forms.

287
Extend Salesforce with Clicks, Not Code Customize Fields

Best Practices
• Encrypted fields are editable regardless of whether the user has the View Encrypted Data permission. Use validation rules, field-level
security settings, or page layout settings to prevent users from editing encrypted fields.
• You can still validate the values of encrypted fields using validation rules or Apex. Both work regardless of whether the user has the
View Encrypted Data permission.
• To view encrypted data unmasked in the debug log, the user must also have the View Encrypted Data in the service that Apex
requests originate from. These requests can include Apex Web services, triggers, workflows, inline Visualforce pages (a page embedded
in a page layout), and Visualforce email templates.
• Existing custom fields can’t be converted into encrypted fields nor can encrypted fields be converted into another data type. To
encrypt the values of an existing (unencrypted) field, export the data, create an encrypted custom field to store that data, and import
that data into the new encrypted field.
• Mask Type isn’t an input mask that ensures the data matches the Mask Type. Use validation rules to ensure that the data entered
matches the mask type selected.
• Use encrypted custom fields only when government regulations require it because they involve more processing and have
search-related limitations.

Note: This page is about Classic Encryption, not Shield Platform Encryption. What's the difference?

SEE ALSO:
Create Custom Fields

Add or Edit Picklist Values

Add or edit values in a custom picklist from the fields area of an object. If the picklist uses a global
EDITIONS
picklist value set, you can change its values only by editing the global value set. Your changes affect
all picklists that inherit their values from that global value set. Available in: both Salesforce
Note: Changes to picklist values are logged in Setup Audit Trail. To view the audit history: Classic and Lightning
Experience
From Setup, enter View Setup Audit Trail in the Quick Find box, then select
View Setup Audit Trail. Available in: All Editions
1. Navigate to the fields area for your object.
2. In the Custom Fields & Relationships related list, click the name of the picklist field to update. USER PERMISSIONS
3. In the Values section, click Edit next to a value. To change picklists:
4. Change the value’s name, and optionally make the value the default for the master picklist. • Customize Application
5. Assign a color to use in charts by clicking the button and selecting how to assign colors to
values.
• Assign fixed colors to all values assigns a fixed color to each value from the standard set of chart colors. The Chart Colors
column shows the assigned colors. For example, if you want Closed Lost values always to be red in charts grouped by Opportunity
Stage, assign red to that picklist value.
• Assign colors to values dynamically assigns colors when a chart is generated. For example, if you need only certain picklist
values to have fixed colors in charts, manually assign colors to those values and leave the rest to be assigned dynamically.

Note: Chart colors aren’t available for multi-select picklists, currency picklists, or Task Subject, Event Subject, Knowledge
Validation Status, and Opportunity Competitor picklists.

288
Extend Salesforce with Clicks, Not Code Customize Fields

Tip:
• If you use record types, changing the default value of the master picklist doesn’t affect the default value of the picklist for
a record type.
• For Ideas, setting the default value of the Categories or Status picklists doesn’t affect the default value on the Ideas pages.
• If you change the label for a picklist value that’s used as a filter criterion, the picklist value is automatically removed from
the filter criteria. For example, if your report contains a filter where Lead Source equals Email or Web and
you change the picklist value Web to Referral, your report filter changes to Lead Source equals Email. If the
changed picklist value was the only value specified for a particular filter, it continues to show up in your filters, but an error
appears.

6. Click Save. When you add or edit a picklist value in either a picklist field or in a global value set, the new picklist value isn't sorted.
You must reorder the picklist values.
7. To make the picklist required (if it’s not already), click Edit at the top of the detail page, and check Always require a value in this
field in order to save a record.
8. To change the picklist from unrestricted to restricted or vice versa, adjust the Restrict picklist to the values defined in the value
set setting.
9. To open an easy-to-print list of your picklist values, click Printable View.

Note: If your org uses the Translation Workbench, notify your translators that the translations can be outdated after you change
picklist values.

Delete, Deactivate, Replace, or Activate Multiple Picklist Values

Save time by managing all your picklist values at once.
Picklists with Additional Information
Picklist Limitations
Replace Picklist Values
As your business changes, replace picklist values with more relevant alternatives. Replacing a value globally replaces that field value
on all existing records.
Remove a Picklist Value
Remove or replace custom picklist values to update the records that have the picklist field.
Protect Picklist API Names for Formulas and Integrations
When you create a picklist value, an API Name that matches the Label is assigned. By default, the API Name can be changed at any
time, but you can choose to protect the API Name.
Sort Picklists
You can arrange picklist values in a specific order or sort them alphabetically.

289
Extend Salesforce with Clicks, Not Code Customize Fields

Manage Inactive Picklist Values

Establish upper bound limits, deactivate, reactivate, or remove a value from a restricted or unrestricted picklist.

SEE ALSO:
Manage Inactive Picklist Values
Replace Picklist Values
Protect Picklist API Names for Formulas and Integrations
Picklist Limitations
Delete, Deactivate, Replace, or Activate Multiple Picklist Values

Delete, Deactivate, Replace, or Activate Multiple Picklist Values

Save time by managing all your picklist values at once.
EDITIONS
Follow these steps to manage multiple picklist values.
Available in: Salesforce
1. Navigate to the custom field definition page for the picklist field.
Classic and Lightning
2. In the Values and Inactive Values sections, there’s a checkbox next to each picklist value. Select Experience
multiple values, and use one of the new buttons: Delete Selected, Deactivate Selected,
Replace Selected, or Activate Selected. Available in: all editions

This feature is available only for custom picklists with predefined values.
USER PERMISSIONS
Picklists with Additional Information To create or change custom
fields:
These standard picklist fields have additional information that you can edit.
• Customize Application

Picklist Description
Partner Role (for accounts) Roles of account partners, for example,
Consultant, Supplier. These options are available
when you add an account to the Partners related
list of an account or opportunity.
To edit, from Setup, enter Partner Roles
in the Quick Find box, then select Partner
Roles.
Enter the name of the partner role in the “Role”
column. In the “Reverse Role” column, enter the
corresponding reverse partner role. Assigning
a partner role to an account creates a reverse
partner relationship so that both accounts list
the other as a partner.
Each role and reverse role value can have up to
40 characters.

290
Extend Salesforce with Clicks, Not Code Customize Fields

Picklist Description
Priority (for cases) Urgency of case, for example, Low, High.
If you delete a value, you have the option to map the deleted value
to another existing value in all your org’s cases.
Each picklist value can have up to 40 characters.

Status (for campaign members) State of a campaign member, for example, Sent or Responded.
If you delete a Status value, you have the option to map the deleted
value to another existing value. The new replacement value is
automatically added to the member status for campaigns that
contained the deleted value.
If the deleted value is the default member status for a campaign,
the new replacement value becomes the default status for that
campaign.

Status (for cases) State of case, for example, New, On Hold.

If you delete a value, you have the option to map the deleted value
to another existing value in all your org’s cases.
Each picklist value can have up to 40 characters.

Status (for contracts) State of the contract in the contract business process. You can add
values to this picklist and organize each value into one of several
categories, for example, “Draft”, “In Approval Process”, or
“Activated”. Then sort your contracts using these categories in
reports and views.

Contact Role (for contracts) Role of a contact on a contract, for example, Business User, Decision
Maker. These options are available when you add a contact to the
Contact Roles related list of a contract.
To edit, from Setup, enter Contact Roles in the Quick
Find box, then select Contact Roles on Contracts.
Each picklist value can have up to 40 characters.

Lead Status (for leads) State of the lead, for example, Open, Qualified.
Select one value as the “Default Status” assigned to all new leads
created manually, via imports, or via your website. Select one or
more values as the “Converted Status” assigned to converted leads.
When you convert qualified leads into an account, contact, and
opportunity, you can select one of the “Converted” statuses to
assign to the lead. Leads with a “Converted” status type are no
longer available in the Leads tab, although you can include them
in reports.
If you delete a value, you have the option to map the deleted value
to another existing value in all your org’s leads.
Each value can have up to 20 characters.

291
Extend Salesforce with Clicks, Not Code Customize Fields

Picklist Description
Contact Role (for opportunities) Role of a contact for an opportunity, for example, Business User,
Decision Maker. These options are available when you add a contact
to the Contact Roles related list of an opportunity.
To edit, from Setup, enter Contact Roles in the Quick
Find box, then select Contact Roles on Opportunities.
Each picklist value can have up to 40 characters.

Stage (for opportunities) Sales process stages, for example, Prospect, Proposal. This picklist
also affects the Type and Forecast Category values of
an opportunity. Specifically, changing the Type or Forecast
Category for a Stage picklist value updates all opportunities
that have that stage value.
To edit, from the management settings for opportunities, go to
Fields, and then click Edit next to Stage.
To deactivate an active stage, click Del next to the stage. On the
mapping page, don't replace the stage with another existing value;
just click Save. The stage now appears in the Inactive Stage Picklist
Values related list. The stage is no longer in use but can exist in
older opportunity records.

Status (for solutions) Status of a solution, for example, Draft, Reviewed. Mark one or more
values as “Reviewed”. When users solve cases using solutions, they
can view which solutions have been reviewed and which have not.
Each picklist value can have up to 40 characters.

Priority (for tasks) Importance of the task, for example, High, Normal, Low. Set one
value as the default priority of all new tasks, and one value as the
highest priority.
If you delete a value, you have the option to map the deleted value
to another existing value in all your org’s tasks.
Each picklist value can have up to 20 characters.

Status (for tasks) State of a task, for example, Not Started, Completed. Choose at
least one value as the “Closed” status and one value as the “Default”
status for all new tasks.
If you delete a value, you have the option to map the deleted value
to another existing value in all your org’s tasks.
Each picklist value can have up to 40 characters.

Task Type (for tasks) Send Email Default specifies the default task type assigned
when the task is sending email or mass email, and when tasks are
created via inbound email, such as Email to Salesforce. Default
specifies the default picklist value when creating tasks.

292
Extend Salesforce with Clicks, Not Code Customize Fields

Picklist Description
To edit, from the management settings for tasks, go to Fields, and
then click Edit next to the picklist value that you want to specify
as the default.

SEE ALSO:
Picklist Limitations

Picklist Limitations
The maximum number of characters you can have in a picklist depends on the type of picklist. Each
EDITIONS
picklist value includes a line break and a return character that aren’t visible but that count in the
character limit. Available in: both Salesforce
When selecting picklist values for a list view filter, the combined size of the selected picklist values Classic and Lightning
must be fewer than 240 characters. Experience

Other limits apply to standard and custom picklists. Available in: All Editions
Standard Picklists aren’t
Other Limits for Standard Picklists available in Database.com

For standard picklists, each value can have up to 255 characters, not including line breaks and
returns. This limit applies to single-select and multi-select picklists. USER PERMISSIONS

Picklist Field Maximum Number of Values To change picklists:

• Customize Application
Lead Status 100

Task Status 100

Task Priority 50

Case Status 100

Case Priority 50

Opportunity Stage 100

Limits for Custom Picklists

Inactive and active picklist value limits:
• Restricted picklists have a combined active and inactive limit of 1,000 values.
• Unrestricted picklists have a limit of 1,000 active values, and bound unrestricted picklists have a limit of 4,000 inactive values.
• By default, all newly created unrestricted picklists are bound to the 4,000 inactive value limit.
Custom single-select picklists limits:
• Up to 1,000 values.
• Up to 255 characters per value.
Custom multi-select picklists limits:

293
Extend Salesforce with Clicks, Not Code Customize Fields

• Up to 500 values.
• Up to 255 characters per value.
• Users can select up to 100 values at a time on a record.
Global picklist value sets limits:
• Global picklist value sets have a combined active and inactive value limit of 1,000.
• You can have up to 500 picklist global value sets in an org.
• There’s no limit on the number of custom picklists that use global picklist value sets.
• If you apply a global picklist value set to more than 13 different objects, you can deactivate values from the picklist value set, but
you can’t replace any picklist values or delete values from the set.

Functional Limitations for Custom Picklists

• You can make a custom single-select picklist field into a restricted picklist only if the picklist has fewer than 1,000 values (or entries).
You can make a custom multi-select picklist field into a restricted picklist only if the picklist has fewer than 500 values (or entries). A
restricted picklist’s values are limited to only those values defined by a Salesforce admin, which prevents users from loading redundant
or erroneous values through the API.
• Global picklist value sets are always restricted picklists, which preserves data integrity. Global value sets are shared across objects.
Reuse the value set for any custom picklist field.
• For custom picklist fields that use a global picklist value set, you can change from a single-select to multi-select picklist and vice
versa. But you can’t change the picklist to a different field type such as checkbox, currency, or text.
• You can’t undo a custom picklist field’s association with a global value set. To use a different global value set or different individual
values in a picklist, delete the custom picklist field and replace it with a new picklist.

Replace Picklist Values

As your business changes, replace picklist values with more relevant alternatives. Replacing a value
EDITIONS
globally replaces that field value on all existing records.
For example, let’s say you have a status picklist with three different closed values, Closed-red, Available in: both Salesforce
Closed-yellow, and Closed-green, and you want to simplify those three values to just one. Replace Classic and Lightning
them with the new value Closed. Experience

Important: If you replace a parent value in a controlling picklist, the picklist dependency on Available in: All Editions
that value is lost. After replacing the parent value, re-create the dependency using the new
parent value. USER PERMISSIONS
1. If necessary, create the replacement value in the picklist edit page. See Add or Edit Picklist
Values. To replace picklist values:
• Customize Application
2. Navigate to the picklist.
• For a global picklist value set: From Setup, enter picklist in the Quick Find box,
then select Picklist Value Sets.
• For a picklist on an object, go to the fields area of the object. For example, for an Account picklist: From Setup, enter Account
in the Quick Find box, then select Fields under Accounts.

3. Start the picklist value replace process.

• For a global picklist value set: Go to the Global Value Set Detail page by clicking the picklist name. In the Values section, click
Replace.
• For all other picklists: Click Replace next to the picklist name.

294
Extend Salesforce with Clicks, Not Code Customize Fields

4. Enter the value you want to change, and select a new replacement value.

Note: Replacing an existing picklist value also changes the Modified By date and time for the record.

5. To use the new value in records where this field is empty, select Replace all blank values.
6. To update all occurrences of the value in your org’s records with the new value, click Replace. Occurrences in the Recycle Bin are
also updated.
The replace job is queued. To check the job’s status, from Setup, enter Background Jobs in the Quick Find box, then select
Background Jobs. You receive an email when the job is complete.

Note: If you replace the Stage picklist for opportunities, the Probability, Forecast Category, and Expected
Revenue fields are also updated with the corresponding values.

SEE ALSO:
Create a Global Picklist Value Set
Protect Picklist API Names for Formulas and Integrations
Manage Inactive Picklist Values

Remove a Picklist Value

Remove or replace custom picklist values to update the records that have the picklist field.
You have several ways to remove existing picklist field values. And, the steps are a little different when your picklist values are part of a
global picklist value set. While you remove them, you can also to replace them with another value. For more information on replacing
an existing value, see Replace Picklist Values. The following steps remove existing values.
1. Navigate to the picklist.
• For a global picklist value set: From Setup, enter picklist in the Quick Find box, then select Picklist Value Sets.
• For a picklist on an object, go to the fields area of the object. For example, for an Account picklist: From Setup, enter Account
in the Quick Find box, then select Fields under Accounts.

2. Click the picklist name.

3. To remove a value from the picklist, click Del next to the value’s name.
Decide whether to replace the value or leave it blank. If you replace it with a blank value, existing records will not display the value
anymore. To keep the value on existing records, use Deactivate, instead of Del.

Note: Some special picklists,such as opportunity Stage, Task Priority, Task Status, Lead Status, and
Case Status,prompt you to map the deleted value to another existing value in all your org’s records. You can map the
values or leave your existing data unchanged.
Using the option to replace a picklist value while deleting the current value does not trigger workflow rules.

For orgs using record types, include some or all the values from the master picklist in different record types to offer a subset of values
to users based on their profile.

295
Extend Salesforce with Clicks, Not Code Customize Fields

Protect Picklist API Names for Formulas and Integrations

When you create a picklist value, an API Name that matches the Label is assigned. By default, the
EDITIONS
API Name can be changed at any time, but you can choose to protect the API Name.
A picklist value is identified by either the displayed value or the API Name. Formulas reference the Available in: both Salesforce
API Name so that the formula continues to work even if the displayed value changes. An admin Classic and Lightning
can prevent changes to the API Name to protect the references to the fields in formulas or during Experience
integrations, such as data import.
Available in: All Editions
1. From Setup, enter picklist in the Quick Find box, then select Picklist Settings.
2. To prevent changes to the API names for any of the values, select Disable editing picklist USER PERMISSIONS
values' API names.
If you need to change an API Name later, you can deselect this option. To customize picklist
settings:
• Customize Application
SEE ALSO:
Create a Custom Picklist Field
Replace Picklist Values
Add or Edit Picklist Values

Sort Picklists
You can arrange picklist values in a specific order or sort them alphabetically.
EDITIONS
1. From the management settings for the picklist field’s object, go to Fields.
Available in: both Salesforce
• For custom task or event fields, go to the object management settings for Activities.
Classic and Lightning
• For standard task fields, go to the object management settings for Tasks. For standard event Experience
fields, go to the object management settings for Events.
Available in: All Editions
• For Knowledge validation status picklists, from Setup, in the Quick Find box, enter
Validation Statuses, and then select Validation Statuses.
USER PERMISSIONS
2. Click the name of the picklist to update.
3. Click Reorder. To sort picklists:
• Customize Application
4. Use the arrows to arrange the field in the proper sequence.
5. Select a default value if desired.
6. To alphabetize the entries for users on edit pages, check Sort values alphabetically....
7. Save your changes.
On record edit and detail pages and in reports, picklist and multi-select picklist fields can include inactive values. These inactive values
are sorted last, unless you choose alphabetical sorting. In that case, all values are sorted alphabetically.

Note: For English locale users, hyphens and spaces in picklist values are ignored when picklists are sorted alphabetically. To view
values in a different order, use manual sorting.

SEE ALSO:
Find Object Management Settings

296
Extend Salesforce with Clicks, Not Code Customize Fields

Manage Inactive Picklist Values

Establish upper bound limits, deactivate, reactivate, or remove a value from a restricted or unrestricted
EDITIONS
picklist.
Having inactive picklist values can be a result of an import or intentionally removing the value from Available in: both Salesforce
the list of available values for future use. In certain cases, importing text fields can create numerous Classic and Lightning
unwanted picklist fields. Managing your inactive picklist values and enforcing limits on inactive Experience
values for unrestricted picklists can improve performance and improve your Salesforce org’s overall
Available in: All Editions
health.

Get a List of Custom Picklist Fields with Inactive Values

Get email notifications when custom picklist fields have more than 4,000 inactive values and then use this information to bulk delete
the inactive unused values. This feature is available only for custom picklists with predefined values.
Bulk Delete Inactive Picklist Values
Managing your inactive picklist values and enforcing limits on the number of inactive values for custom picklists can improve
performance and the overall health of your Salesforce org. If you have a picklist with a large number of inactive unused values, you
can bulk delete them.
Establish an Upper Bound Limit
You can enforce an upper bound limit of inactive values on existing picklists. The limit is enforced on the inactive values of unrestricted,
custom picklists whose numbers don’t exceed the allowable limit. By default, all new unrestricted picklists have an enforced limit of
4,000 inactive values.
View Active and Inactive Picklist Values
You can view the number of active and inactive picklist values and the maximum number allowed from the picklist field detail page.
Converting a Text Field Type to a Picklist
By default, an upper bound limit of 4,000 is applied to inactive unrestricted picklists for each field. If you exceed this limit when
converting a text field to a picklist field, you get an error message.
Deactivate and Reactivate Values
Deactivate, reactivate, or remove a value from a restricted or unrestricted custom picklist. If it’s a global picklist value set, these actions
simultaneously update all custom picklists that inherit its value set.

SEE ALSO:
Delete, Deactivate, Replace, or Activate Multiple Picklist Values

297
Extend Salesforce with Clicks, Not Code Customize Fields

Get a List of Custom Picklist Fields with Inactive Values

Get email notifications when custom picklist fields have more than 4,000 inactive values and then
EDITIONS
use this information to bulk delete the inactive unused values. This feature is available only for
custom picklists with predefined values. Available in: Salesforce
Follow these steps to get an email notification for custom picklists that have more than 4,000 values. Classic and Lightning
Experience
1. From Setup, in the Quick Find box, enter Settings, and then select Picklist Settings.
2. In the Picklist Settings window, click Email Me to receive an email with the picklist fields and Available in: All Editions
the number of inactive values.
USER PERMISSIONS

To create or change custom

fields:
• View Setup and
Configuration

In the email, click the picklist name to go to the picklist field page and delete any inactive unused values.

SEE ALSO:
Bulk Delete Inactive Picklist Values
Picklist Limitations

Bulk Delete Inactive Picklist Values

Managing your inactive picklist values and enforcing limits on the number of inactive values for
EDITIONS
custom picklists can improve performance and the overall health of your Salesforce org. If you have
a picklist with a large number of inactive unused values, you can bulk delete them. Available in: Salesforce
These rules apply when bulk deleting picklist values. Classic and Lightning
Experience
• This feature is available only for custom picklist fields on an object. It’s not available for standard
or multi-select picklist fields. Available in: all editions
• This feature is only for picklist fields that have defined values. It’s not available for picklist fields
that use a global value set. USER PERMISSIONS
• This feature deletes inactive, unused picklist values. If a picklist value is inactive but still referenced
in a record, the value isn’t deleted. To create or change custom
fields:
• After you delete unused values, if a picklist is unbound and the total number of inactive values • Customize Application
falls below the limit, the field is set to a bound picklist.
• While the job that deletes inactive values runs, these actions are unavailable on that picklist
field: Activate, Activate Selected, Deactivate, Deactivate Selected, Delete, Delete Selected, Replace, and Replace Selected. The buttons
are enabled, but an error message is returned when you click them.

298
Extend Salesforce with Clicks, Not Code Customize Fields

• While the job that deletes inactive values runs, changes to the picklist field via Metadata API are unavailable. You can retrieve data
from the field, but you can’t create a picklist value, update the field or its values, delete the field or its values, or deploy the field.
Follow these steps to delete all inactive unused values from a picklist.
1. From Setup, in the Quick Find box, enter Object Manager, and then select your object.
2. Click Fields & Relationships, and then click the picklist field. In the Picklist Values Used section, you can see how many inactive
picklist values the field has.
3. From the Inactive Values section of the picklist field, click Delete Unused Values.
4. Click OK. The job that deletes the inactive values runs in the background and the button becomes disabled.

The job that deletes inactive values runs in the background. It can take some time to finish depending on the number of inactive values.
A record of the change is added in the Setup Audit Trail.
To see the status of the job tasks, use the Background Jobs page. Deleting inactive picklist values involves three job tasks.
• Unused Picklist Values Delete Task (Final Delete)
• Unused Picklist Values Delete Task (Filter)
• Unused Picklist Values Delete Task (Prepass)
The job has completed successfully when the status of Unused Picklist Values Delete Task (Final Delete) is Completed.
After all the picklist values are deleted, you receive an email that tells you whether the deletion was successful or not. The email is sent
to the email address associated with the user who initiated the deletion.
If you receive a success email and still see inactive picklist values in the Inactive Values section, those picklist values likely are referenced
in a record. You can delete only picklist values that aren’t used in any records. To identify which records use the inactive picklist values
that you want to delete, you can run a SOQL query or create a report.

SEE ALSO:
Get a List of Custom Picklist Fields with Inactive Values
Picklist Limitations

299
Extend Salesforce with Clicks, Not Code Customize Fields

Establish an Upper Bound Limit

You can enforce an upper bound limit of inactive values on existing picklists. The limit is enforced
EDITIONS
on the inactive values of unrestricted, custom picklists whose numbers don’t exceed the allowable
limit. By default, all new unrestricted picklists have an enforced limit of 4,000 inactive values. Available in: Salesforce
1. From Setup, in the Quick Find box, enter Picklist Settings, and then select Picklist Classic and Lightning
Settings. Experience

2. On the Picklist Settings page, click Establish upper bound on existing picklists. Available in: All Editions
A query runs to identify picklists that have fewer than 4,000 inactive values. The limit is then enforced
only on those picklists. A message appears to show the number of picklists that were bound to the USER PERMISSIONS
limit, or that there are no unbound picklists that meet the limit.
To create or change custom
You can run the upper bound on existing picklists multiple times. For example, if you delete picklist
fields:
values, you can potentially reduce the total number of values to be less than the limit. Admins or
• Customize Application
Salesforce can’t configure the limit of 4,000 inactive values.

SEE ALSO:
Converting a Text Field Type to a Picklist

View Active and Inactive Picklist Values

You can view the number of active and inactive picklist values and the maximum number allowed
EDITIONS
from the picklist field detail page.
These limits are applied. Available in: Salesforce
Classic and Lightning
• Restricted picklists have a combined active and inactive limit of 1,000.
Experience
• Bound unrestricted picklists have a limit of 1,000 active picklist values and a limit of 4,000 inactive
picklist values. Available in: All Editions
• Global picklist value sets have a combined active and inactive limit of 1,000.
• Existing unbound picklists have no limit. By default, all newly created picklists are bound to the USER PERMISSIONS
4,000 inactive limit.
To create or change custom
1. Navigate to the picklist. fields:
• For a picklist on an object, go to the fields section of the object. • Customize Application

• For a global picklist, from Setup, in the Quick Find box, enter picklist, and then select
Picklist Value Sets.

2. To go to the picklist’s detail page, click the picklist name.

The Picklist Values Used section shows the active and inactive number of picklist values and the maximum number allowed.

SEE ALSO:
Deactivate and Reactivate Values
Delete, Deactivate, Replace, or Activate Multiple Picklist Values

300
Extend Salesforce with Clicks, Not Code Customize Fields

Converting a Text Field Type to a Picklist

By default, an upper bound limit of 4,000 is applied to inactive unrestricted picklists for each field.
EDITIONS
If you exceed this limit when converting a text field to a picklist field, you get an error message.
These rules apply to conversion: Available in: both Salesforce
Classic and Lightning
• The limit isn’t case-sensitive.
Experience
• If there are more than 4,000 unique values, the conversion fails. This conversion limit includes
active picklists. Available in: All Editions
• Soft-deleted values count toward the 4,000 unique value limit. To avoid values that count
toward the limit, permanently delete any soft deleted records and field values by emptying the
recycle bin.
• Keep this setting: Remove upper bound on inactive picklist values.
• You can’t convert a defined unique text field to a picklist or a multi-select picklist.
1. From the management settings for the field’s object, go to Fields.
2. Click Edit next to the custom field that you want to change.
3. Click Change Field Type.
4. Select a Picklist and click Next.
5. Enter a field label, name, and any other attributes, and then save your changes.

SEE ALSO:
Change the Custom Field Type
Establish an Upper Bound Limit
Notes on Changing Custom Field Types

Deactivate and Reactivate Values

Deactivate, reactivate, or remove a value from a restricted or unrestricted custom picklist. If it’s a
EDITIONS
global picklist value set, these actions simultaneously update all custom picklists that inherit its
value set. Available in: Salesforce
Note: Only a Salesforce admin can modify the values of a restricted picklist. Users can’t add Classic and Lightning
Experience
unapproved values, even through the API.
The unrestricted picklist values for the Task.Subject and Event.Subject fields Available in: All Editions
can’t be deactivated. The picklist values are deleted instead of deactivated.

1. Navigate to the picklist you want to modify.

USER PERMISSIONS

• For a picklist on an object, go to the fields section of the object. To create or change custom
fields:
• For a global picklist, from Setup, in the Quick Find box, enter picklist, then select
• Customize Application
Picklist Value Sets.

2. Go to the picklist’s detail page by clicking the picklist’s name.

3. In the Values section, modify the picklist value. These actions simultaneously update all custom picklists that inherit its value set.
• To deactivate a value, which removes it from the picklist but keeps it on existing records, click Deactivate next to the value’s
name. The value moves to the Inactive Values section. If you need the value again later, click Activate next to its name.

301
Extend Salesforce with Clicks, Not Code Customize Fields

• To remove a value from the picklist and all records that use it, click Del next to the value’s name, and select Replace value on
records with blank value. Then save the changes.
• To remove a value from a global picklist and any custom picklists that share its value set, click Del next to the value’s name, and
then click OK. If any custom picklists use this global picklist value set, you’re prompted to replace the value with a blank value
or an existing, active value. If no custom picklists use the value set, the value is deleted from the global picklist.
If a global picklist value is used in historical trending, it’s deactivated but not deleted.
Deleting a value in a global picklist value set or on non-global, restricted picklists goes to the background jobs queue. When the job
completes, your picklist is updated and you’re notified by email.
Changes to picklist values are logged in Setup Audit Trail. To view the audit history, from Setup, in the Quick Find box, enter View
Setup Audit Trail, then select View Setup Audit Trail.
Using the option to replace a picklist value while deleting the current value doesn’t trigger workflow rules.

Define Dependent Picklists

Specify the dependent picklists and their values for your org.
EDITIONS
Tip: If your org uses record types, make sure that your controlling and dependent picklist
values are available in the appropriate record types before defining a dependent picklist. Available in: both Salesforce
Classic and Lightning
1. From the management settings for the object you want to add a field to, go to Fields. Custom Experience
task and event fields are accessible from the object management settings for Activities.
Available in: All Editions
2. Click Field Dependencies.
Standard Objects aren’t
3. Click New. available in Database.com
4. Choose a controlling field and dependent field.

Note: Some picklist and checkbox fields aren’t available as controlling fields. USER PERMISSIONS

5. Click Continue. To define dependent

picklists:
6. Use the field dependency matrix to specify the dependent picklist values that are available
• Customize Application
when a user selects each controlling field value.
7. Optionally, click Preview to test your selections. If your organization uses record types, choose
a record type to test how it affects your controlling and dependent picklist values. The record type controls what values are available
in the controlling field. The record type and the controlling field together determine what values are available in the dependent
picklist. For example, a dependent value is only available if it’s available in the selected record type and the selected controlling
value.

Note: The Filter by Record Type option doesn’t appear in the Preview window for activity custom fields.

8. Click Save.

Dependent Picklists
Use the Field Dependency Matrix
The field dependency matrix lets you specify the dependent picklist values that are available when a user selects each controlling
field value. The top row of the matrix contains the controlling field values, while the columns list the dependent field values. Use
this matrix to include or exclude values. Included values are available in the dependent picklist when a value in the controlling field
is selected. Excluded fields aren’t available in the dependent picklist for the selected controlling field value.

302
Extend Salesforce with Clicks, Not Code Customize Fields

Edit Dependent Picklists

Delete Picklist Dependencies
Dependent Picklist Considerations

Dependent Picklists
Use dependent picklists to help your users enter accurate and consistent data. A dependent picklist
EDITIONS
is a custom or multi-select picklist for which the valid values depend on the value of another field,
called the controlling field. Controlling fields can be any picklist (with at least one and fewer than Available in: both Salesforce
300 values) or checkbox field on the same record. Classic and Lightning
For example, you can define a Reason custom picklist on opportunities and make its valid values Experience
depend on the value of the Stage picklist as follows: Available in: All Editions
• If Stage is Closed Won, the valid values for Reason are Superior features or
Lower price.
• If Stage is Closed Lost, the valid values for Reason are Inferior features, Higher price, or Company
viability.

SEE ALSO:
Define Dependent Picklists
Dependent Picklist Considerations

Use the Field Dependency Matrix

The field dependency matrix lets you specify the dependent picklist values that are available when
EDITIONS
a user selects each controlling field value. The top row of the matrix contains the controlling field
values, while the columns list the dependent field values. Use this matrix to include or exclude Available in: both Salesforce
values. Included values are available in the dependent picklist when a value in the controlling field Classic and Lightning
is selected. Excluded fields aren’t available in the dependent picklist for the selected controlling Experience
field value.
Available in: All Editions
To include or exclude values:
• Double-click values to include them. Included values are indicated with highlighting. Double-click
USER PERMISSIONS
any highlighted values to exclude them.
• To select a range of adjacent values, click a value and use SHIFT+click another value. Then click To define picklist
Include Values to make the values available, or Exclude Values to remove them from the list dependencies:
of available values. • Customize Application
• Click a value and use CTRL+click to select multiple values. Then click Include Values to make
the values available, or Exclude Values to remove them from the list of available values.
• To select all the values in that column, click a column header. Then click Include Values to make the values available, or Exclude
Values to remove them from the list of available values.
To change the values in your view:
• To view all available values at once, click View All.
• To view all the dependent values in that column, click Go To and choose a controlling value.
• To view the values in columns that are on the previous or next page, click Previous or Next.
• To view 5 columns at a time, click View sets of 5.

303
Extend Salesforce with Clicks, Not Code Customize Fields

Edit Dependent Picklists

1. From the management settings for the picklist’s object, go to Fields.
EDITIONS
2. Click Field Dependencies.
Available in: both Salesforce
3. Click Edit next to the field dependency relationship you want to change.
Classic and Lightning
4. Use the field dependency matrix to specify the dependent picklist values that are available Experience
when a user selects each controlling field value.
Available in: All Editions
5. Optionally, click Preview to test your selections.
6. Save your changes.
USER PERMISSIONS

SEE ALSO: To edit field dependencies:

• Customize Application
Find Object Management Settings

Delete Picklist Dependencies

If you no longer want the values of a dependent picklist to depend on a controlling field, delete its
EDITIONS
dependency. Deleting the dependency removes the logic that defines how the values of the picklist
depend on the controlling field, but doesn't delete the fields or affect their data. Available in: both Salesforce
1. From the management settings for the picklist’s object, go to Fields. Classic and Lightning
Experience
2. Click Field Dependencies.
3. Click Del next to the field dependency relationship you want to delete. Available in: All Editions

4. Click OK to confirm.
USER PERMISSIONS
SEE ALSO: To delete picklist
Find Object Management Settings dependencies:
• Customize Application

Dependent Picklist Considerations

When defining dependent picklists, review these considerations.
EDITIONS
Checkboxes
Checkbox fields can be controlling fields but not dependent fields. Available in: both Salesforce
Classic and Lightning
Converting fields
Experience
When you convert existing fields to dependent picklists or controlling fields, it doesn’t affect
the existing values in your records. After conversion, the dependency rules apply to new records Available in: All Editions
and to any changes to existing records.
Default values USER PERMISSIONS
You can prepopulate a record event with default values in dependent picklists.
To define and edit
Default values on dependent picklists are available on accounts, opportunities, contacts, leads,
dependent picklists:
and custom objects.
• Customize Application
If the Automated Account Field setting is enabled, you can’t prepopulate dependent picklists
with default values.

304
Extend Salesforce with Clicks, Not Code Customize Fields

Field-level security
Field-level security settings for a controlling field and dependent picklist are independent. Remember to hide a controlling field
whenever its correlating dependent picklist is hidden.
Import
The Data Import Wizard doesn’t consider field dependencies. You can import any value into a dependent picklist regardless of the
value imported for a controlling field.
Lead conversion
If you create a dependency for lead fields that map to account, contact, and opportunity fields for lead conversion, create the same
dependency on the account, contact, or opportunity.
You can map dependent picklists and controlling lead fields to account, contact, or opportunity fields with different dependency
rules.
Multi-select picklists
Multi-select picklists can be dependent picklists but not controlling fields.
Standard versus custom picklists
Custom picklist fields can be either controlling or dependent fields.
Standard picklist fields can be controlling fields but not dependent fields.
Picklist limitations
A controlling field can have up to 300 values. If a field is both a controlling field and dependent picklist, it can’t contain more than
300 values.
No checks are performed for dependent fields when a controlling field is updated.
These fields aren’t available as controlling fields.
Activity Fields
• Call Type
• Create recurring series of events
• Show Time As
• Subject
• Task
• Type
Contact Fields
• Salutation
• Contact Currency
Custom Object Fields
• Currency
Lead Fields
• Converted
• Unread By Owner
Dependency limitations
Before defining a dependency, make sure that your picklist has at least one value. Standard fields such as Product Family don’t contain
values until you add them.

305
Extend Salesforce with Clicks, Not Code Customize Fields

If a standard controlling field relies on functionality that you disable, then the dependency rules for the picklist no longer apply. For
example, if you disable the Self-Service portal, and Closed by Self-Service User is a controlling field, its dependent picklist shows all
available values.
If you replace a parent value in a controlling picklist, the picklist dependency is lost. After replacing the parent value, re-create the
dependency by using the new parent value.
Connect Offline
While controlling fields and dependent picklists are available in Connect Offline, the logic between them isn’t.
Page layouts
Page layouts that contain dependent picklists must also contain their controlling picklist fields, or the dependent picklist values don't
appear.
Make sure that the dependent picklist is lower on the page layout than its controlling field.
If a dependent picklist is required and no values are available for it based on the controlling field value, users can save the record
without entering a value. The record is saved with no value for that field.
Record types
You can define or change the record type for your dependent picklist only within the Preview dialog when creating or editing the
field dependency values. The record type controls what values are available in the controlling field. The record type and the controlling
field together determine what values are available in the dependent picklist. For example, a dependent value is only available if it’s
available in the selected record type and the selected controlling value.

Rich Text Editor

Use the rich text editor to format text in custom fields with the rich text area type. You can also use the rich text editor in many other
features, such as Chatter publisher and groups.

Available in: the Salesforce mobile app, Salesforce Classic, and Lightning Experience

Available in: All Editions

You can perform the following operations with the rich text editor’s WYSIWYG interface.
• Format text as bold, italicized, underlined, or strikethrough
• Create bullet and numbered lists
• Change paragraph indentation
• Insert a hyperlink
• Insert an image (copying inline images from external sources and pasting them into the editor isn’t supported)
• Remove formatting
The availability of toolbar buttons varies across features. For example, the code snippet button is available in Chatter publisher but not
in custom fields. Extra functions are supported for features such as Salesforce Knowledge and Ideas, like the ability to embed multimedia
content.

Note: Beginning in Summer ’17, custom fields provide a rich text editor that no longer uses CKEditor in Lightning Experience and
the Salesforce mobile app. Rich text editors provide a WYSIWYG interface only; you can’t edit HTML tags. When you copy content
from a web page or another source and paste it into the editor, unsupported tags are removed. Text that was enclosed in
unsupported tags is preserved as plain text. You aren’t notified when unsupported or potentially malicious HTML tags are removed.
You can expect minor formatting or styling differences when editing a rich text field across the interfaces. We recommend using
the toolbar to fix formatting or styling differences.

306
Extend Salesforce with Clicks, Not Code Customize Fields

Lightning Knowledge continues to use the CKEditor for custom rich text fields. Knowledge article rich text fields provide additional
functions, such as the ability to view and edit the source HTML, support for more HTML styles, and smart links between articles.

Some features have rich text editors across Salesforce Classic, Lightning Experience, and the Salesforce mobile app. For example, the
Information field in groups provides a rich text editor in all three user interfaces. The Chatter Publisher has a rich text editor only in
Salesforce Classic and Lightning Experience.

Salesforce Classic Lightning Experience The Salesforce Mobile App

Groups

Lightning Components
(ui:inputRichText and
lightning:inputRichText)

Custom Fields

Chatter Publisher

Knowledge Article

Lightning App Builder (Rich Text

Component)

Experience Builder (Rich Content

Editor)

Flow Builder

Idea Themes

Send Email Action

Sales Path

Notes

Rich Text Editor Considerations

When you use the editor, note the following.
• The maximum number of characters you can enter in the rich text editor is equal to the field length specified when creating or
editing the field. The default is 32,768 characters, which include characters used by HTML tags that apply formatting.
• Clicked hyperlinks open in a new browser window. The rich text editor supports HTTP, HTTPS, and mailto hyperlinks.
• The rich text editor doesn’t validate hyperlinks to web pages. Confirm that you’re specifying a valid URL.
• To insert an image, click and either select:
– Web Address and enter the URL of the image. This option isn’t available in Lightning Experience.
– Upload Image and select an image from your local host. You can upload only JPEG, PNG, or GIF files. The file can’t exceed 1 MB.
You can’t add a hyperlink to an image. Copying inline images from external sources to the text editor isn’t supported.
Optionally, enter a description that appears when you hover over the image. The image must have a URL that Salesforce can access.
• The rich text editor supports all languages that Salesforce Knowledge supports.
• The rich text editor doesn’t support JavaScript or Cascading Style Sheets (CSS).

307
Extend Salesforce with Clicks, Not Code Customize Fields

• The rich text editor is disabled for users who have accessibility mode enabled. It’s replaced with a text field.

Supported Formatting
We recommend that you use the toolbar to format your content. When you copy content from a web page or another source and paste
it into the editor, unsupported tags are removed. Text that was enclosed in unsupported tags is preserved as plain text. The rich text
editor supports the tags listed in the table.

<a> <dt> <q>

<abbr> <em> <samp>

<acronym> <font> <small>

<address> <h1> <span>

<b> <h2> <strike>

<bdo> <h3> <strong>

<big> <h4> <sub>

<blockquote> <h5> <sup>

<br> <h6> <table>

<caption> <hr> <tbody>

<cite> <i> <td>

<code> <img> <tfoot>

<col> <ins> <th>

<colgroup> <kbd> <thead>

<dd> <li> <tr>

<del> <ol> <tt>

<dfn> <p> <ul>

<div> <pre> <var>

<dl>

Note: Rich text editors in custom rich text area fields have minor formatting differences in Lightning Experience and the Salesforce
mobile app, as compared to Salesforce Classic. For more information, see Editing Rich Text Area Fields in Records.
The tags can include the following attributes.

alt face size

background height src

border href style

308
Extend Salesforce with Clicks, Not Code Customize Fields

class name target

colspan rowspan width

The following URL protocols are supported.

• http:
• https:
• file:
• ftp:
• mailto:
• #
• / for relative links

Rich Text Editors Using CKEditor

Rich text editors in Salesforce Classic continue to use CKEditor. Beginning in Winter ’23, Salesforce uses CKEditor version 4.18.0.
In Salesforce Classic, CKEditor is used by:
• Chatter Publisher
• Custom Fields
• Email
• Flow Builder
• Groups
• Idea Themes
• Knowledge Article
In Lightning Experience and the Salesforce mobile app, the following features have rich text editors that use CKEditor.
• Email Composer, using the Send Email action
• Lightning Knowledge
These features load the rich text editor in an iframe. To load the editor correctly in an iframe, your browser must use appropriate security
settings. Refer to your browser’s instructions to configure the settings. For example:
Internet Explorer
Make sure that the Launching programs and files in an IFRAME security setting is set to Enable or Prompt.
Safari
We recommend changing your Privacy settings for cookies to Allow from websites I visit.
Chrome
Make sure that Block third-party cookies isn’t selected in the Privacy and security settings.
To enter content in Internet Explorer 11 on touch-enabled devices running Windows, first click the rich text area field, then tab into the
editor.

Add Videos with the HTML Editor

To embed a video, use the HTML editor to paste the element from an approved video site.

309
Extend Salesforce with Clicks, Not Code Customize Fields

Adding Code Samples to Posts

You can paste code samples into your posts in Chatter Answers and Ideas.

SEE ALSO:
Editing Rich Text Area Fields in Records
Rich Text Fields in Knowledge Articles

Add Videos with the HTML Editor

To embed a video, use the HTML editor to paste the element from an approved video site.
USER PERMISSIONS
Available in: Salesforce Classic and Lightning Experience To create or change custom
fields:
Available in: Enterprise, Performance, Unlimited, and Developer Editions • Customize Application

Approved Video Sites

• app.ustudio.com
• cloudforce.com
• dailymotion.com
• database.com
• documentforce.com
• fast.wistia.net
• force.com
• ooyala.com
• play.vidyard.com
• player.youku.com
• players.brightcove.net
• salesforce.com
• salesforce-sites.com
• site.com
• ustream.tv
• visualforce.com
• videos.sproutvideo.com
• vimeo.com
• youtube.com (including youtube.co.uk, youtube.ca, youtube.com.br, youtube.es, youtube.fr, youtube.ie, youtube.jp, youtube.nl,
youtube-nocookie.com, and youtube.pl)
1. Copy the <iframe> element from one of the Approved Video Sites.
2. Paste your code into the HTML editor by clicking one of the buttons.

310
Extend Salesforce with Clicks, Not Code Customize Fields

Button Description
Lets you paste the <iframe> element into a text box on the
Embed Multimedia Content dialog box. The frame and its
contents are added to the editor window.

Lets you paste the <iframe> element directly into the HTML
code.

3. Click Save.

Note: If you run into problems embedding videos, check your browser security settings. Some browsers block iframe elements.
Also, embedded videos are removed from emails when you insert Knowledge articles into case emails.
Also, you can't send embedded videos via email.

SEE ALSO:
Rich Text Editor

Adding Code Samples to Posts

You can paste code samples into your posts in Chatter Answers and Ideas.
When you enable Chatter Answers and Ideas, users can add code samples to their posts. Code can be copied from any text editor and
pasted into the body of a post with the formatting preserved.
1. Copy the code sample from a text editor to your clipboard.
2.
In the editor, enter the text for your posts and click the button to add the code sample.
3. Paste the code sample into the Add a code sample text box and click OK.
The code sample appears in the body of the post with its formatting intact.

311
Extend Salesforce with Clicks, Not Code Customize Fields

Change the Custom Field Type

1. From the management settings for the field’s object, go to Fields.
EDITIONS
Note: For fields on Salesforce Knowledge article types, from Setup, enter Knowledge
Article Types in the Quick Find box, select Knowledge Article Types, and Available in: both Salesforce
then select an article type. Classic and Lightning
Experience
2. Click Edit next to the custom field you want to change.
Available in: All Editions
3. Click Change Field Type. Standard Objects are not
4. Select a new data type and click Next. available in Database.com
5. Enter a field label, name, and any other attributes, and then save your changes. Salesforce Connect external
objects are available in
Developer Edition and, for
Notes on Changing Custom Field Types
an extra cost, in Enterprise,
Performance, and Unlimited
SEE ALSO: Editions.
Custom Field Types
Which Standard Fields Can I Encrypt? USER PERMISSIONS
Which Custom Fields Can I Encrypt?
To change custom fields:
Find Object Management Settings • Customize Application

Notes on Changing Custom Field Types

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 these considerations before you convert fields from one type to another.
• Only convert custom fields that there’s no data for or you risk losing your data. Changing the data type of an existing custom field
can cause data loss in these situations.
– Changing to or from type Date or Date/Time
– Changing to Number from any other type
– Changing to Percent from any other type
– Changing to Currency from any other type
– Changing from Checkbox to any other type
– Changing from Picklist (Multi-Select) to any other type
– Changing to Picklist (Multi-Select) from any other type
Currently defined picklist values are retained when you change a picklist to a multi-select picklist. If records contain values that
aren’t in the picklist definition, those values are deleted from those records when the data type changes.

– Changing from Auto Number to any other type

– Changing to Auto Number from any type except Text
– Changing from Text to Picklist
– Changing from Text Area (Long) to any type except Email, Phone, Text, Text Area, or URL

• If data is lost, any list view based on the custom field is deleted, and assignment and escalation rules can be affected.

312
Extend Salesforce with Clicks, Not Code Customize Fields

• Changing a custom field type can require changing many records at once. If your request is queued to process these changes, you
receive an email notification when the process has completed.
• When you change a custom field data type, the conversion runs in the background. The conversion can take a while depending on
the size of the custom field, the number of records affected, and the type of field conversion. In some cases, the conversion can take
over 24 hours to complete. These field data type changes take the longest.
– Changing from Picklist to Text, Picklist (Multi-Select), or Checkbox
– Changing from Text to Picklist
– Change from Date/Time to Time
– Changing from Time to Text

• You can’t change the data type of any custom field that is mapped for lead conversion.
• If you change the data type of a custom field that’s set as an external ID, choosing a data type other than text, number, or email
causes the field to no longer act as an external ID.
• The option to change the data type of a custom field isn’t available for all data types. For example, an existing custom field can’t be
converted into an encrypted field nor can an encrypted field be converted into another data type.
• In Salesforce Knowledge article types, the file field type can’t be converted into other data types.
• You can’t change the data type of a custom field referenced by other items in Setup such as Visualforce pages, Apex code, processes,
or flows.
• Before changing a custom field’s type, make sure it isn’t the target of a workflow field update or referenced in a field update formula
that would be invalidated by the new type.
• If you encrypt a custom field using Shield Platform Encryption, you can’t change the field type.
These data types have other restrictions when you convert them.

Data Type Description

Auto Number If you convert an auto-number field into a text field, the data in
that field remains unchanged. Also, you can safely convert a text
custom field into an auto-number field without losing your data.
Converting an auto-number field into any other data type results
in data loss. Auto-number fields can contain a maximum of 30
characters. Before converting a text custom field into an
auto-number field, change any records that contain more than 30
characters in that field.

Formula Formula fields are special read-only fields that can’t be converted
to any other data type. Likewise, you can’t convert any other field
type into a formula field.

Picklist Changing your custom picklists into custom checkboxes is simple.

If you select Checkbox as the new data type, you can choose which
picklist values to map to checked boxes and unchecked boxes.
You can change custom picklists into multi-select picklists without
losing any data. Since your records contain only a single value of
that picklist, that value is still selected but users can select more
values.

Relationships • You can convert relationship fields to nonrelationship fields

and vice versa, but only on external objects.

313
Extend Salesforce with Clicks, Not Code Customize Fields

Data Type Description

• If your org has a large number of records, Salesforce displays
a waiting page after you request to change a master-detail
into a lookup relationship or a lookup into a master-detail
relationship.
• After you create a roll-up summary field on an object, you can’t
convert the object’s master-detail relationship into a lookup
relationship.
• If any records on an object have a null value set for the lookup
field, you can’t convert the lookup relationship to a master
detail relationship.
• If you convert a master-detail relationship to a lookup for a
custom object on the “detail” side, the org-wide default for the
object is automatically updated to Public Read/Write. Similarly,
converting a lookup to a master-detail-relationship changes
the org-wide default to Controlled by Parent.

Text By default, an upper bound limit of 4,000 is applied to inactive

unrestricted picklists for each field. If you exceed this limit when
converting a text field to a picklist field, you receive an error
message. You can’t convert a defined unique text field to a picklist
or a multi-select picklist.
If you deploy an object definition in package.xml and convert a
field in that object from a text field to a picklist field, the label of
each picklist value is the value’s fullName.

Text Area (Long) When you convert a long text area field to an Email, Phone, Text,
Text Area, or URL type field, the record data is truncated to the first
255 characters of the field.

Text Area (Rich) You can convert rich text area fields into long text area fields only.
Any images get deleted the next time you save the long text area
field. After converting, markup is hidden in the long text area field,
but it isn’t removed from the record, so if you change your mind,
you can restore the markup before you save the record.

SEE ALSO:
Change the Custom Field Type
Custom Metadata Type Fields

314
Extend Salesforce with Clicks, Not Code Customize Fields

Define Default Field Values

Define a default value for a field. Use a formula to generate dynamic values or constants for static
EDITIONS
values.
1. Create a custom field. See Create Custom Fields. You can also define a default value for an Available in: both Salesforce
existing custom field. See Edit Custom Fields. Classic and Lightning
Experience
2. Choose the type of field and click Next. For a list of the types available for default values, see
Default Field Values. Available in: Contact
3. Enter the attributes for the field. Manager, Group,
Professional, Enterprise,
4. Enter a default value or define a formula to calculate the default value. Performance, Unlimited,
and Developer Editions
Note: You can define a formula for default values only where appropriate. For example,
the default value options for a checkbox field are limited to the options available for those
types of fields, such as Checked or Unchecked. USER PERMISSIONS
For picklists, a valid formula result is either a constant or the API name of an entry in the
To view default field values:
Values list. The formula result has higher precedence than the default assigned in the
• View Setup and
Values list. If the formula doesn’t generate a valid result, the default assigned in the Values Configuration
list is entered in the field. If a default isn’t assigned to the Values list, no value is entered
To define or change default
in the picklist field.
field values:
• Customize Application
5. Click Next.
6. Set the field-level security to determine whether the field is visible for specific profiles, and click
Next.
7. Choose the page layouts that display the field. The field is added as the last field in the first two-column section on the page layout.
For user custom fields, the field is added to the bottom of the user detail page.
8. Click Save to finish or Save & New to create more custom fields.
You must specify a default value for required campaign member custom fields.
To avoid uniqueness errors, don’t assign default values to fields that are both required and unique.

Default Field Values

Prepopulate field values with defaults to save your users time and improve consistency. Default field values make your users more
productive by reducing the number of fields they must fill in manually.
Useful Default Field Value Formulas
Default Field Value Considerations
Be aware of the behavior and rules when you assign default values to custom fields.

315
Extend Salesforce with Clicks, Not Code Customize Fields

Default Field Values

Prepopulate field values with defaults to save your users time and improve consistency. Default
EDITIONS
field values make your users more productive by reducing the number of fields they must fill in
manually. Available in: both Salesforce
Default field values automatically insert the value of a custom field when a new record is created. Classic () not available in all
You can use a default value on a formula for some types of fields or exact values, such as Checked orgs and Lightning
or Unchecked for checkbox fields. Experience

After you have defined default values: Available in: Contact

Manager, Group,
1. The user chooses to create a record.
Professional, Enterprise,
2. The default field value is executed. Performance, Unlimited,
3. Salesforce displays the edit page with the default field value prepopulated. and Developer Editions

4. The user enters the fields for the new record.

5. The user saves the new record.
The user can change the field’s value but the initial default field value is only executed one time, during record creation. For example,
you can set the default field value on a custom lead field to seven days after the creation date to signify when to contact the lead again.
You can change this value later, but you can't automatically restore the value that was seven days after the creation date.
Set up default field values for the following types of custom fields:
• Checkbox
• Currency
• Date
• Date/Time
• Email
• Number
• Percent
• Phone
• Picklist
• Text
• Text Area
• Time
• URL
For a description of these types, see Custom Field Types on page 244.

SEE ALSO:
Define Default Field Values
Default Field Value Considerations
Useful Default Field Value Formulas
Reference Custom Metadata Type Records in Default Values

316
Extend Salesforce with Clicks, Not Code Customize Fields

Useful Default Field Value Formulas

EDITIONS
Maximum Discount Rate
Your organization may apply different discount rates to opportunities based on the department of Available in: both Salesforce
the person creating the opportunity. Use the following example to set a default value for a custom Classic () not available in all
field called Discount Rate on opportunities. orgsand Lightning
Experience

Available in: Contact

Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To view default field values:

• View Setup and
Configuration
To define or change default
field values:
• Customize Application

CASE(User.Department, "IT", 0.25, "Field", 0.15, 0)

In this example, the formula inserts a discount rate of 25% on any opportunity created by a user in the IT department or 15% on any
opportunity created by someone in the Field department. A zero is applied if the creator doesn't belong to either of these departments.
This is a custom percent field on opportunities that uses the standard user field Department.

Product Language
You might want to associate a product with its language so that your users know the type of documentation or adapter to include. Use
the following default value formula to automatically set the language of a product based on the country of the user creating the product.
In this example, the default value is Japanese if the user's country is Japan and English if the user's country is US. If neither is true, the
default value unknown is inserted into the Product Language field.
CASE($User.Country , "Japan", "Japanese", "US", "English","unknown")

Tax Rate
Use this default value formula to set the tax rate of an asset based on the user's city. Create a custom percent field with the following
default value:
IF($User.City = "Napa", 0.0750,
IF($User.City = "Paso Robles", 0.0725,
IF($User.City = "Sutter Creek", 0.0725,
IF($User.City = "Los Olivos", 0.0750,
IF($User.City = "Livermore", 0.0875, null
)
)

317
Extend Salesforce with Clicks, Not Code Customize Fields

)
)
)

In this example, a tax rate of 8.75% is applied to an asset when the user's address is in the city of Livermore. When none of the cities
listed applies, the Tax Rate field is empty. You can also use the Tax Rate field in formulas to automatically calculate taxable
amounts and final sales prices.

Default Field Value Considerations

Be aware of the behavior and rules when you assign default values to custom fields.
EDITIONS
Default field values automatically insert the value of a custom field when a new record is created.
You can use a default value on a formula for some types of fields or exact values, such as Checked Available in: both Salesforce
or Unchecked for checkbox fields. Review the following considerations before incorporating default Classic () not available in all
field values in your organization. orgsand Lightning
Experience
• If a default value is based on the value of a merge field, Salesforce uses the value of the merge
field at the time the default value is executed. If the value of the merge field changes later, the Available in: Contact
default value is not updated. Manager, Group,
• Users can change or remove the default field value on a record. Professional, Enterprise,
Performance, Unlimited,
• Don’t assign default values to fields that are both required and unique, because uniqueness and Developer Editions
errors can result.
• If you make an activity custom field universally required, you must also provide a default value.
• If an activity custom field is unique, you cannot provide a default value.
• Default field values are different from formula fields in the following ways: they are only executed once, at record creation; they are
not read only; and the user can change the value but cannot restore the default field value.
• Since the default value is inserted before users enter any values in the new record, you cannot use the fields on the current record
to create a default field value. For example, you cannot create a default field value on a contact that uses the first initial and last name
because those values are not available when you click New to create a contact record. However, you can use the record type because
it is selected before the record edit page displays.
• Record type default field values have precedence over an object’s default field values.
• To apply a different default value for different record types, use the record type as a merge field in a CASE function within the default
field value setup.
• Fields that are not visible to the user due to field-level security are still available in the formula for a default field value.
• Connect Offline and Salesforce for Outlook do not display default values. However, Salesforce inserts the default values when a user
syncs unless the user entered a value.
• Default field values are not available in the Self-Service portal.
• Lead conversion, Web-to-Lead, and Web-to-Case do not execute default field values.
• Visualforce pages don’t support default field values.

Note: You can define a formula for default values only where appropriate. For example, the default value options for a checkbox
field are limited to the options available for those types of fields, such as Checked or Unchecked.
For picklists, a valid formula result is either a constant or the API name of an entry in the Values list. The formula result has higher
precedence than the default assigned in the Values list. If the formula doesn’t generate a valid result, the default assigned in the
Values list is entered in the field. If a default isn’t assigned to the Values list, no value is entered in the picklist field.

318
Extend Salesforce with Clicks, Not Code Customize Fields

Validation Rules
Improve the quality of your data using validation rules. Validation rules verify that the data a user
EDITIONS
enters in a record meets the standards you specify before the user can save the record. A validation
rule can contain a formula or expression that evaluates the data in one or more fields and returns Available in: both Salesforce
a value of “True” or “False”. Validation rules also include an error message to display to the user Classic and Lightning
when the rule returns a value of “True” due to an invalid value. Experience
Important: We don’t recommend using a custom number field that Einstein Prediction Available in: Essentials,
Builder manages in a validation rule. If the prediction changes the field value in a way that Contact Manager, Group,
violates the validation rule, you can’t update the record that uses the field. If you get a Professional, Enterprise,
validation rule error when saving a record that contains an Einstein Prediction Builder field, Performance, Unlimited,
edit, deactivate, or delete the validation rule. Developer, and
Database.com Editions
After you have defined validation rules:
1. The user chooses to create a record or edit an existing record.
2. The user clicks Save.
3. All validation rules are verified.
• If all data is valid, the record is saved.
• If any data is invalid, the associated error message displays without saving the record.

4. The user makes the necessary changes and clicks Save again.
You can specify the error message to display when a record fails validation and where to display it. For example, your error message can
be “The close date must occur after today's date.” You can choose to display it near a field or at the top of the page. Like all other error
messages, validation rule errors display in red text and begin with the word “Error”.

Note: In Salesforce Classic, users with custom profiles must have Read permission on a standard object to view validation rules
for that object.

Important: Validation rules apply to new and updated records for an object, even if the fields referenced in the validation rule
aren’t included in a page layout or an API call. Validation rules don't apply if you create records for an object with Quick Create. If
your organization has multiple page layouts for the object on which you create a validation rule, verify that the validation rule
works on each layout. If your organization has any integrations that use this object, verify that the validation rule works for each
integration.

Managing Validation Rules

Define Validation Rules
Validation rules verify that the data a user enters in a record meets the standards you specify before the user can save the record. A
validation rule can contain 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 to display to the user when the rule returns a value of “True” due to an invalid
value.
Clone Validation Rules
Activate Validation Rules
Validation Rules Fields
Tips for Writing Validation Rules

319
Extend Salesforce with Clicks, Not Code Customize Fields

Validation Rule Considerations

Validation rules verify that the data a user enters in a record meets the standards you specify before the user can save the record. A
validation rule can contain 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 to display to the user when the rule returns a value of “True” due to an invalid
value. Review these considerations before implementing validation rules in your organization.

SEE ALSO:
Examples of Validation Rules
Custom Metadata Type Fields and Validation Rules
Custom Metadata Types and Validation Rule Formulas
Set an AI Prediction Field
Einstein Prediction Builder Editions and Permissions
Edit Object Permissions in Profiles

Managing Validation Rules

Validation rules verify that the data a user enters in a record meets the standards you specify before
EDITIONS
the user can save the record. A validation rule can contain 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 Available in: both Salesforce
an error message to display to the user when the rule returns a value of “True” due to an invalid Classic and Lightning
value. Experience
From the validation rules page you can:
Available in: Essentials,
• Define a validation rule. Contact Manager, Group,
• Click Edit next to a rule name to update the rule fields. Professional, Enterprise,
Performance, Unlimited,
• Delete a validation rule. Developer, and
• Click a validation rule name to view more details or to clone the rule. Database.com Editions
• Activate a validation rule.

SEE ALSO:
Examples of Validation Rules

320
Extend Salesforce with Clicks, Not Code Customize Fields

Define Validation Rules

Validation rules verify that the data a user enters in a record meets the standards you specify before
EDITIONS
the user can save the record. A validation rule can contain 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 Available in: both Salesforce
an error message to display to the user when the rule returns a value of “True” due to an invalid Classic and Lightning
value. Experience
Before creating validation rules, review the Validation Rule Considerations.
Available in: Essentials,
1. From the management settings for the relevant object, go to Validation Rules. Contact Manager, Group,
Professional, Enterprise,
2. In the Validation Rules related list, click New.
Performance, Unlimited,
Note: The detail page of a custom activity field does not list associated validation rules. Developer, and
To edit the validation rule for a custom activity field, select the validation rule from Setup Database.com Editions
by entering Activities in the Quick Find box, then selecting Activities and
choose Task Validation Rules or Event Validation Rules. USER PERMISSIONS
3. Enter the properties of your validation rule. To view field validation rules:
4. To check your formula for errors, click Check Syntax. • View Setup and
Configuration

SEE ALSO: To define or change field

validation rules:
Validation Rules • Customize Application
Clone Validation Rules
Tips for Writing Validation Rules
Examples of Validation Rules

Clone Validation Rules

1. From the management settings for the relevant object, go to Validation Rules.
EDITIONS
2. In the Validation Rules related list, click the name of the validation rule.
Available in: both Salesforce
3. Click Clone.
Classic and Lightning
4. Define the new rule based on the original rule. Experience
5. Click Save to finish or Save & New to create additional validation rules. Available in: Essentials,
Note: The detail page of a custom activity field does not list associated validation rules. To Contact Manager, Group,
edit the validation rule for a custom activity field, select the validation rule from Setup by Professional, Enterprise,
Performance, Unlimited,
entering Activities in the Quick Find box, then selecting Activities and choose
Developer, and
Task Validation Rules or Event Validation Rules.
Database.com Editions

SEE ALSO:
USER PERMISSIONS
Define Validation Rules
Validation Rules Fields To view field validation rules:
• View Setup and
Activate Validation Rules
Configuration
To define or change field
validation rules:
• Customize Application

321
Extend Salesforce with Clicks, Not Code Customize Fields

Activate Validation Rules

1. From the management settings for the relevant object, go to Validation Rules.
EDITIONS
2. Click Edit next to the rule you want to activate.
Available in: both Salesforce
3. To activate the rule, select Active, and save your changes.
Classic and Lightning
4. To deactivate the rule, deselect Active, and save your changes. Experience
Note: The detail page of a custom activity field does not list associated validation rules. Available in: Essentials,
Contact Manager, Group,
Professional, Enterprise,
SEE ALSO: Performance, Unlimited,
Define Validation Rules Developer, and
Validation Rules Fields Database.com Editions

Find Object Management Settings

USER PERMISSIONS

To view field validation rules:

• View Setup and
Configuration
To define or change field
validation rules:
• Customize Application

Validation Rules Fields

Field Description EDITIONS

Rule Name Unique identifier of up to 40 characters with no spaces or special Available in: both Salesforce
characters such as extended characters. Classic and Lightning
Experience
Active Checkbox that indicates if the rule is enabled.
Available in: Essentials,
Description A 255-character or less description that distinguishes the validation Contact Manager, Group,
rule from others. For internal purposes only. Professional, Enterprise,
Error Condition The expression used to validate the field. See Build a Formula Field Performance, Unlimited,
Developer, and
Formula and Formula Operators and Functions.
Database.com Editions
Error Message The message that displays to the user when a field fails the
validation rule.
If your organization uses the Translation Workbench, you can
translate the error message into the languages Salesforce supports.
See Enable or Disable Translation Workbench.

Error Location Determines where on the page to display the error. To display the
error next to a field, choose Field and select the field. If the
error location is a field, the validation rule is also listed on the detail
page of that field. If the error location is set to a field that is later
deleted, to a field that is read only, or to a field that isn’t visible on

322
Extend Salesforce with Clicks, Not Code Customize Fields

Field Description
the page layout, Salesforce automatically changes the location to Top of Page.

Note: Error messages can only be displayed at the top of the page in validation
rules for case milestones and Ideas.

SEE ALSO:
Define Validation Rules

Tips for Writing Validation Rules

• Consider all the settings that can make a record fail validation, including assignment rules, field
EDITIONS
updates, field-level security, or hidden fields.
• Make sure to test a validation rule before activating it because if rules for the same field conflict, Available in: both Salesforce
users can’t save the record. Use the debug log to monitor the details of your rule implementation. Classic and Lightning
Experience
Tip: A poorly designed validation rule can prevent users from saving valid data. Make
sure you thoroughly test a validation rule before activating it. You can also use the debug Available in: Essentials,
log to monitor the details of your rule implementation. Contact Manager, Group,
Professional, Enterprise,
• When referencing related fields in a validation formula, make sure those objects are deployed. Performance, Unlimited,
• Use the RecordType.Id merge field in your formula to apply different validations for Developer, and
different record types. Database.com Editions
• Boolean error condition expression works. For example:
– Correct: CloseDate < TODAY()
– Incorrect: IF(CloseDate < TODAY(), TRUE, FALSE)

• If a validation rule contains the BEGINS or CONTAINS function, it processes blank fields as valid. For example, a validation rule that
tests whether the serial number of an asset begins with 3, all assets with a blank serial number are considered valid.
• When using a validation rule to ensure that a number field contains a specific value, use the ISBLANK function to include fields that
don’t contain any value. For example, to validate that a custom field contains a value of 1, use this validation rule to display an error
if the field is blank or shows any other number.
OR (ISBLANK (field__c), field__c<>1)

• Avoid using the IsClosed or IsWon opportunity merge fields in validation formulas. Instead, use the ISPICKVAL function to
determine if the Stage contains the appropriate value. For example,this validation formula makes a custom Project Start
Date field required whenever the Stage is Closed Won.

AND(ISPICKVAL(StageName, "Closed Won"),

ISBLANK(Project_Start_Date__c))

• Simplify your validation formulas by using checkbox fields, which don't require an operator because they return true or false. For
example, this validation formula checks to be sure an opportunity has opportunity products using the
HasOpportunityLineItem merge field before users can save a change to it.

NOT(OR(ISNEW(),HasOpportunityLineItem))

323
Extend Salesforce with Clicks, Not Code Customize Fields

• When creating or updating a validation rule, click Insert Field to check if a field is available for an entity. If the field doesn’t exist for
an entity, an error appears.

Tips for Writing Validation Rule Error Messages

• Give instructions that tell the user the type of entry that’s valid, such as Close Date must be after today.
• Include the field label to identify the field that failed validation, especially if the error message appears at the top of the page.
• When defining validation rules, you can set the error location to Top of Page or Field. If the error location is set to a field
that’s deleted later, read only, or to a field that isn’t visible on the page layout, Salesforce automatically changes the location to Top
of Page.
• To translate error messages, use the Translation Workbench.
• Assign corresponding numbers to validation rules and their error messages to identify the source of the error.

SEE ALSO:
Define Validation Rules
Validation Rule Considerations

Validation Rule Considerations

Validation rules verify that the data a user enters in a record meets the standards you specify before
EDITIONS
the user can save the record. A validation rule can contain 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 Available in: both Salesforce
an error message to display to the user when the rule returns a value of “True” due to an invalid Classic (not available in all
value. Review these considerations before implementing validation rules in your organization. orgs) and Lightning
Experience
How Salesforce Processes Validation Rules Available in: Essentials,
Salesforce processes rules in the following order: Contact Manager, Group,
Professional, Enterprise,
1. Validation rules Performance, Unlimited,
2. Assignment rules Developer, and
Database.com Editions

324
Extend Salesforce with Clicks, Not Code Customize Fields

3. Auto-response rules
4. Workflow rules (with immediate actions)
5. Escalation rules
In addition,
• When one validation rule fails, Salesforce continues to check other validation rules on that field or other fields on the page and
displays all error messages at once.
• If validation rules exist for activities and you create an activity during lead conversion, the lead converts but a task isn’t created.
• Validation rules are only enforced during lead conversion if validation and triggers for lead conversion are enabled in your organization.
• Campaign hierarchies ignore validation rules.
• Salesforce runs validation rules before it creates records submitted via Web-to-Lead and Web-to-Case and then creates records that
have valid values.
• To give a default value to a division field before the validation rule evaluation, the division field must be on the page layout.
• Validation rules continue to run on individual records if the owner is changed. If the Mass Transfer tool is used to change the ownership
of multiple records, however, validation rules don’t run on those records.

Validation Rule Field Restrictions

Validation rule formulas don’t or can’t refer to:
• Compound fields, including addresses, first and last names, and dependent picklists and lookups

Note: However, you can use compound fields in ISNULL, ISBLANK, and ISCHANGED functions.

• Campaign statistic fields, including statistics for individual campaigns and campaign hierarchies
• Merge fields for auto-number or compound address fields, such as Mailing Address

Note: You can use merge fields for individual address fields, such as Billing City, in validation rule formulas.

In relation to other fields and functions in Salesforce, validation rules behave as follows:
• The detail page of a custom activity field doesn't list associated validation rules.
• Workflow rules and some processes can invalidate previously valid fields. Invalidation occurs because updates to records based on
workflow rules and also on process scheduled actions don’t trigger validation rules.
• Process record updates on immediate actions do fire validation rules.
• You can’t create validation rules for relationship group members.
• You can use roll-up summary fields in validation rules because the fields don’t display on edit pages. Don’t use roll-up summary
fields as the error location.

Lookup Filters vs. Validation Rules

Validation rules and lookup filters achieve similar ends, but offer different advantages. Use a lookup filter:
• To improve user efficiency by limiting the number of available options in a lookup search dialog.
• To improve user efficiency by automating filters on lookup search dialogs that your users manually set.
Use a validation rule:
• If you're close to the maximum number of lookup filters allowed.

325
Extend Salesforce with Clicks, Not Code Customize Fields

• To implement a complex business rule that requires you to use a formula. Formulas can reference fields that basic filter criteria can't
reference, such as fields on the parent of the source object. Formulas can also use functions. For example, use ISNEW to apply the
rule only on record creation, or ISCHANGED to apply the rule only when a field changes.

SEE ALSO:
Define Validation Rules
Activate Validation Rules
Examples of Validation Rules

Examples of Validation Rules

Review examples of validation rules for various types of apps that you can use and modify for your
EDITIONS
own purposes. Validation rules verify that the data a user enters in a record meets the standards
you specify before the user can save the record. Available in: both Salesforce
Use the following samples for validation rules in Salesforce and Salesforce AppExchange apps, Classic and Lightning
including: Experience

Available in: Contact

Sample Account Address Validation Rules Manager, Group,
Professional, Enterprise,
Sample Account Validation Rules
Performance, Unlimited,
Sample Call Center Validation Rules Developer, and
Sample Experience Cloud Site Validation Rules Database.com Editions

Sample Contact Validation Rules

USER PERMISSIONS
Sample Cross Object Validation Rules
Sample Date Validation Rules To view field validation rules:
• View Setup and
Sample Number Validation Rules
Configuration
Sample Opportunity Management Validation Rules To define or change field
Sample Quote Validation Rules validation rules:
• Customize Application
Sample User, Role, and Profile Validation Rules
Miscellaneous Sample Validation Rules

SEE ALSO:
Validation Rules
Define Validation Rules

326
Extend Salesforce with Clicks, Not Code Customize Fields

Sample Account Address Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context on page 388.
Available in: both Salesforce
Canadian Billing Postal Code Classic and Lightning
Experience
Field Value Available in: Contact
Description: Validates that the account Billing Zip/Postal Code is in Manager, Group,
Professional, Enterprise,
the correct format if Billing Country is Canada.
Performance, Unlimited,
Formula: Developer, and
AND(
Database.com Editions
OR(BillingCountry = "CAN", BillingCountry =
"CA", BillingCountry = "Canada"),
NOT(REGEX(BillingPostalCode,
"((?i)[ABCEGHJKLMNPRSTVXY]\\d[A-Z]?\\s?\\d[A-Z]\\d)?"))
)

Error Message: Canadian postal code must be in A9A 9A9 format.

Error Location: Billing Zip/Postal Code

Billing Zip Code Is in Billing State

Field Value
Description: Validates that the account Billing Zip/Postal Code is valid by looking up the first
five characters of the value in a custom object called Zip_Code__c that contains a record for
every valid zip code in the US. If the zip code is not found in the Zip_Code__c object, or the
Billing State does not match the corresponding State_Code__c in the Zip_Code__c
object, an error is displayed.

Formula:
VLOOKUP(
$ObjectType.Zip_Code__c.Fields.City__c ,
$ObjectType.Zip_Code__c.Fields.Name ,
LEFT(BillingPostalCode,5)) <> BillingCity

Error Message: Billing Zip Code does not exist in specified Billing State.

Error Location: Billing Zip/Postal Code

327
Extend Salesforce with Clicks, Not Code Customize Fields

US Billing Zip Code

Field Value
Description: Validates that the account Billing Zip/Postal Code is in 99999 or 99999-9999
format if Billing Country is USA or US.

Formula:
AND(
OR(BillingCountry = "USA", BillingCountry = "US"),
NOT(REGEX(BillingPostalCode, "\\d{5}(-\\d{4})?"))
)

Note: This example uses the REGEX function; see Shipping Zip Code if you are not
familiar with regular expressions.

Error Message: Zip code must be in 99999 or 99999-9999 format.

Error Location: Billing Zip/Postal Code

328
Extend Salesforce with Clicks, Not Code Customize Fields

Shipping Zip Code

Field Value
Description: Validates that the account Shipping Zip/Postal Code is in 99999 or 99999-9999 format if
Shipping Country is USA or blank.

Formula:
AND(
OR(ShippingCountry = "USA", ISBLANK(ShippingCountry)),
OR(
AND(LEN(ShippingPostalCode) <>5,
LEN(ShippingPostalCode) <> 10),
NOT(CONTAINS("0123456789",
LEFT( ShippingPostalCode, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 2, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 3, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 4, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 5, 1))),
AND(
LEN(ShippingPostalCode) = 10,
OR(
MID( ShippingPostalCode , 6, 1) <> "-",
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 7, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 8, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 9, 1))),
NOT(CONTAINS("0123456789",
MID( ShippingPostalCode , 10, 1)))
)
)
)
)

Note: This example interprets a blank country as US. To use this example with other countries,
remove the clause that checks the length of the country field. Also, validation rule criteria are
case sensitive, so this rule is only enforced when the country is blank or “USA” in all capital letters.
The rule is not enforced when the country is “usa.”

Tip: You can also validate zip codes using a regular expression; for an example of a formula
using a regular expression, see REGEX.

Error Message: Zip code must be in 99999 or 99999-9999 format.

Error Location: Shipping Zip/Postal Code

329
Extend Salesforce with Clicks, Not Code Customize Fields

Valid Billing State (US)

Field Value
Description: Validates that the account Billing State/Province is a valid two-character
abbreviation if Billing Country is US, USA, or blank.

Formula:
AND (
OR(BillingCountry = "US", BillingCountry="USA",
ISBLANK(BillingCountry)),
OR(
LEN(BillingState) < 2,
NOT(
CONTAINS("AL:AK:AZ:AR:CA:CO:CT:DE:DC:FL:GA:HI:ID:" &
"IL:IN:IA:KS:KY:LA:ME:MD:MA:MI:MN:MS:MO:MT:NE:NV:NH:" &
"NJ:NM:NY:NC:ND:OH:OK:OR:PA:RI:SC:SD:TN:TX:UT:VT:VA:" &
"WA:WV:WI:WY", BillingState)
)))

Note: This example interprets a blank country as US. To use this example with other
countries, remove the clause that checks the length of the country field. Also, validation
rule criteria are case sensitive, so this rule is only enforced when the country is blank
or “USA” in all capital letters. The rule is not enforced when the country is “usa.”

Error Message: A valid two-letter state code is required.

Error Location: Billing State/Province

Valid Billing Province (Canada)

Field Value
Description: Validates that the account Billing State/Province is a valid two-character abbreviation if Billing
Country is CA or CAN.

Formula:
AND (
OR(BillingCountry = "CA", BillingCountry="CAN"),
OR(
LEN(BillingState) < 2,
NOT(
CONTAINS("AB:BC:MB:NB:NL:NT:NS:NU:ON:PC:QC:SK:YT", BillingState)
)))

Error Message: A valid two-letter province code is required.

Error Location: Billing State/Province

330
Extend Salesforce with Clicks, Not Code Customize Fields

Valid Shipping State

Field Value
Description: Validates that the account Shipping State/Province is a valid two-character abbreviation if
Shipping Country is US, USA, or blank.

Formula:
AND (
OR(ShippingCountry = "US", ShippingCountry="USA",
ISBLANK(ShippingCountry)),
OR(
LEN(ShippingState) < 2,
NOT(
CONTAINS("AL:AK:AZ:AR:CA:CO:CT:DE:DC:FL:GA:HI:ID:" &
"IL:IN:IA:KS:KY:LA:ME:MD:MA:MI:MN:MS:MO:MT:NE:NV:NH:" &
"NJ:NM:NY:NC:ND:OH:OK:OR:PA:RI:SC:SD:TN:TX:UT:VT:VA:" &
"WA:WV:WI:WY", ShippingState)
)))

Note: This example interprets a blank country as US. To use this example with other countries, remove
the clause that checks the length of the country field. Also, validation rule criteria are case sensitive,
so this rule is only enforced when the country is blank or “USA” in all capital letters. The rule is not
enforced when the country is “usa.”

Error Message: A valid two-letter state abbreviation is required.

Error Location: Shipping State/Province

Valid Shipping Province (Canada)

Field Value
Description: Validates that the account Shipping State/Province is a valid two-character abbreviation, if
Billing Country is CA or CAN.

Formula:
AND (
OR(ShippingCountry = "CA", ShippingCountry="CAN"),
OR(
LEN(ShippingState) < 2,
NOT(
CONTAINS("AB:BC:MB:NB:NL:NT:NS:NU:ON:PC:QC:SK:YT", ShippingState)
)))

Error Message: A valid two-letter province abbreviation is required.

Error Location: Shipping State/Province

331
Extend Salesforce with Clicks, Not Code Customize Fields

Valid Billing Country

Field Value
Description: Validates that the account Billing Country is a valid ISO 3166 two-letter code.

Formula:
OR(
LEN(BillingCountry) = 1,
NOT(
CONTAINS(
"AF:AX:AL:DZ:AS:AD:AO:AI:AQ:AG:AR:AM:" &
"AW:AU:AZ:BS:BH:BD:BB:BY:BE:BZ:BJ:BM:BT:BO:" &
"BA:BW:BV:BR:IO:BN:BG:BF:BI:KH:CM:CA:CV:KY:" &
"CF:TD:CL:CN:CX:CC:CO:KM:CG:CD:CK:CR:CI:HR:" &
"CU:CY:CZ:DK:DJ:DM:DO:EC:EG:SV:GQ:ER:EE:ET:FK:" &
"FO:FJ:FI:FR:GF:PF:TF:GA:GM:GE:DE:GH:GI:GR:GL:" &
"GD:GP:GU:GT:GG:GN:GW:GY:HT:HM:VA:HN:HK:HU:" &
"IS:IN:ID:IR:IQ:IE:IM:IL:IT:JM:JP:JE:JO:KZ:KE:KI:" &
"KP:KR:KW:KG:LA:LV:LB:LS:LR:LY:LI:LT:LU:MO:MK:" &
"MG:MW:MY:MV:ML:MT:MH:MQ:MR:MU:YT:MX:FM:MD:MC:" &
"MC:MN:ME:MS:MA:MZ:MM:MA:NR:NP:NL:AN:NC:NZ:NI:" &
"NE:NG:NU:NF:MP:NO:OM:PK:PW:PS:PA:PG:PY:PE:PH:" &
"PN:PL:PT:PR:QA:RE:RO:RU:RW:SH:KN:LC:PM:VC:WS:" &
"SM:ST:SA:SN:RS:SC:SL:SG:SK:SI:SB:SO:ZA:GS:ES:" &
"LK:SD:SR:SJ:SZ:SE:CH:SY:TW:TJ:TZ:TH:TL:TG:TK:" &
"TO:TT:TN:TR:TM:TC:TV:UG:UA:AE:GB:US:UM:UY:UZ:" &
"VU:VE:VN:VG:VI:WF:EH:YE:ZM:ZW",
BillingCountry)))

Error Message: A valid two-letter country code is required.

Error Location: Billing Country

Sample Account Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context on page 388.
Available in: both Salesforce
Account Number Is Numeric Classic and Lightning
Experience
Field Value Available in: Contact
Description: Validates that the Account Number is numeric if not blank. Manager, Group,
Professional, Enterprise,
Formula: Performance, Unlimited,
OR(
Developer, and
ISBLANK(AccountNumber),
Database.com Editions
NOT(ISNUMBER(AccountNumber))
)

Error Message: Account Number is not numeric.

Error Location: Account Number

332
Extend Salesforce with Clicks, Not Code Customize Fields

Account Number Length

Field Value
Description: Validates that the Account Number is exactly seven digits (if it is not blank). The number
seven is simply illustrative. You can change this to any number you like.

Formula:
AND(
ISBLANK(AccountNumber),
LEN(AccountNumber) <> 7
)

Error Message: Account Number must be seven digits.

Error Location: Account Number

Annual Revenue Range

Field Value
Description: Validates that the account Annual Revenue is not negative and does not exceed $100
billion. This limit is designed to catch typos.

Formula:
OR(
AnnualRevenue < 0,
AnnualRevenue > 100000000000
)

Error Message: Annual Revenue cannot exceed 100 billion.

Error Location: Annual Revenue

Sample Call Center Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions on page 388.
Available in: both Salesforce
Classic and Lightning
Experience

Available in: Essentials,

Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
Developer, and
Database.com Editions

333
Extend Salesforce with Clicks, Not Code Customize Fields

Conditionally Require Description When Case Reason is “Other”

Field Value
Description: Validates that a custom field called Other Reason contains a value if a case has a Case
Reason of “Other.”

Formula:
AND(
ISPICKVAL( Reason, "Other" ),
ISBLANK(Other_Reason__c)
)

Error Message: Description of Other Reason is required.

Error Location: Other Reason

Prevent Open Cases from Being Reset to New

Field Value
Description: If a case is already open, prevents the Status from being changed back to “New.”

Formula:
AND(
ISCHANGED( Status ),
NOT(ISPICKVAL(PRIORVALUE( Status ), "New")),
ISPICKVAL( Status, "New")
)

Error Message: Open case Status cannot be reset to New.

Error Location: Status

Restrict Status of Re-Opened Cases

Field Value
Description: Validates that the case Status is “Re-opened” when a closed case is opened again.

Formula:
AND(
ISCHANGED( Status ),
OR(
ISPICKVAL(PRIORVALUE( Status ), "Closed"),
ISPICKVAL(PRIORVALUE( Status ),
"Closed in SSP")),
NOT( ISPICKVAL( Status, "Re-Opened"))
)

Error Message: Closed case can only be changed to “Re-opened.”

Error Location: Status

334
Extend Salesforce with Clicks, Not Code Customize Fields

Prevent Case Milestone Completion After Cases Are Closed

Field Value
Description: Validates that a milestone's Completion Date can't occur after the case's Status is
Closed.

Formula:
Case.IsClosed = true

Error Message: You can't complete a milestone after a case is closed.

Error Location: Top of Page

Prevent Case Milestone Completion Before Case Creation Dates

Field Value
Description: Validates that the milestone's Completion Date has occurred after the case's
Date/Time Opened.

Formula:
CompletionDate >= Case.CreatedDate && CompletionDate <=
Case.ClosedDate

Error Message: The milestone Completion Date must occur after the date the case was created and before the
case was closed.

Error Location: Top of Page

Sample Experience Cloud Site Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context on page 388.
Available in: both Salesforce
Preventing Offensive Language in Questions Classic and Lightning
Experience
Field Value Available in: Contact
Description: Prevents users from entering offensive language in the Title and Manager, Group,
Professional, Enterprise,
Description fields when asking a question.
Performance, Unlimited,
Formula: Developer, and
OR(CONTAINS(Title, 'darn'), CONTAINS(Body,
Database.com Editions
'darn'))

Error Message: Question title or description contains offensive language.

335
Extend Salesforce with Clicks, Not Code Customize Fields

Preventing Offensive Language in Replies

Field Value
Description: Prevents users from entering offensive language when replying to a question.

Formula:
OR(CONTAINS(Body, 'darn'), CONTAINS(Body, 'dang'))

Error Message: Reply contains offensive language.

Preventing Offensive Language in Ideas

Field Value
Description: Prevents users from entering offensive language in the Title and Description fields
when posting an idea.

Formula:
OR(CONTAINS(Title, 'darn'), CONTAINS(Body, 'darn'))

Error Message: Idea title or description contains offensive language.

Preventing Offensive Language in Idea Comments

Field Value
Description: Prevents users from entering offensive language when posting a comment.

Formula:
OR(CONTAINS(CommentBody , 'darn'), CONTAINS(CommentBody,
'dang'))

Error Message: Comment contains offensive language.

Sample Contact Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions on page 388.
Available in: both Salesforce
Classic and Lightning
Experience

Available in: Contact

Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
Developer, and
Database.com Editions

336
Extend Salesforce with Clicks, Not Code Customize Fields

Mailing Address Fields Are Required

Field Value
Description: Validates that the contact Mailing Street, Mailing City, and Mailing
Country are provided.

Formula:
OR(
ISBLANK( MailingStreet ),
ISBLANK( MailingCity ),
ISBLANK( MailingCountry )
)

Error Message: Mailing Street, City, and Country are required.

Error Location: Top of Page

Mailing Street Is Required

Field Value
Description: Validates that the contact Mailing Street is provided.

Formula:
ISBLANK( MailingStreet )

Error Message: Mailing Street is required.

Error Location: Mailing Street

337
Extend Salesforce with Clicks, Not Code Customize Fields

Mailing Zip Code

Field Value
Description: Validates that the contact Mailing Zip/Postal Code is in 99999 or 99999-9999 format if
Mailing Country is USA or blank.

Formula:
AND(
OR(MailingCountry = "USA", ISBLANK(MailingCountry)),
OR(
AND(LEN(MailingPostalCode) <>5,
LEN(MailingPostalCode) <> 10),
NOT(CONTAINS("0123456789",
LEFT( MailingPostalCode, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 2, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 3, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 4, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 5, 1))),
AND(
LEN(MailingPostalCode) = 10,
OR(
MID( MailingPostalCode , 6, 1) <> "-",
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 7, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 8, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 9, 1))),
NOT(CONTAINS("0123456789",
MID( MailingPostalCode , 10, 1)))
)
)
)
)

Note: This example interprets a blank country as US. To use this example with other countries,
remove the clause that checks the length of the country field. Also, validation rule criteria are
case sensitive, so this rule is only enforced when the country is blank or “USA” in all capital letters.
The rule is not enforced when the country is “usa.”

Tip: You can also validate zip codes using a regular expression; for an example of a formula
using a regular expression, see REGEX.

Error Message: Zip code must be in 99999 or 99999-9999 format.

Error Location: Mailing Zip/Postal Code

338
Extend Salesforce with Clicks, Not Code Customize Fields

Phone Number Has International Format

Field Value
Description: Validates that the Phone number begins with a plus sign (+) for country code. Note that this
validation rule conflicts with the ten-digit rule.

Formula:
LEFT(Phone, 1) <> "+"

Error Message: Phone number must begin with + (country code).

Error Location: Phone

US Phone Number Has Ten Digits

Field Value
Description: Validates that the Phone number is in (999) 999-9999 format. This works by using the REGEX
function to check that the number has ten digits in the (999) 999-9999 format.

Formula:
NOT(REGEX(Phone, "\\D*?(\\d\\D*?){10}"))

Error Message: US phone numbers should be in this format: (999) 999-9999.

Error Location: Phone

Sample Cross Object Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context.
Available in: both Salesforce
Discounts Must Be Within Range Classic and Lightning
Experience
This example consists of three validation rules on opportunity products. The examples below work
together to help you manage discount amounts for products and require a custom percent field Available in: Contact
on opportunity products called Line Discount. The examples below also require you to use Manager, Group,
price books and customize the Product Family field to include the following values: Professional, Enterprise,
Software, Consulting, and Training. Performance, Unlimited,
Developer, and
Software Discounts Database.com Editions

Field Value
Description: Prevents users from saving software products
with a discount over 10 percent.

Formula:
AND(Line_Discount__c > 0.10,
ISPICKVAL(Product2.Family,
"Software"))

339
Extend Salesforce with Clicks, Not Code Customize Fields

Field Value
Error Message: The discount must be 10% or less for software products.

Error Location: Line Discount

Consulting Discounts

Field Value
Description: Prevents users from saving consulting products with a discount
over 15 percent.

Formula:
AND(Line_Discount__c > 0.15,
ISPICKVAL(Product2.Family, "Consulting"))

Error Message: The discount must be 15% or less for consulting products.

Error Location: Line Discount

Training Discounts

Field Value
Description: Prevents users from saving training products with a discount over
20 percent.

Formula:
AND(Line_Discount__c > 0.20,
ISPICKVAL(Product2.Family, "Training"))

Error Message: The discount must be 20% or less for training products.

Error Location: Line Discount

Prevent Changing Opportunity Products on Closed Opportunities

This example consists of two validation rules: one on opportunity products and another on opportunities.

Field Value
Description: Prevents users from editing opportunity products after an
opportunity is closed. Create the following validation rule example
on opportunity products.

Formula:
OR(ISPICKVAL(Opportunity.StageName, "Closed
Won"), ISPICKVAL(Opportunity.StageName,
"Closed Lost"))

Error Message: Cannot change opportunity products for closed opportunities.

340
Extend Salesforce with Clicks, Not Code Customize Fields

Field Value
Error Location: Top of Page

The following validation rule is on opportunities.

Field Value
Description: Prevents users from deleting opportunity products after an
opportunity is closed. Create the following validation rule example
on opportunities. It uses a custom roll-up summary field on
opportunities that counts the number of opportunity products on
an opportunity.

Formula:
AND(OR(ISPICKVAL(StageName, "Closed Won"),
ISPICKVAL(StageName, "Closed Lost")),
Number_of_Line_Items__c <
PRIORVALUE(Number_of_Line_Items__c) )

Error Message: Cannot delete opportunity products for closed opportunities.

Error Location: Top of Page

Prevent Saving a Case When Account Does Not Have Support

Field Value
Description: Prevents users from saving a case for an account that does not
have support. This example assumes you have a custom checkbox
field on accounts called Allowed Support that tracks if the
account has support.

Formula:
Account.Allowed_Support__c = FALSE

Error Message: Unable to create cases for this account because it is not signed up
for support.

Error Location: Top of Page

Prevent Saving a Case When Contact is No Longer with the Company

Field Value
Description: Prevents users from saving an open case associated with a contact
that is no longer with the company. This example uses a custom
checkbox field on contacts called No Longer With
Company.

341
Extend Salesforce with Clicks, Not Code Customize Fields

Field Value
Formula:
AND(Contact.Not_Longer_With_Company__c,
NOT(IsClosed))

Error Message: Unable to save this case because the related contact is no longer
with the company. To continue, choose another contact.

Error Location: Contact Name

Sample Date Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context on page 388.
Available in: both Salesforce
Date Must Be a Weekday Classic and Lightning
Experience
Field Value Available in: Contact
Description: Validates that the value of a custom date field is a weekday (not Manager, Group,
Professional, Enterprise,
Saturday or Sunday).
Performance, Unlimited,
Formula: Developer, and
CASE(MOD( My_Date__c - DATE(1900, 1, 7), 7),
Database.com Editions
0, 0,
6, 0,
1) = 0

Error Message: Date must be a weekday.

Error Location: My Date

Date Must Be a Weekend Day

Field Value
Description: Validates that the value of a custom date field is a Saturday or Sunday.

Formula:
CASE( MOD( My_Date__c - DATE(1900, 1, 7), 7),
0, 1,
6, 1,
0) = 0

Error Message: Date must be a weekend day.

Error Location: My Date

342
Extend Salesforce with Clicks, Not Code Customize Fields

Date Must Be in the Current Month

Field Value
Description: Validates that a custom date field contains a date within the current month and year.

Formula:
OR (
YEAR( My_Date__c ) <> YEAR ( TODAY() ),
MONTH( My_Date__c ) <> MONTH ( TODAY() )
)

Error Message: Date must be in the current month.

Error Location: My Date

Date Must Be in the Current Year

Field Value
Description: Validates that a custom date field contains a date within the current year.

Formula: YEAR( My_Date__c ) <> YEAR ( TODAY() )

Error Message: Date must be in the current year.

Error Location: My Date

Date Must Be the Last Day of the Month

Field Value
Description: Validates whether a custom field called My Date is the last day of the month. To do this, it
determines the date of the first day of the next month and then subtracts 1 day. It includes
special case logic for December.

Formula:
DAY(My_Date__c) <>
IF(Month(My_Date__c)=12, 31,
DAY(DATE(YEAR(My_Date__c),MONTH(My_Date__c)+1,1) - 1))

Error Message: Date must be the last day of the month.

Error Location: My Date

343
Extend Salesforce with Clicks, Not Code Customize Fields

Date Must Be Within One Year of Today

Field Value
Description: Validates whether a custom field called Follow-Up Date is within one year of today’s
date. This example assumes a 365 day year. (It does not handle leap years.)

Formula:
Followup_Date__c - TODAY() > 365

Error Message: Follow-Up Date must be within one year of today.

Error Location: Follow-Up Date

Day of Month Cannot Be Greater Than 15

Field Value
Description: Validates that a custom field called Begin Date contains a date in the first 15 days of the
specified month.

Formula:
DAY( Begin_Date__c ) > 15

Error Message: Begin Date cannot be after the 15th day of month.

Error Location: Begin Date

End Date Cannot Be Before Begin Date

Field Value
Description: Validates that a custom field called End Date does not come before another custom field
called Begin Date.

Formula:
Begin_Date__c > End_Date__c

Error Message: End Date cannot be before Begin Date.

Error Location: Begin Date

344
Extend Salesforce with Clicks, Not Code Customize Fields

Expiration Date Cannot Be Before Close Date

Field Value
Description: Validates that a custom field called Expiration Date does not come before Close
Date.

Formula:
Expiration_Date__c < CloseDate

Error Message: Expiration Date cannot be before Close Date.

Error Location: Expiration Date

Sample Number Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions on page 388.
Available in: both Salesforce
Time Cards Must Total 40 Hours Classic and Lightning
Experience
Field Value Available in: Contact
Description: Ensures that users cannot save a time card record with more than Manager, Group,
Professional, Enterprise,
40 hours in a work week. This example requires five custom fields on
Performance, Unlimited,
your custom object, one for each day of work.
Developer, and
Formula: Database.com Editions
Monday_Hours__c +
Tuesday_Hours__c +
Wednesday_Hours__c +
Thursday_Hours__c +
Friday_Hours__c > 40

Error Message: Your total hours cannot exceed 40.

Error Location: Top of Page

Number Cannot Be Negative

Field Value
Description: Validates that a custom field called Hours Worked is not a negative number.

Formula:
Hours_Worked__c < 0

Error Message: Hours Worked cannot be less than zero.

Error Location: Hours Worked

345
Extend Salesforce with Clicks, Not Code Customize Fields

Number Must Be Even

Field Value
Description: Validates that a custom field called Ark Passengers is a non-negative even number.

Formula:
OR(
Ark_Passengers__c < 0,
MOD( Ark_Passengers__c, 2) <> 0
)

Error Message: Ark Passengers must be a positive even number.

Error Location: Ark Passengers

Number Must Be Odd

Field Value
Description: Validates that a custom field called Socks Found is a non-negative odd number.

Formula:
OR(
Socks_Found__c < 0,
MOD( Socks_Found__c, 2) = 0
)

Error Message: Socks Found must be an odd number.

Error Location: Socks Found

Number Must Be a Multiple of Five

Field Value
Description: Validates that a custom field called Multiple of 5 is a multiple of five.

Formula:
MOD( Multiple_of_5__c, 5) <> 0

Error Message: Number must be a multiple of five.

Error Location: Multiple of 5

346
Extend Salesforce with Clicks, Not Code Customize Fields

Number Must Be an Integer

Field Value
Description: Validates that a custom field called My Integer is an integer.

Formula:
FLOOR( My_Integer__c) <> My_Integer__c

Error Message: This field must be an integer.

Error Location: My Integer

Number Must Be Between -50 and 50

Field Value
Description: Validates that a custom field called Volume is between -50 and 50.

Formula:
ABS( Volume__c) > 50

Error Message: Volume must be between -50 and 50.

Error Location: Volume

Number Range Validation

Field Value
Description: Validates that the range between two custom fields, Salary Min and Salary Max, is
no greater than $20,000.

Formula:
(Salary_Max__c - Salary_Min__c) > 20000

Error Message: Salary range must be within $20,000. Adjust the Salary Max or Salary Min values.

Error Location: Salary Max

347
Extend Salesforce with Clicks, Not Code Customize Fields

Percentage Must Be Between Zero and 100

Field Value
Description: Validates that a custom field called Mix Pct is between 0 and 100%. Note that percent fields
are expressed divided by 100 in formulas (100% is expressed as 1; 50% is expressed as 0.5).

Formula:
OR(
Mix_Pct__c > 1.0,
Mix_Pct__c < 0.0
)

Error Message: Mix Pct must be between 0 and 100%.

Error Location: Mix Pct

Sample Opportunity Management Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions on page 388.
Available in: both Salesforce
Conditionally-Required Field Based on Opportunity Stage Classic and Lightning
Experience
Field Value Available in: Contact
Description: Validates that a custom field called Delivery Date is provided Manager, Group,
Professional, Enterprise,
if an opportunity has advanced to the Closed Won or
Performance, Unlimited,
Negotiation/Review stage.
Developer, and
Formula: Database.com Editions
AND (
OR (
ISPICKVAL(StageName, "Closed Won"),
ISPICKVAL(StageName,
"Negotiation/Review")),
ISBLANK(Delivery_Date__c)
)

Error Message: Delivery Date is required for this stage.

Error Location: Delivery Date

348
Extend Salesforce with Clicks, Not Code Customize Fields

Close Date Cannot Be Prior to Current Month

Field Value
Description: Validates that the Close Date of an opportunity is not within a month prior to the current
month. Note the use of ISNEW and ISCHANGED in this formula to ensure the condition is only
checked when the opportunity is being created or the Close Date field is modified
subsequently.

Formula:
AND(
OR (
ISNEW(),
ISCHANGED( CloseDate )),
CloseDate < DATE( YEAR(TODAY()), MONTH(TODAY()), 1) )

Error Message: Close Date cannot be prior to current month.

Error Location: Close Date

Close Date Must Be a Future Date

Field Value
Description: Ensures that users do not change the Close Date of an opportunity to a day in the past.

Formula:
SampleDate < TODAY()

Error Message: Close Date cannot be a day in the past.

Error Location: Close Date

Discounts on Opportunities

Field Value
Description: Validates that a custom discount percent field is between 0 and 40%.

Formula: OR(Discount_Rate__c < 0, Discount_Rate__c > 0.40)

Error Message: The Discount Rate must not exceed 40%.

Error Location: Discount Rate

349
Extend Salesforce with Clicks, Not Code Customize Fields

High-Value Opportunity Must Be Approved Before Closed

Field Value
Description: Opportunities with amounts greater than $50,000 require that a custom checkbox field called
Approved is checked in order to change the stage to Closed Won or Closed Lost. To automate
this, set field-level security on the Approved checkbox so that it can only be checked via a
custom approval process (Enterprise Edition, Unlimited Edition, or Performance Edition).

Formula:
AND(
OR(
ISPICKVAL(StageName,"Closed Won"),
ISPICKVAL(StageName,"Closed Lost")),
(Amount > 50000),
NOT(ISPICKVAL(Approval_Status__c ,"Approved")))

Error Message: All high-value opportunities must be approved for closure. Click the Request Close button.

Error Location: Top of Page

Opportunity Amount Cannot Exceed $10 Million

Field Value
Description: Validates that opportunity Amount is positive and no more than $10 million. This limit is
designed to catch typos.

Formula:
OR(
Amount < 0,
Amount > 10000000
)

Error Message: Amount cannot exceed $10 million.

Error Location: Amount

Opportunity Check for Products

Field Value
Description: Validates that an opportunity has at least one opportunity product before users can save a change to
an opportunity.

Formula:
NOT(OR(ISNEW(),HasOpportunityLineItem))

Error Message: You must add products to this opportunity before saving.

Error Location: Top of Page

350
Extend Salesforce with Clicks, Not Code Customize Fields

Opportunity Must Have Products if Beyond “Needs Analysis” Stage

Field Value
Description: Validates that an opportunity has opportunity products before the Stage can move beyond
Needs Analysis.

Formula:
AND (
CASE( StageName,
"Value Proposition", 1,
"Id. Decision Makers", 1,
"Perception Analysis", 1,
"Proposal/Price Quote", 1,
"Negotiation/Review", 1,
"Closed Won", 1,
0) = 1,
NOT(HasOpportunityLineItem)
)

Error Message: Opportunity products are required to advance beyond the Needs Analysis stage.

Error Location: Top of Page

Opportunity Name Format

Field Value
Description: Validates that an opportunity contains a hyphen as a way of enforcing an “[Account] - [Amount]”
opportunity naming convention.

Formula:
FIND( " - ", Name ) = 0

Error Message: Opportunity Name should use “[Account] - [Amount]” format.

Error Location: Opportunity Name

351
Extend Salesforce with Clicks, Not Code Customize Fields

Prevent Sales Reps from Moving Opportunity Stage Backwards

Field Value
Description: Prevent sales reps from changing opportunity Stage “backwards” to specific values, once
they have accepted the opportunity via a custom approval process. The approval process sets
the custom Accepted Flag checkbox to True.

Formula:
AND(
Accepted_Flag__c,
OR ( ISPICKVAL( StageName, "Stage 1"), ISPICKVAL( StageName,
"Stage 2"))
)

Error Message: Invalid stage for accepted opportunity.

Error Location: Stage

Probability Must Be 100% for Won Opportunities

Field Value
Description: Validates that the probability of a won opportunity is properly set to 100%. This is useful for
data cleanliness and reporting purposes.

Formula:
AND (
ISPICKVAL( StageName, "Closed Won"),
Probability <> 1)

Error Message: Probability must be 100% for won opportunities.

Error Location: Probability

Probability Must Be Zero for Lost Opportunities

Field Value
Description: Validates that the probability of a lost opportunity is properly set to zero. This is useful for data
cleanliness and reporting purposes.

Formula:
AND (
ISPICKVAL( StageName, "Closed Lost"),
Probability <> 0)

Error Message: Probability must be 0% for lost opportunities.

Error Location: Probability

352
Extend Salesforce with Clicks, Not Code Customize Fields

Project Start Date

Field Value
Description: Validates that a field is conditionally required based on the values of other fields. Use this validation
formula to ensure that users include a Project Start Date for an opportunity that is
closed/won.

Formula:
AND(ISPICKVAL(StageName, "Closed Won"),
ISNULL(Project_Start_Date__c))

Error Message: Project start date is required for won opportunities.

Error Location: Project Start Date

Sample Quote Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context.
Available in: both Salesforce
Display Error if Quote Line Item Discount Exceeds 40% Classic and Lightning
Experience
Field Value Available in: Contact
Description: Shows an error if a quote line item's discount exceeds 40%. Manager, Group,
Professional, Enterprise,
Formula: Performance, Unlimited,
Discount > .40
Developer, and
Database.com Editions
Error Message: The discount on this quote line item cannot exceed 40%.

Error Location: Discount on quote

Sample User, Role, and Profile Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions on page 388.
Available in: both Salesforce
Classic and Lightning
Experience

Available in: Contact

Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
Developer, and
Database.com Editions

353
Extend Salesforce with Clicks, Not Code Customize Fields

Discount Percent Does Not Exceed Role-Based Limit

Field Value
Description: Validates that a custom field on opportunities called Discount Percent does not exceed
a maximum value that varies depending on the user’s role. The default maximum is 15%.

Formula:
Discount_Percent__c >
VLOOKUP($ObjectType.Role_Limits__c.Fields.Limit__c,
$ObjectType.Role_Limits__c.Fields.Name,
$UserRole.Name)

Error Message: Discount (%) exceeds limit allowed for your role.

Error Location: Discount Percent

Expense Amount Does Not Exceed User's Max Allowed Expense

Field Value
Description: Validates a custom field called Expense Amount against a custom user field called Max
Allowed Expense.

Formula:
Expense_Amount__c > $User.Max_Allowed_Expense__c

Error Message: Amount cannot exceed your maximum allowed expense.

Error Location: Expense Amount

Only Record Owner Can Change Field

Field Value
Description: Ensures that only the record owner can make changes to a custom field called Personal
Goal.

Formula:
AND(
ISCHANGED( Personal_Goal__c ),
Owner <> $User.Id
)

Error Message: Only record owner can change Personal Goal.

Error Location: Personal Goal

354
Extend Salesforce with Clicks, Not Code Customize Fields

Only Record Owner or Administrator Can Change Field

Field Value
Description: Ensures that a user can make changes to a custom field called Personal Goal only if the
user is the record owner or has a custom profile of “Custom: System Admin.”

Formula:
AND( ISCHANGED( Personal_Goal__c ), Owner <> $User.Id,
$Profile.Name <>
"Custom: System Admin" )

Note: $Profile merge fields are only available in Enterprise, Unlimited, Performance,
and Developer Editions.

Error Message: Only record owner or administrator can change Personal Goal.

Error Location: Personal Goal

Opportunity Close Date Can Only Be Back-Dated by Administrator

Field Value
Description: Validates that the Close Date of an opportunity does not fall prior to the current month,
except for users who have a custom profile called “Custom: System Admin.”

Formula:
AND(
OR (
ISNEW(),
ISCHANGED( CloseDate )),
CloseDate < DATE( YEAR(TODAY()), MONTH(TODAY()), 1),
$Profile.Name <> "Custom: System Admin"
)

Note: $Profile merge fields are only available in Enterprise, Unlimited, Performance,
and Developer Editions.

Error Message: Close Date cannot be prior to current month.

Error Location: Close Date

355
Extend Salesforce with Clicks, Not Code Customize Fields

Miscellaneous Sample Validation Rules

For more information on any of the formula functions used in these examples, see Formula Operators
EDITIONS
and Functions by Context on page 388.
Available in: both Salesforce
Allow Number to Be Increased but Not Decreased Classic and Lightning
Experience
Field Value Available in: Contact
Description: Allows a custom field called Commit Amount to be increased Manager, Group,
Professional, Enterprise,
but not decreased after initial creation. This rule uses the
Performance, Unlimited,
PRIORVALUE() function to compare the updated value of the field to
Developer, and
its value prior to update.
Database.com Editions
Formula:
PRIORVALUE(Commit_Amount__c) >
Commit_Amount__c

Error Message: Commit Amount cannot be decreased.

Error Location: Commit Amount

California Driver's License

Field Value
Description: Ensures that a custom field called Drivers License is in the correct A9999999 format
when the Mailing State is “CA”.

Formula:
AND(
MailingState = "CA",
NOT(REGEX(Drivers_License__c, "([A-Z]\\d{7})?"))
)

Error Message: Invalid California driver's license format.

Error Location: Drivers License

356
Extend Salesforce with Clicks, Not Code Customize Fields

Force Users to Check “I Accept Terms” to Enter Certain Values

Field Value
Description: Uses a checkbox labeled “I accept terms” to force the user to select a checkbox in order to enter
a value called Number of Days that exceeds their Paid Time Off (PTO) balance available.

Formula:
AND(
NOT( I_accept_terms__c ),
Number_of_Days__c > $User.PTO_Balance__c
)

Error Message: Request will cause a negative PTO balance. You must accept Negative PTO Balance terms.

Error Location: I accept terms

Prohibit Changes to a Field After It Has Been Saved

Field Value
Description: Prevents users from changing a custom field called Guaranteed Rate after it has been
saved initially.

Formula:
AND(
NOT( ISNEW() ),
ISCHANGED( Guaranteed_Rate__c )
)

Error Message: Guaranteed Rate cannot be changed.

Error Location: Guaranteed Rate

357
Extend Salesforce with Clicks, Not Code Customize Fields

Social Security Number Format

Field Value
Description: Validates that a custom text field called SSN is formatted in 999-99-9999 number format (if it
is not blank). The pattern specifies:
• Three single digits (0-9):\\d{3}
• A dash
• Two single digits (0-9):\\d{2}
• A dash
• Four single digits (0-9):\\d{4}

Formula:
NOT(
OR(
ISBLANK(Social_Security_Number__c),
REGEX( Social_Security_Number__c , "[0-9]{3}-[0-9]{2}-[0-9]{4}")
)
)

Error Message: SSN must be in this format: 999-99-9999.

Error Location: SSN

Valid Currency

Field Value
Description: Validates selected currency against an explicit subset of active currencies in your organization
using the Currency picklist. Use this example if you only allow some of the active currencies
in your organization to be applied to certain types of records.

Formula:
CASE(CurrencyIsoCode,
"USD", 1,
"EUR", 1,
"GBP", 1,
"JPY", 1,
0) = 0

Error Message: Currency must be USD, EUR, GBP, or JPY.

Error Location: Currency

358
Extend Salesforce with Clicks, Not Code Customize Fields

Valid Credit Card Number

Field Value
Description: Validates that a custom text field called Credit_Card_Number is formatted in
9999-9999-9999-9999 or 9999999999999999 number format when it is not blank. The pattern
specifies:
• Four digits (0-9) followed by a dash: \\d{4}-
• The aforementioned pattern is repeated three times by wrapping it in () {3}
• Four digits (0-9)
• The OR character (|) allows an alternative pattern of 16 digits of zero through nine with no
dashes: \\d{16}

Formula:
NOT( REGEX( Credit_Card_Number__c ,
"(((\\d{4}-){3}\\d{4})|\\d{16})?"))

Error Message: Credit Card Number must be in this format: 9999-9999-9999-9999 or 9999999999999999.

Error Location: Credit Card Number

Valid IP Address

Field Value
Description: Ensures that a custom field called IP Address is in the correct format, four 3-digit numbers
(0-255) separated by periods.

Formula:
NOT(
REGEX( IP_Address__c,
"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.)
{3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" ))

Error Message: Error: IP Address must be in form 999.999.999.999 where each part is between 0 and 255.

Error Location: IP Address

359
Extend Salesforce with Clicks, Not Code Customize Fields

Website Extension

Field Value
Description: Validates a custom field called Web Site to ensure its last four characters are in an explicit
set of valid website extensions.

Formula:
AND(
RIGHT( Web_Site__c, 4) <> ".COM",
RIGHT( Web_Site__c, 4) <> ".com",
RIGHT( Web_Site__c, 4) <> ".ORG",
RIGHT( Web_Site__c, 4) <> ".org",
RIGHT( Web_Site__c, 4) <> ".NET",
RIGHT( Web_Site__c, 4) <> ".net",
RIGHT( Web_Site__c, 6) <> ".CO.UK",
RIGHT( Web_Site__c, 6) <> ".co.uk"
)

Error Message: Web Site must have an extension of .com, .org, .net, or .co.uk.

Error Location: Web Site

Require Field Input to Ensure Data Quality

Improve the quality of data that users enter in Salesforce by creating universally required fields.
EDITIONS
A universally required field is a custom field. It must have a value whenever a record is saved within
Salesforce, the Lightning Platform API, Connect Offline, Salesforce for Outlook, the Self-Service Available in: both Salesforce
portal, or automated processes, such as Web-to-Lead and Web-to-Case. Making a field required on Classic (not available in all
a page layout or through field-level security ensures that users must enter a value. Making a field orgs) and Lightning
required universally gives you a higher level of data quality beyond the presentation level of page Experience
layouts. Available in: Contact
You can make these types of custom fields universally required: Manager, Group,
Professional, Enterprise,
• Currency
Performance, Unlimited,
• Date Developer, and
• Date/Time Database.com Editions
• Email Connect Offline, Salesforce
• Master-Detail Relationship (always required) for Outlook, the Self-Service
portal, Web-to-Lead, and
• Number Web-to-Case aren’t
• Percent available in Database.com
• Phone .
• Picklist
• Text
• Text Area
• URL
To make a custom field universally required, select the Required checkbox when defining the custom field.

360
Extend Salesforce with Clicks, Not Code Customize Fields

Note: You must specify a default value for required campaign member custom fields.
If you make a user field universally required, you must specify a default value for that field.

Relationship group members don’t support universally required fields.

Considerations for Universally Required Fields

Considerations for Universally Required Fields

A universally required field is a custom field. It must have a value whenever a record is saved within
EDITIONS
Salesforce, the Lightning Platform API, Connect Offline, Salesforce for Outlook, the Self-Service
portal, or automated processes such as Web-to-Lead and Web-to-Case. Review the following Available in: both Salesforce
considerations before making your custom fields universally required. Classic (not available in all
• Standard fields cannot be universally required. orgs) and Lightning
Experience
• Universally required fields are required across all record types.
• Edit pages always display universally required fields, regardless of field-level security. Available in: Contact
Manager, Group,
• When designing your page layouts, universally required fields:
Professional, Enterprise,
– Cannot be removed from a page layout Performance, Unlimited,
– Are automatically added to the end of the first section of a page layout if not already on it Developer, and
Database.com Editions
– Cannot be read only or optional
Standard Objects, Page
– Display in bold, indicating they are always visible
Layouts, Connect Offline,
– Are disabled on the field properties page because you cannot remove the required setting Salesforce for Outlook, the
• Universally required fields are only enforced during lead conversion if validation and triggers Self-Service portal,
Web-to-Lead, and
for lead conversion are enabled in your organization.
Web-to-Cases are not
• Quick Create does not enforce universally required fields. available in Database.com
• If you make an activity custom field universally required, you must also provide a default value.
• You must include universally required fields in your import files or the import will fail.
• Don’t assign default values to fields that are both required and unique, because uniqueness errors can result.
• You cannot make a field universally required if it is used by a field update that sets the field to a blank value.
• Required fields may be blank on records that existed before making the field required. When a user updates a record with a blank
required field, the user must enter a value in the required field before saving the record.
• Web-to-Lead and Web-to-Case request data is not validated by Salesforce. Invalid data isn’t saved when requests are submitted. For
example, if your custom field is a currency field and a user enters alphabetic characters such as “Abc” instead of numbers, the request
is still submitted but with no value saved in the custom currency field.

SEE ALSO:
Require Field Input to Ensure Data Quality

361
Extend Salesforce with Clicks, Not Code Customize Fields

About Field Sets

A field set is a grouping of fields. For example, you could have a field set that contains fields describing
EDITIONS
a user's first name, middle name, last name, and business title. When a field set is added to a
Visualforce page, developers can loop over its fields and render them. If the page is added to a Available in: Salesforce
managed package, administrators can add, remove, or reorder fields in a field set to modify the Classic
fields presented on the Visualforce page without modifying any code. The same Visualforce page
can present different sets of information, depending on which fields a subscriber prefers to keep. Available in: Group,
Professional, Enterprise,
As an administrator, you can create or edit field sets for your organization, or edit any installed field Performance, Unlimited,
set. Field sets are available on all standard objects that support custom fields, and any organization and Developer Editions
that supports creating Visualforce pages.

Note: Only fields available in the API can be added to field sets.

Fields added to a field set can be in one of two categories:

• If a field is marked as Available for the Field Set, it exists in the field set, but the developer hasn’t presented it on
the packaged Visualforce page. Administrators can display the field after the field set is deployed by moving it from the Available
column to the In the Field Set column.
• If a field is marked as In the Field Set, the developer has rendered the field on the packaged Visualforce page by default.
Administrators can remove the field from the page after the field set is deployed by removing it from the In the Field Set
column.

Creating and Editing Field Sets

Field Sets Required Bit

SEE ALSO:
Create Custom Fields
Developer's Guide: Visualforce Developer's Guide
ISVforce Guide

Creating and Editing Field Sets

Salesforce has a drag-and-drop WYSIWYG tool for creating and editing field sets The enhanced
EDITIONS
field sets editor is enabled by default, and provides all of the functionality of the original editor, as
well as additional functionality and an easier-to-use WYSIWYG interface. Available in: Salesforce
1. From the management settings for the appropriate object, go to Field Sets, and then click New. Classic
2. Enter a Field Set Label. This is the name presented to subscribers who install the field through Available in: Contact
a managed package. Manager, Group,
3. Optionally, enter a name for your field set. This is used by your Visualforce page to reference Professional, Enterprise,
Performance, Unlimited,
the field set.
and Developer Editions
4. In the Where is this used? area, provide a brief description of which Visualforce pages use the
field set, and for what purpose. This information helps a subscriber understand where and how
an installed field set is being used, so that they can populate it with their own fields.
5. Save your changes.

362
Extend Salesforce with Clicks, Not Code Customize Fields

6. To add fields to the field set, drag the fields from the object palette and drop them into the Available for the Field
Set or the In the Field Set container. The fields in the Available for the Field Set container are not
initially visible on the Visualforce page. The fields in the In the Field Set container are visible by default.

Note: In the field set, you can span to fields that reference multiple objects. When you span a field into a field set that references
multiple objects, the only field you can span to is the Name object.
You can drag and drop a field from one container to the other. The vertical order of the In the Field Set list indicates the
order of how the fields render on Visualforce pages.

7. To remove a field from the field set, drag the element back to the object palette, or click next to the element.
8. To make a field required, double click the element or click ( ) next to it and select the Required checkbox.

Note: Indicates the field is required and must have a value to save the record.

9. Save your changes.

Important: The total number of cross object spans within the In the Field Set container can't exceed 25.

After a field set is deployed in your organization, you can always mark fields that are in the Available for the Field Set
list as In the Field Set, or vice versa. To do so:
1. Find the field set that you want to edit. From Setup enter Installed Packages in the Quick Find box, select Installed
Packages, click an installed package, and then click the field set you want to edit. Alternatively, if you know which object contains
the field set you want to edit, go to the object detail page and click Edit in the field set related list.
2. If you didn't create the field set initially, you'll only be able to edit the fields within the field set. To move fields between containers,
drag and drop a field from one container to the other. To change the order of a rendered field, drag a field up or down the list and
drop the field in the order you want it to appear.
3. Save your changes.

SEE ALSO:
About Field Sets

Field Sets Required Bit

You can define a field as required when you create or edit field sets. You may want to define a field
EDITIONS
as required to ensure a user enters the necessary information on a field. The required field is only
available in the In the Field Set container. If you define a field as required in the In Available in: Salesforce
the Field Set container, and remove the field from the In the Field Set, the Classic
required attribute is removed.
Available in: Group,
Note: If you remove fields that were made required by an installed managed package from Professional, Enterprise,
the In the Field Set container, the required attribute isn’t removed from those Performance, Unlimited,
fields. and Developer Editions
To define a field as required in a field set, see Creating and Editing Field Sets

SEE ALSO:
About Field Sets

363
Extend Salesforce with Clicks, Not Code Customize Fields

Roll-Up Summary Field

A roll-up summary field calculates values from related records, such as those in a related list. You
EDITIONS
can create a roll-up summary field to display a value in a master record based on the values of fields
in a detail record. The detail record must be related to the master through a master-detail relationship. Available in: both Salesforce
For example, you want to display the sum of invoice amounts for all related invoice custom object Classic (not available in all
records in an account’s Invoices related list. You can display this total in a custom account field orgs) and Lightning
called Total Invoice Amount. Experience
Important: Where possible, we changed noninclusive terms to align with our company Available in: Contact
value of Equality. We maintained certain terms to avoid any effect on customer Manager, Group,
implementations. Professional, Enterprise,
Performance, Unlimited,
You can perform different types of calculations with a roll-up summary field. You can count the
Developer, and
number of detail records related to a master record. Or, you can calculate the sum, minimum value,
Database.com Editions
or maximum value of a field in the detail records.
Before you begin creating roll-up summary fields for your org, review the implementation tips and
best practices.

Administration
• Create roll-up summary fields on:
– Any custom object that is on the master side of a master-detail relationship
– Any standard object that is on the master side of a master-detail relationship with a custom object
– Opportunities using the values of opportunity products related to the opportunity
– Accounts using the values of related opportunities
– Campaigns using campaign member status or the values of campaign member custom fields

Note: Campaign member custom formula fields that reference fields derived from leads or contacts aren’t supported.

• The types of fields you can calculate in a roll-up summary field depend on the type of calculation. For example:
– Number, currency, and percent fields are available when you select SUM as the roll-up type.
– Number, currency, percent, date, and date/time fields are available when you select MIN or MAX as the roll-up type.

• Sometimes you can’t change the field type of a field that you reference in a roll-up summary field.
• Make sure that the filter for your roll-up summary doesn’t encounter a formula field that results in #Error!. If one of your filter criteria
uses a formula field that results in an error, no matches are returned for that filter criterion. For example, your roll-up summary filter
is “Formula Field equals 10”. Two records contain errors, and one contains the value “10” in that field. In this case, your summary
includes only the record with the value “10.”
• Salesforce doesn’t recalculate the value of campaign roll-up summary fields when a lead or contact is deleted. Select the Force a
mass recalculation of this field option on the edit page of the roll-up summary field to manually recalculate the value.
• You can’t use long text area, multi-select picklist, Description fields, system fields like Last Activity, cross-object formula
fields, and lookup fields in the field column of roll-up summary filters.
• Auto number fields aren’t available as the field to aggregate in a roll-up summary field.
• After you create a roll-up summary field on an object, you can’t convert the object’s master-detail relationship into a lookup relationship.
• Roll-up summary fields aren’t available for mapping lead fields of converted leads.

364
Extend Salesforce with Clicks, Not Code Customize Fields

Management
• If a roll-up summary field doesn’t contain cross-object field references or functions that derive values on the fly, such as NOW or
TODAY, it can calculate the values of formula fields.

Note: The value of a formula field can result in #Error!, which affects the summarized total. If your roll-up summary type is
COUNT, records are included regardless of whether they contain a formula field with an error. However, when the Field
to Aggregate is a formula field that results in #Error!, calculations of type MIN, MAX, and SUM exclude those formula
values.

• Changes to the value of a roll-up summary field can trigger assignment rules to run. If a roll-up summary field is part of the criteria
in an assignment rule, the field’s new value is used to evaluate whether to reassign the record.
• These changes cause a mass recalculation of roll-up summary fields. However, when these changes cause a recalculation of roll-up
summary values, the recalculation doesn’t trigger workflow rules and field validations.
– Changing the roll-up summary definition, such as the object, function, or field being aggregated
– Changing the expression of a formula field referenced in a roll-up summary field
– Replacing picklist values for picklist fields referenced in the roll-up summary filter
– Changing picklist record type definitions
– Changing currency conversion rates
– Changing price book entries
– Selecting the Force a mass recalculation of this field option on the edit page of the roll-up summary
field

• Calculating roll-up summary field values can take up to 30 minutes, depending on the number of records affected and other factors.
• You aren’t prevented from creating roll-up summary fields that can result in invalid values, such as February 29 in a non-leap year.
If a roll-up summary field results in an invalid value, the value isn’t recalculated. The field continues to display with an invalid roll-up
summary icon ( ) until you change the values being summarized.
• If your org uses multiple currencies, the currency of the master record determines the currency of the roll-up summary field. For
example, if the master and detail records are in different currencies, the detail record value is converted into the currency of the
master record.
• Changing a conversion rate triggers roll-up summary fields to recalculate. If you’re using multiple currencies, we recommend changing
the conversion rate from Manage Currencies in Setup, and not from the API. If you change the rate from the API, related jobs that
are less than 24 hours old can interfere with your change.
• If your org has advanced currency management enabled, currency roll-up summary fields are invalid if they’re on accounts and
summarizing opportunity values, or on opportunities and summarizing custom object values.
• Salesforce prevents users from saving a record if it invalidates a related record. For example, a master record has a validation rule
that requires the roll-up summary field value to be greater than 100. If the user’s change to a related child record would put the
value over 100, the user can’t save the record.
• If a lookup field references a record that was deleted, Salesforce clears the value of the lookup field by default. Alternatively, you can
choose to prevent records from being deleted if they’re in a lookup relationship.
To be used in a roll-up summary field with a Roll-Up Type of COUNT or SUM, the lookup field must have the What to
do if the lookup record is deleted? option set to Don’t allow deletion of the lookup record
that’s part of a lookup relationship. If the option Clear the value of this field. You
can’t choose this option if you make the field required is selected, you can’t create a COUNT or
SUM roll-up summary field that pulls data from your lookup field.

• When multiple currencies are enabled in an org and corporate currency is different from the currency set on the record, the UI and
the database for roll-up summary field values can display different decimal values. Values in the UI are displayed as two decimal

365
Extend Salesforce with Clicks, Not Code Customize Fields

places, whereas the database displays the exact value, which can be several decimal places. This behavior is due to the way values
are stored in the database. The UI precision doesn’t affect the precision of the database, which is a floating-point value.
In some cases, there can be small numerical remainders after deletion or filtering of records when you use SUM as the roll-up type.
To correct the value, recalculate the value manually by selecting the Force a mass recalculation of this field option on the edit
page of the roll-up summary field.

• 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.

Best Practices
• Apply field-level security to your roll-up summary fields if they calculate values that you don’t want visible to users. Fields that your
users can’t see due to field-level security settings on the detail record are still calculated in a roll-up summary field.
• If you have validation rules, consider how they affect roll-up summary fields. The value in a roll-up summary field changes when the
values in the detail records change. So, validation errors can display when saving either the detail or master record.
• Because roll-up summary fields aren’t displayed on edit pages, you can use them in validation rules but not as the error location for
your validation.
• Avoid referencing a roll-up summary field from a child record. The roll-up summary fields referenced from a child record can have
outdated values because the parent record isn’t updated. Instead, reference roll-up summary fields from a parent record. Your roll-up
summary fields always have updated values because that rule runs after the parent value is updated.
If you’re trying to enforce a record limit of 25 on the parent roll-up summary field, create validation rules on your child objects. When
you add a child record, your validation rule on the child object can check if the count is already 25 or greater.
AND(ISNEW(), Sample.Line_Count__c >= 25)

• Plan your implementation of roll-up summary fields carefully before creating them. After created, you can’t change the detail object
selected or delete any field referenced in your roll-up summary definition.
• Advanced currency management affects roll-up summary fields. If your org enables advanced currency management, delete the
currency roll-up summary fields on accounts that summarize opportunity values and on opportunities that summarize custom object
values. Otherwise, the fields continue to display with an invalid roll-up summary icon because their values are no longer calculated.
• Automatically derived fields, such as current date or current user, aren’t allowed in a roll-up summary field. Forbidden fields include
formula fields containing functions that derive values on the fly, such as DATEVALUE, NOW, and TODAY. Formula fields that include
related object merge fields are also not allowed in roll-up summary fields.
• When you refer to a roll-up summary field in a list view or report, you can’t use certain qualifiers, including:
– Starts with
– Contains
– Does not contain
– Includes
– Excludes
– Within

366
Extend Salesforce with Clicks, Not Code Customize Fields

Defining Roll-Up Summaries

Define roll-up summary fields on the object that is on the master side of a master-detail relationship.

SEE ALSO:
Create Custom Fields
Custom Fields Allowed Per Object

Defining Roll-Up Summaries

Define roll-up summary fields on the object that is on the master side of a master-detail relationship.
EDITIONS
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 Available in: both Salesforce
implementations. Classic and Lightning
Experience
If a relationship does not already exist, first create a master-detail relationship between the master
object that displays the value and the detail object containing the records you are summarizing. Available in: Contact
Manager, Group,
To define a roll-up summary field: Professional, Enterprise,
1. Create a custom field on the object where you want the field displayed. Summary fields Performance, Unlimited,
summarize the values from records on a related object, so the object on which you create the Developer, and
field should be on the master side of a master-detail relationship. For instructions on creating Database.com Editions
a custom field, see Create Custom Fields on page 237.
2. Choose the Roll-Up Summary field type, and click Next. USER PERMISSIONS
3. Enter a field label and any other attributes. Click Next. To view roll-up summary
4. Select the object on the detail side of a master-detail relationship. This object contains the field definitions:
records you want to summarize. • View Setup and
Configuration
5. Select the type of summary:
To edit roll-up summary field
definitions:
Type Description
• Customize Application
COUNT Totals the number of related records.

SUM Totals the values in the field you select in the Field to Aggregate
option. Only number, currency, and percent fields are available.

MIN Displays the lowest value of the field you select in the Field to
Aggregate option for all directly related records. Only number, currency,
percent, date, and date/time fields are available.

MAX Displays the highest value of the field you select in the Field to
Aggregate option for all directly related records. Only number, currency,
percent, date, and date/time fields are available.

6. Enter your filter criteria if you want a selected group of records in your summary calculation. If your organization uses multiple
languages, enter filter values in your organization's default language.

367
Extend Salesforce with Clicks, Not Code Customize Fields

When you use picklists to specify filter criteria, the selected values are stored in the organization's default language. If you edit or
clone existing filter criteria, first set the Default Language on the Company Information page to the same language that was
used to set the original filter criteria. Otherwise, the filter criteria may not be evaluated as expected.

7. Click Next.
8. Set the field-level security to determine whether the field should be visible for specific profiles, and click Next.
9. Choose the page layouts that should display the field. The field is added as the last field in the first two-column section on the page
layout. For user custom fields, the field is automatically added to the bottom of the user detail page.
10. Click Save to finish or Save & New to create more custom fields.

SEE ALSO:
Roll-Up Summary Field

Lookup Filters
Improve user productivity and data quality with lookup filters. Lookup filters are administrator
EDITIONS
settings that restrict the valid values and lookup dialog results for lookup, master-detail, and
hierarchical relationship fields. Available in: both Salesforce
Important: Where possible, we changed noninclusive terms to align with our company Classic (not available in all
orgs) and Lightning
value of Equality. We maintained certain terms to avoid any effect on customer
Experience
implementations.
Administrators specify the restrictions by configuring filter criteria that compare fields and values Available in: All Editions
on: except for Database.com.

• The current record (source)

• The lookup object (target)
USER PERMISSIONS
• The user's record, permissions, and role To manage lookup filters:
• Records directly related to the target object • Customize Application

For example, you can:

• Restrict the Account Name field on opportunities to allow only accounts with a record type of Customer, filtering out Partner
and Competitor.
• Restrict the Account Name field on opportunities to allow only active accounts.
• Restrict the Contact field on cases to allow only contacts associated with the account specified in the Account Name field
on the case record.
• Restrict the Account Name field on cases to allow only users with the “International Sales” profile to create or edit cases for
accounts outside the United States.

Tip: When you define a lookup filter, you can choose from a list of filter criteria that Salesforce suggests. The list is based on the
relationships between objects in your org. To see the suggested criteria, select Insert Suggested Criteria.
In Salesforce Classic, administrators can make lookup filters required or optional. In Lightning Experience, all lookup filters are required,
even if admins specify them as optional in Setup.
• For fields with required lookup filters, values that match the lookup filter criteria appear in the lookup dialog. When editing the
record, users can't save invalid values that they type in the field. If a user tries to save an invalid value, Salesforce displays an error
message, which administrators can customize.

368
Extend Salesforce with Clicks, Not Code Customize Fields

• For fields with optional lookup filters (Salesforce Classic only), values that match the lookup filter criteria appear in the lookup dialog.
To remove the filter and view all search results for the lookup field, users can select Show all results in the lookup dialog. Also,
optional lookup filters let users save values that don't match the lookup filter criteria without Salesforce displaying any error message.
Lookup filter criteria can compare fields on the source object with different types of fields on the target object as long as the fields are
compatible.

Source Object Field Type Compatible Target Object Field Types

Currency Currency, Roll-Up Summary

Date Date, Date/Time, Roll-Up Summary

Date/Time Date, Date/Time, Roll-Up Summary

Hierarchy Hierarchy, Lookup, Master-Detail

Lookup Hierarchy, Lookup, Master-Detail

Master-Detail Lookup, Hierarchy, Master-Detail

Number Number, Percent, Roll-Up Summary

Percent Number, Percent, Roll-Up Summary

Picklist Text, Text Area, Email, URL

Roll-Up Summary Currency, Number, Date, Date/Time, Roll-Up Summary

Supported Objects
Salesforce supports lookup filters on relationship fields that point to:
• Accounts
• Assets
• Badges
• Badges Received
• Campaigns
• Cases
• Contacts
• Content Folders
• Contracts
• Endorsements
• Entitlements
• Ideas
• Leads
• Opportunities
• Order Products
• Orders
• Products

369
Extend Salesforce with Clicks, Not Code Customize Fields

• Quotes
• Service contracts
• Skill Users
• Skills
• Social Personas
• Solutions
• Thanks
• User Provisioning Accounts
• User Provisioning Logs
• User Provisioning Requests
• Users
• Work Order Line Items
• Work Orders
• Zones
• Custom objects

Define Lookup Filters

Delete or Deactivate Lookup Filters
View a List of Lookup Filters for a Target Object
Dependent Lookups
Considerations for Lookup Filters
Follow these guidelines when creating lookup filters.
Notes on Using Lookup Filters with Person Accounts
Lookup Filters Best Practices
Use these best practices when you create your lookup filter.
Lookup Filter Examples
Limitations on Lookup Filters

SEE ALSO:
Apply Lookup Searches

370
Extend Salesforce with Clicks, Not Code Customize Fields

Define Lookup Filters

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
1. You can create lookup filters for new relationship fields in step 3 of the custom field wizard. Classic (not available in all
orgs) and Lightning
a. From the management settings for the field’s object, go to Fields. Experience
b. Click Edit next to the name of the lookup or master-detail relationship field to which you
Available in: All Editions
want to apply the filter. except for Database.com.
2. In the Lookup Filter Options section, click Show Filter Settings.
3. Specify the filter criteria a record must meet to be a valid value. To specify criteria, click Insert USER PERMISSIONS
Suggested Criteria and choose from a list of suggested criteria, or manually enter your own
To define lookup filters:
criteria. To enter your own criteria:
• Customize Application
a. In the first column, click the lookup icon or start typing in the text box and select a field.
b. In the second column, select an operator.
c. In the third column, select Value if Salesforce should compare the field in the first column with a static value, or select Field
if Salesforce should compare the field in the first column with the value of another field.
d. In the fourth column, enter the value or select the field that Salesforce should compare with the field in the first column.

Note:
• Click Add Filter Logic to add Boolean conditions.
• Select a suggested field from the Field text box. You can only select fields on the current record, the lookup object, or the
user record. You can also choose related fields that are one relationship away from the lookup object. Salesforce assists
you by listing the available fields and relationships when you click the lookup icon or click inside the text box.
• Lookup filter criteria can compare fields of different types as long as they are compatible.
• Value-based filters are supported in Lightning Experience and Salesforce Classic.

4. Specify whether the filter is required or optional. For fields with optional lookup filters (Salesforce Classic only), values that match
the lookup filter criteria appear in the lookup dialog. To remove the filter and view all search results for the lookup field, users can
select Show all results in the lookup dialog. Also, optional lookup filters let users save values that don't match the lookup filter
criteria without Salesforce displaying any error message.

Note: In Lightning Experience, all filters are required, even if admins specify them as optional in Setup. There’s no Show all
results view.
For required lookup filters, specify whether you want Salesforce to display the standard error message or a custom message when
a user enters an invalid value.

5. Optionally, enter text to display in the lookup search dialog. Consider text that guides users in their searches and explains the business
rule that the lookup filter implements.
6. Leave Enable this filter selected.

371
Extend Salesforce with Clicks, Not Code Customize Fields

7. Save your changes.

SEE ALSO:
Considerations for Lookup Filters
Dependent Lookups
Lookup Filter Examples
Find Object Management Settings

Delete or Deactivate Lookup Filters

1. From the managements settings for the relationship field’s object, go to Fields.
EDITIONS
2. Scroll to the Custom Fields & Relationships related list.
Available in: both Salesforce
3. Click the name of the field containing the lookup filter.
Classic (not available in all
4. Click Edit. orgs) and Lightning
5. To deactivate the lookup filter, deselect Enable this filter, then save your changes. Experience
Deactivating a lookup filter preserves the lookup filter configuration but: Available in: All Editions
• Prevents it from applying to the relationship field except for Database.com.

• Prevents it from impacting the cross-object references limit

• Removes it as a dependency for fields referenced in the lookup filter criteria USER PERMISSIONS

6. To delete the lookup filter, click Clear Filter Criteria, then save your changes. To define lookup filters:
• Customize Application
Deleting a lookup filter permanently removes it. You can’t recover deleted lookup filters.

SEE ALSO:
Dependent Lookups
Considerations for Lookup Filters
Find Object Management Settings

View a List of Lookup Filters for a Target Object

You can quickly see a list of all of the lookup filters that restrict the values of each target object. This
EDITIONS
is useful when creating similar filters for a target object. Also, lookup filters that reference fields on
related objects count against the cross-object reference limit, which is the number of unique Available in: both Salesforce
relationships allowed for a target object. The Related Lookup Filters list lets you see which lookup Classic (not available in all
filters might impact that limit. orgs) and Lightning
To see which lookup filters affect the limit for a particular target object, from the management Experience
settings for the object, go to Related Lookup Filters. Available in: All Editions
except for Database.com.
SEE ALSO:
Dependent Lookups USER PERMISSIONS
Considerations for Lookup Filters
To define lookup filters:
• Customize Application

372
Extend Salesforce with Clicks, Not Code Customize Fields

Dependent Lookups
Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
A dependent lookup is a relationship field with a lookup filter that references fields on the source Classic (not available in all
orgs) and Lightning
object. For example, you can configure the case Contact field to only show contacts associated
Experience
with the account selected in the case Account Name field.
When a user changes the value of a referenced field on the source object, Salesforce immediately Available in: All Editions
verifies that the value in the dependent lookup still meets the lookup filter criteria. If the value except for Database.com.
doesn't meet the criteria, an error message is displayed and users can't save the record until the
value is valid. USER PERMISSIONS
If the referenced field on the source object is a lookup, master-detail, or hierarchy field, users can't
To manage dependent
change its value by typing. Instead, users must click the lookup icon and select a value in the lookup
lookups:
search dialog. • Customize Application
Tip: Dependent lookups are supported in Visualforce pages.

SEE ALSO:
Define Lookup Filters
Lookup Filter Examples

Considerations for Lookup Filters

Follow these guidelines when creating lookup filters.
EDITIONS
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 Available in: both Salesforce
implementations. Classic (not available in all
orgs) and Lightning
• On the Fields page, the icon indicates all fields with active lookup filters. The icon Experience
indicates that the lookup filter is required.
Available in: All Editions
• The lookup filters you create in Salesforce also appear in the partner portal and Customer Portal.
except for Database.com.
• Lookup filters are case-sensitive.
• If you convert a required lookup filter with a custom error message to be optional, Salesforce
USER PERMISSIONS
deletes the message.
• If you create a lookup filter that invalidates an existing value for that field, the value persists. To manage lookup filters:
However, when a user edits the record, Salesforce displays an error message and requires the • Customize Application
user to change the invalid value before saving.
• You can’t save changes that cause required lookup filters on related records to contain invalid
values.
• Versions 16.0 and higher of the Salesforce API support lookup filters. Lookup filters are enforced when you load data through the
API.
• If you configure a lookup filter to show inactive users only, the relationship field has no valid options. Inactive users are never valid
for relationship fields that point to the User object.
• If you create a filtered lookup on a field that looks up to another object, deploy both objects into the organization at the same time.
• If the field criteria include a master-detail relationship field, lookup field filters don’t work.

373
Extend Salesforce with Clicks, Not Code Customize Fields

• If the value of a controlling field invalidates the value of a dependent master-detail relationship field, Salesforce doesn’t display an
error message.
• Dependent lookups are supported in Visualforce pages.
• To create a dependent lookup filter with ServiceResource.ResourceType, use only the first letter of the picklist value, for example T
for Technician. See ServiceResource for more details.
• In Lightning Experience, a lookup filter doesn’t work if a field referenced in the filtered lookup criteria isn't added to the page layout.
When a user opens the lookup dialog box, the value being searched is automatically deleted. To avoid this issue, add the missing
field that is being used in the lookup field filter criteria to the page layout.
• Knowledge articles don’t support lookup filters.
• Value-based filters are supported in Lightning Experience and Salesforce Classic.
• If an unlocked 2GP package installs a lookup filter, then a later version of the package deletes that lookup filter, the lookup filter isn’t
removed from the subscriber org. The lookup filter must be deleted manually instead.
• When changing ownership of a record in Salesforce Classic, fields on the record that have active lookup filters aren’t validated. As a
workaround, we recommend doing lookup filter validation for a record’s fields before changing the record’s owner.

Spanning Relationships in Lookup Filters

Filter criteria can include fields related to the target object (one level only). For example, a lookup field points to a contact. The lookup
filter can reference fields on the account related to the contact using the Account Name relationship field. The lookup field can also
reference fields on the contact related to the contact via the Reports To relationship field.
For required lookup filters, each field referenced on a related lookup object counts against the number of unique relationships allowed
for the referenced object. The relationships aren’t counted against the source object. For example, the two unique relationships described
above count against the number allowed for the Contact object. Optional lookup filters don't count against the limit on the number of
unique relationships allowed per object.
To see which lookup filters affect the limit for a particular target object, from the management settings for the object, go to Related
Lookup Filters.

Lookup Filters vs. Validation Rules

Validation rules and lookup filters achieve similar ends, but offer different advantages. Use a lookup filter:Use a validation rule:
• To improve user efficiency by limiting the number of available options in a lookup search dialog.
• To improve user efficiency by automating filters on lookup search dialogs that your users manually set.
• If you're close to the maximum number of lookup filters allowed.
• To implement a complex business rule that requires you to use a formula. Formulas can reference fields that basic filter criteria can't
reference, such as fields on the parent of the source object. Formulas can also use functions. For example, use ISNEW to apply the
rule only on record creation, or ISCHANGED to apply the rule only when a field changes.

SEE ALSO:
Lookup Filters
Dependent Lookups

374
Extend Salesforce with Clicks, Not Code Customize Fields

Notes on Using Lookup Filters with Person Accounts

If your organization uses person accounts, note the following:
EDITIONS
• Person Accounts don't support Contact filters; however, Person Accounts support Account
filters. For example, if the Account field has a dependent lookup filter that's added to a Person Available in: both Salesforce
Account, dependent lookups are supported. If the Contact field has a dependent lookup filter Classic (not available in all
that's added to a Person Account, dependent lookups aren't supported. orgs) and Lightning
Experience
• Lookup filter criteria on Account Name only apply to business accounts, not person accounts.
For example, your lookup filter criteria is Account Name does not contain book. Available in: All Editions
Business accounts with “book” in the name, such as John’s Bookstore, aren’t valid. Person except for Database.com.
accounts with “book” in the name, such as John Booker, are valid. The person accounts show
in the lookup dialog for the Account field. If you must filter on the name for a person account,
use the First Name or Last Name fields instead.
• To restrict the values of a lookup field to one type of account (person or business), use the Is Person Account field in your lookup
filter criteria. For example, to restrict a lookup to only person accounts, include the following in your lookup filter criteria: Is
Person Account equals True.
• You can't package lookup filters that reference standard fields specific to person accounts, such as the Email and Title fields.

SEE ALSO:
Lookup Filters

Lookup Filters Best Practices

Use these best practices when you create your lookup filter.
EDITIONS
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 Available in: both Salesforce
implementations. Classic (not available in all
orgs) and Lightning
Custom Help Experience
Define custom help for fields with lookup filters to let users know about the business rule the
filter enforces. For example, if the lookup filter restricts the Account Name on opportunities Available in: All Editions
to only allow active accounts, define custom help that states You can only associate except for Database.com.
active accounts with opportunities.
Error Messages
To guide users who type invalid values, customize lookup filter error messages. For example, if the lookup filter restricts the Account
Name on opportunities to only allow active accounts, define an error message that states Value doesn't exist or
isn't an active account.

Important: Salesforce translates the standard error message for required lookup filters, but not custom error messages. Use
the Translation Workbench to translate lookup filter custom error messages. To restore the standard error message after
modifying it, click Reset to default message.
Working with Master-Detail Relationship Fields
When creating a lookup filter on a master-detail relationship field, verify that the current values of the field on all of the detail records
meet the criteria you specify. If you specify criteria that an existing value doesn't meet, Salesforce prevents the user from saving
changes to the detail record. If this occurs, the user must first modify the value on the master record to meet the criteria. For example,
consider a custom object with a master-detail relationship field that points to accounts. If you define a lookup filter that excludes all
accounts with a Create Date before 01/01/2009, verify that no existing records of that custom object have a master-detail

375
Extend Salesforce with Clicks, Not Code Customize Fields

relationship with any account created before 2009. A quick way to do this is to create a report that shows all accounts with a Create
Date before 01/01/2009.
Profile-Based Lookup Filters
When you reference the User object, such as Current User, use Profile: ID in filter criteria to define different filter criteria for
different users (example: Current User Profile: ID), or to let administrators enter values that don't match the criteria.
Avoid using Profile: Name due to technical limitations on standard profiles.
If you enter Current User Profile: Name or Profile: Name in the Field column of your lookup filter criteria,
Salesforce displays a lookup icon in that row. To select from a list of existing profiles rather than typing profile names, click the lookup
icon.
Record IDs vs. Record Names
To reference a specific record in filter criteria, use the ID of the record instead of its name. IDs are always unique whereas names
aren’t.
Testing
After creating a lookup filter, test it to make sure it isn’t too restrictive. Depending on their permissions, some users have read-only
access to some relationship fields; ensure your lookup filters don't prevent those users from editing records critical to their job
functions.
Dependent Lookups on Page Layouts and Mini Page Layouts in the Console
When designing page layouts with dependent lookups:
• If a dependent lookup is above its controlling field on a layout, make its lookup filter optional or redesign the layout. Moving a
required dependent lookup above its controlling field can confuse users who typically start from the top of a page when entering
data.
• Ensure that both the controlling and dependent fields are visible so users can correct invalid values.
Lookup Filters and the Lookup Filter Fields Search Layout
Don’t reference the same fields in both lookup filter criteria and the Lookup Filter Fields search layout. Users might assume that
results from their custom search override administrator-controlled lookup filters.

SEE ALSO:
Lookup Filters

Lookup Filter Examples

EDITIONS
Record Types in Lookup Filters
If the value of a relationship field should only consist of records with a particular record type, specify Available in: both Salesforce
the record type in a lookup filter. For example, if the Account Name field on opportunities Classic (not available in all
should only have accounts with a Customer Account custom record type, define the following orgs) and Lightning
lookup filter to restrict users to only creating or editing opportunities associated with accounts that Experience
have a Customer Account record type, excluding accounts with Partner Account and Competitor Available in: All Editions
Account record types: except for Database.com.
Filter Criteria
Account Name: Account Record Type equals value Customer USER PERMISSIONS
Account
To define lookup filters:
Custom Error Message
• Customize Application
Account does not exist or is not a customer account.

376
Extend Salesforce with Clicks, Not Code Customize Fields

Lookup Window Text

You can only associate customer accounts to an opportunity. Search results only
display customer accounts.

Record Status in Lookup Filters

If the value of a relationship field should only consist of records with particular status, specify the status in a lookup filter. For example,
consider a Job Application object with a relationship field that points to the Position object. If the relationship field should only
have open positions, define the following lookup filter to restrict users to only creating or editing job applications for positions with the
Status field set to Open:
Filter Criteria
Position: Status equals value Open
Custom Error Message
Position does not exist or is not an open position.
Lookup Window Text
You can associate only open positions with job applications. Search results display
open positions only.

Profiles in Lookup Filters

When a business rule does not apply to users with every profile, use the Current User Profile global variable fields to define
lookup filters that only affect users with a particular profile.
For example, the following lookup filter on the Case object Account Name field restricts users with a “Domestic Sales” profile to only
creating or editing opportunities associated with accounts that have a billing country of “USA” while allowing other users to associate
opportunities with any account:
Filter Criteria
1. Current User Profile: Name equals value Domestic Sales
2. Account Name: Billing Country equals value USA
3. Current User Profile: Name not equal to value Domestic Sales
Filter Logic
(1 AND 2) OR 3
Custom Error Message
Account does not exist or the account billing country is not USA. Domestic sales
reps can only create opportunities for accounts in the United States.
Lookup Window Text
Search results show only United States accounts in the for domestic sales
representatives.
You can modify the above example to simultaneously restrict users with a “Global Sales” custom profile to only associating opportunities
to accounts with a non-US billing country:
Filter Criteria
1. Current User Profile: Name equals value Global Sales
2. Account Name: Billing Country not equal to value USA
3. Current User Profile: Name equals value Domestic Sales

377
Extend Salesforce with Clicks, Not Code Customize Fields

4. Account Name: Billing Country equals value USA

5. Current User Profile: Name not equal to value Global Sales, Domestic Sales
Filter Logic
(1 AND 2) OR (3 AND 4) OR 5
Custom Error Message
Account does not exist or the account billing country is not in your sales area.
Sales reps can only create opportunities for accounts in their sales area.
Lookup Window Text
Search results only display accounts in your region.

Important: If you do not include line 5 in the filter criteria, users who are not in Global Sales or Domestic Sales cannot select or
save any values on account records.

Roles in Lookup Filters

When a business rule does not apply to users in every role, use the Current User Role global variable fields to define lookup
filters that only affect users with particular roles. For example, in a recruiting application that has a Position object with a lookup field to
a Compensation Package object, you can restrict users from editing or creating positions that have an executive compensation plan
unless they are executive administrators or vice presidents. To do this, define the following lookup filter on the Position object
Compensation Package Name field:
Filter Criteria
1. Current User Role: Name does not start with value VP
2. Current User Role: Name does not equal value Executive Administrator
3. Compensation Package: Plan Type does not equal value Executive
4. Current User Role: Name starts with value VP
5. Current User Role: Name equals value Executive Administrator
Filter Logic
((1 OR 2) AND 3) OR (4 OR 5)
Custom Error Message
The compensation plan does not exist, or you have selected an executive compensation
plan but do not have access to create executive positions.
Lookup Window Text
Search results only display compensation plans that are relevant to positions you
are allowed to create.

Important: Include the condition you are testing and the opposite condition. In this example, lines 1, 2, and 3 of the filter criteria
ensure that users who are not VPs or Executive Administrators cannot select Executive compensation plans, while lines 4 and 5
ensure that VPs and Executive Administrators can select Executive compensation plans.

Blank Values in Lookup Filters

Your lookup filter criteria might reference a field that users often leave blank. You can design your lookup filter criteria to accept blank
values by using the Add Filter Logic in the filter criteria to create an OR condition. For example, if you have a Partner Contact
custom field on opportunities, restrict the field to only allow contacts that are associated to an account with a Partner Account record
type, or private contacts not associated with any account.

378
Extend Salesforce with Clicks, Not Code Customize Fields

Filter Criteria
1. Partner Contact: Account: Account Record Type equals value Partner Account
2. Partner Contact: Account: Account Name equals value
Filter Logic
1 OR 2
Custom Error Message
The partner contact must be associated with a partner account, or must be a private
contact.
Lookup Window Text
Search results only display contacts from partner accounts or your private contacts.

User IDs in Lookup Filters

Using user IDs in optional lookup filters can significantly improve user efficiency by first showing lookup search dialog results that are
most relevant to the user while still allowing users to see all results if necessary. For example, on a lookup field to accounts, you can
create an optional lookup filter that restricts the search results to accounts that the user owns in the search lookup dialog results. If the
user is looking for an account that someone else owns, the user can remove the filter.
Filter Criteria
Current User: User ID equals Field Account: Owner ID
Lookup Window Text
By default, search results only display accounts you own. To search all accounts,
click “Show all results.”

Simple Dependent Lookups

If the value of a relationship field should depend on the value of another relationship field on the current record, specify the field to field
comparison in the criteria. For example, if the case Contact Name field should only have contacts associated to the account specified
in the case Account Name field, use the following lookup filter:
Filter Criteria
Contact Name: Account ID equals field Case: Account ID
Custom Error Message
Contact does not exist or is not associated to the case account.
Lookup Window Text
Search results only display contacts associated to the case account.

Note: When comparing lookup fields in lookup filter criteria, Salesforce always uses the ID of the relationship field, not the name.

Complex Lookup Filters and Dependent Lookups

Achieving complex business rules with lookup filters often involves combing your rules with filter logic and fields of various types. For
example, consider an app for booking conference rooms that has the following data model:

Object Fields

Meeting • Meeting Name

379
Extend Salesforce with Clicks, Not Code Customize Fields

• Office lookup to the Office object

• Projector Required checkbox
• Number of Participants number field
• Conference Room lookup to the Conference Room object

Conference Room • Conference Room Name

• Has Projector checkbox
• Number of Seats Available number field
• Conference Room Location lookup to the Office
object

Office • Office Name

The following lookup filter on the meeting Conference Room field restricts the valid values to conference rooms that have a
projector if the meeting requires one, as well as the necessary number of seats:
Filter Criteria
1. Meeting: Projector Required equals field Meeting Conference Room: Has Projector
2. Meeting: Projector Required equals value False
3. Conference Room: Number of Seats Available greater or equal field Meeting: Number
of Participants
Filter Logic
(1 OR 2) AND 3
Custom Error Message
Conference room not found or is insufficient for your meeting.
Lookup Window Text
Search results only display conference rooms that can support your meeting
requirements.
To refine the valid values even further, incorporate the office where the conference room is located:
Filter Criteria
1. Meeting: Projector Required equals field Meeting Conference Room: Has Projector
2. Meeting: Projector Required equals value False
3. Conference Room: Number of Seats Available greater than field Meeting: Number of
Participants
4. Meeting: Office equals Field Conference Room: Conference Room Location
Filter Logic
(1 OR 2) AND 3 AND 4
Custom Error Message
Conference room not found or is insufficient for your meeting.

380
Extend Salesforce with Clicks, Not Code Customize Fields

Lookup Window Text

Search results only display conference rooms that can support your meeting
requirements.

SEE ALSO:
Considerations for Lookup Filters

Limitations on Lookup Filters

These limitations apply to lookup filters.
• Lookup filter criteria can’t reference these types of fields:
– Relationship fields on activities
– System fields that are always read only, such as Created By and Modified By
– Relationship fields that support queues, such as Case Owner and Lead Owner

• Each object can have up to five active required lookup filters. In Salesforce Classic, you can also have an unlimited number of optional
lookup filters. If you reach the limit of required lookup filters, create optional filters. When a user saves a record, use validation rules
to enforce your business rule. In Lightning Experience, all lookup filters are required.
• Lookup filters aren’t available for external lookup relationship fields.
• Lookup filters on currency fields don't convert currencies. For example, your organization uses multiple currencies and there’s lookup
filter criteria Expected Revenue greater than 100000. The lookup shows all records with an Expected Revenue field
value greater than 100,000, regardless of the currency.
• You can’t use special date values, such as “Today” or “This Month,” in lookup filter criteria.
• You can’t delete fields that are referenced in an active lookup filter.
• You can’t change the field type of fields referenced by an active lookup filter.
• You can add up to 10 criteria rows in a lookup filter.
• Lookup filter criteria can’t reference these types of fields on the source object:
– Autonumber
– Email
– Encrypted
– Formula

Note: Formula fields containing "$USER", "$USERROLE", "$PROFILE", or "$SOURCE" are supported.

– GeoLocation
– Long text area
– Multi-select picklist
– Roll-up summary
– Text
– Text (Encrypted)
– Text area (Rich)
– Text area (Long)
– Time

381
Extend Salesforce with Clicks, Not Code Customize Fields

– URL

• Lookup auto-completion doesn’t work for user lookups with other dropdown lists. Auto-completion is primarily for organizations
that have set up either a partner portal or customer portal.
• In enhanced list views, you can’t change fields that dependent lookup filter criteria reference.
• Lookup filters don’t support mass owner changes. If your lookup filter criteria reference the Owner field, performing a mass owner
change can result in incorrect values. The incorrect values aren’t noticeable until you try to save the record.
• If a formula references global merge fields that the lookup filter doesn’t support, the lookup filter can’t reference the formula.
• Lookup filter criteria on Account Name only apply to business accounts, not person accounts. For example, your lookup filter criteria
is Account Name does not contain book. Business accounts with “book” in the name, such as John’s Bookstore, aren’t
valid. Person accounts with “book” in the name, such as John Booker, are valid. The person accounts show in the lookup dialog for
the Account field. If you must filter on the name for a person account, use the First Name or Last Name fields instead.

Fields: What’s Different or Not Available in the Salesforce Mobile App

Not every Lightning Experience feature is in the Salesforce mobile app. Find out what’s different.
EDITIONS

Fields Available in: Lightning

Experience and the
Unsupported Fields Salesforce mobile app for
• division fields iOS and Android
Combo Boxes Available in: all editions
• Combo boxes, which combine a picklist with a text field, aren’t available. Typically the text
field is available but the picklist is not.
Lookup Fields
• User-defined lookup filter fields aren't supported.
• You can’t create a record from a lookup field like you can in Lightning Experience. You can create an account from the Account
Name lookup field on the Salesforce App Lead Conversion page. You can’t create records from other lookup fields on Mobile.
• Lookup fields in Salesforce Classic show record names regardless of sharing permissions. As a result, users can see the names of
records that they can’t access. In Lightning Experience and the Salesforce mobile app, lookup fields respect sharing permissions
and only show the name of records that the user can access. The one exception is owner lookup fields, which always display the
name of the record's owner, regardless of sharing permissions.
Picklist Fields
• Controlling and dependent picklists are supported, but doesn’t display indicators on create and edit pages for these fields. To
determine if a picklist field is dependent, and which picklist field controls it, switch to the full site.
• Disabled picklists aren’t grayed out like they are in the full site.
Phone Number Fields
• The keypad that displays in phone number fields doesn’t include parentheses, hyphens, or periods, and doesn’t apply any phone
number formatting when you save the record. To apply a specific phone number format, edit the record in the full site.
Rich Text Area Fields
Support for rich text area fields varies by the version of the Salesforce mobile app and the type of device.

App Version View Rich Text Area Fields Edit Rich Text Area Fields
Salesforce for Android Yes Yes

382
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

App Version View Rich Text Area Fields Edit Rich Text Area Fields
Salesforce for iOS Yes Yes

User Fields
• While user detail pages aren’t available in the app, user fields are supported and appear on user profiles, in related lists, and so
forth.
• There are some issues when these user fields appear in related lists or mobile cards.
– The Company Name field is blank if an internal user is viewing a mobile card or related list entry related to another internal
user. If the referenced user is an external user, the company name appears correctly.
– The Active field is blank unless the user is inactive.

Calculate Field Values with Formulas

A formula is an algorithm that derives its value from other fields, expressions, or values. Formulas
EDITIONS
can help you automatically calculate the value of a field based on other fields.
Watch a Demo: Getting Started With Formulas (Salesforce Classic) Available in: both Salesforce
Classic and Lightning
This video gives a brief introduction to Salesforce formulas, accessing the formulas editor in the
Experience
app, and how to use the editor tools to create formulas.
Available in: All Editions
Where are Formulas Used in Salesforce? Reports and Approvals
Many areas in Salesforce use formulas. Before you begin using formulas, review the differences aren’t available in
in their uses. Database.com

Formula Data Types

The data type of a formula determines the type of data you expect returned from your formula.
Elements of a Formula
A formula can contain references to the values of fields, operators, functions, literal values, or other formulas.
Formula Operators and Functions by Context
Use these operators and functions when building formulas. All functions are available everywhere that you can include a formula,
such as formula fields, validation rules, approval processes, and workflow rules, unless otherwise specified.
Using Date, Date/Time, and Time Values in Formulas
Date formulas are useful for managing payment deadlines, contract ages, or any other features of your organization that are time
or date dependent.
Build a Formula Field
Your custom formula fields require special attributes.
Formula Field Limits and Restrictions
Before you create formula fields, be aware of their limits and limitations.
Formula Best Practices
You can use the Formula Editor in Salesforce to construct a simple formula with a few clicks. But what if you want to build something
more complex? Use these tips to help you map out formula logic and make it easier to troubleshoot errors.
Examples of Advanced Formula Fields
Review examples of formula fields for various types of apps that you can use and modify for your own purposes.

383
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Formulas: How Do I ... ?

Common Formula Errors
Review common errors that can occur with formulas and how to fix them.

Where are Formulas Used in Salesforce?

Many areas in Salesforce use formulas. Before you begin using formulas, review the differences in
EDITIONS
their uses.
Available in: both Salesforce
Use Formulas for: To: Classic and Lightning
Approval Processes Define the criteria a record must meet to enter the approval process. Experience

Available in: All Editions

Approval Steps Define the criteria a record must meet to enter the approval step.
Reports and Approvals are
Assignment Rules for Define the criteria the lead or case must meet for it to be assigned. not available in
Leads and Cases Database.com
Auto-Response Rules for Define the criteria a lead or case must meet to trigger an auto-response
Leads and Cases rule.

Case Escalation Rules Specify criteria a case must meet for it to be escalated.

Custom Buttons and Define the content for custom links and buttons.
Links

Custom Fields Create custom formula fields that automatically calculate a value based
on other values, merge fields, or expressions. Users can view formula
fields on record detail pages but can’t see the underlying algorithm or
edit the value of a formula field.

Note: Custom formula fields are not available in Connect Offline,

Web-to-Lead forms, or Web-to-Case forms.

Custom Summary Automatically calculate more totals based on existing report summaries
Formulas in Reports using the values, merge fields, or expressions you specify. Users can’t
change these totals.

Data Validations Verify that the data a user enters in a record meets the standards you
specify before the user can save the record. A validation rule can include
a formula such as CloseDate >= TODAY().

Default Field Values Apply a value to a custom field when a user creates a record. Use
formulas to define a default value such as TODAY() + 7.
Users can change a default value. Default field values can be based on
a formula using values, merge fields, or expressions you specify.

Escalation Rules Define the criteria that a case must meet to be escalated.

Formula Fields Automatically calculate the value of a custom field using the values,
merge fields, or expressions you specify. Users can’t change the value
of a formula field.

384
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use Formulas for: To:

Reports Create custom summary formulas in your reports to calculate more totals based on the existing
summaries in that report.

S-Controls Define the content for s-controls.

Validation Rules Prevent users from entering an invalid value in a standard or custom field. Validation rules can be
based on formulas and display an error message to users when the value they enter is not valid.

Workflow Field Updates Automatically change the value of a field to a value you specify. The formula can include other
values, merge fields, or expressions. You can set field updates to occur as a result of a workflow rule
or an approval process.

Workflow Rules Define the criteria a record must meet to trigger a workflow rule.

Visualforce Pages Define the content for Visualforce pages.

Common Formula Processes

When are they Read only? Can include Can specify null Can include
executed? functions? handling? references to
parent merge
fields?
Default Field Values Record creation No Yes No No

Formula Fields Record display Yes Yes Yes Yes

Validation Rules Record save Not applicable Yes No Yes

Workflow Rules Record save Not applicable Yes No Yes

Approval Processes Record submitted Not applicable Yes No Yes

for approval

Field Updates Workflow or Not applicable Yes No Yes

approval process

Custom Summary Report display Yes Yes, a limited subset Yes No

Formulas for Reports of functions

Formula Data Types

The data type of a formula determines the type of data you expect returned from your formula.

Data Type Description

Checkbox Returns a true or false value. The field appears as a checkbox in record detail pages and reports. Use
True for checked values and False for unchecked values.

385
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Data Type Description

Currency Returns a number in currency format of up to 18 digits with a currency sign.

Note: Salesforce uses the round-half-to-even tie-breaking rule for currency fields. For example,
23.5 becomes 24, 22.5 becomes 23, −22.5 becomes −23, and −23.5 becomes −24.

Date Returns data that represents a day on the calendar. The current date can be acquired by calling the
built-in function TODAY() in a formula. This data type isn’t available for custom summary formulas
in reports.

Date/Time Returns data that represents a moment in time. A date/time field includes the date and also the time
of day including hour, minutes, and seconds. You can insert the current date and time in a formula
using the NOW() function. This data type isn’t available for custom summary formulas in reports.

Number Returns a positive or negative integer or decimal of up to 18 digits. Salesforce uses the round half up
tie-breaking rule for numbers in formula fields. For example, 12.345 becomes 12.35 and −12.345
becomes −12.35.

Note: A formula field of type Number can store more decimals than are defined. For more
information, see "Data type number field can store more decimal places than defined."

Percent Returns a number in percent format of up to 18 digits followed by a percent sign. Percent data is
stored as a decimal divided by 100, which means that 90% is equal to 0.90.

Text Returns a string of up to 3900 characters. To display text in addition to the formula output, insert that
text in quotes. Use the text data type for text, text area, URL, phone, email, address, and auto-number
fields. This data type isn’t available for custom summary formulas in reports.

Note: Text area isn’t a supported data type.

Time Returns data that represents a moment in time, without the date. A time field includes the time of
day by hour, minutes, seconds, and milliseconds. You can insert the current time in a formula using
the TIMENOW() function.

Note: In formula expressions, use the international date format (ISO) for text arguments. For
example, use TIMEVALUE("11:30:00.000") instead of TIMEVALUE("11:30 AM").

SEE ALSO:
Build a Formula Field

Elements of a Formula
A formula can contain references to the values of fields, operators, functions, literal values, or other formulas.
Use any or all of these elements to build a formula.

386
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Element Description
Name
Literal A text string or number you enter that is not calculated or changed. For example, if you have a value that’s always multiplied
Value by 2% of an amount, your formula would contain the literal value of 2% of that amount:
ROUND((Amount*0.02), 2)

This example contains every possible part of a formula:

• A function called ROUND used to return a number rounded to a specified number of decimal places.
• A field reference called Amount.
• An operator, *, that tells the formula builder to multiply the contents of the Amount field by the literal value, 0.02.
• A literal number, 0.02. Use the decimal value for all percents. To include actual text in your formula, enclose it in quotes.
• The last number 2 in this formula is the input required for the ROUND function that determines the number of decimal
places to return.

Field Reference the value of another custom or standard field using a merge field. The syntax for a merge field is field_name
Reference for a standard field or field_name__c for a custom field. The syntax for a merge field on a related object is
object_name__r.field_name. Use the Insert Field button or the drop-down list to insert a merge field in your
formula where necessary.
To reference a field from a custom metadata type record, use
$CustomMetadata.CustomMetadataTypeAPIName.RecordAPIName.FieldAPIName

Function A system-defined formula that can require input from you and returns a value or values. For example, TODAY() does not
require input but returns the current date. The TEXT(value) function requires your percent, number, or currency input and
returns text.

Operator A symbol that specifies the type of calculation to perform or the order in which to do it. For example, the + symbol specifies
two values should be added. The open and close parentheses specify which expressions you want evaluated first.

Comment An annotation within a formula that begins with a forward slash followed by an asterisk (/*). and concludes with an asterisk
followed by a forward slash (*/). For example,
/*This is a formula comment*/

Comments are ignored when processing a formula.

Comments are useful for explaining specific parts of a formula to anyone viewing the formula definition. For example:
AND(
/*competitor field is required, check to see if field is empty */
LEN(Competitor__c) = 0,
/* rule only enforced for ABCD record types */
RecordType.Name = "ABCD Value",
/* checking for any closed status, allows for additional closed picklist values
in the future */
CONTAINS(TEXT(StageName), "Closed")
)

387
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Element Description
Name
You can also use comments to comment out sections of your formula when debugging and checking the syntax to locate
errors in the formula.

Note:
• Nesting comments causes a syntax error. For example, you cannot save a formula that has the following:
/* /* comment */ */

• Commenting out a whole formula causes a syntax error.

• Comments count against the character and byte size limits in formulas.

Formula Operators and Functions by Context

Use these operators and functions when building formulas. All functions are available everywhere that you can include a formula, such
as formula fields, validation rules, approval processes, and workflow rules, unless otherwise specified.
Within an email template, merge fields can only be used in formula functions and operations when the merge field belongs to the record
that the email is related to. Otherwise, these fields don’t resolve.
Extraneous spaces in these samples are ignored.
• Math Operators
• Logical Operators
• Text Operators
• Date and Time Functions
• Logical Functions
• Math Functions
• Text Functions
• Summary Functions
• Advanced Functions

Math Operators

Operator Description
+ (Add) Calculates the sum of two values.

- (Subtract) Calculates the difference of two values.

* (Multiply) Multiplies its values.

/ (Divide) Divides its values.

^ (Exponentiation) Raises a number to the power of a specified number.

() (Open Parenthesis and Specifies that the expressions within the open parenthesis and close parenthesis are evaluated first. All
Closed Parenthesis) other expressions are evaluated using standard operator precedence.

388
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Logical Operators

Operator Description
= and == (Equal) Evaluates if two values are equivalent. The = and == operators are interchangeable.

<> and != (Not Equal) Evaluates if two values aren’t equivalent.

< (Less Than) Evaluates if a value is less than the value that follows this symbol.

> (Greater Than) Evaluates if a value is greater than the value that follows this symbol.

<= (Less Than or Equal) Evaluates if a value is less than or equal to the value that follows this symbol.

>= (Greater Than or Equal) Evaluates if a value is greater than or equal to the value that follows this symbol.

&& (And) Evaluates if two values or expressions are both true. Use this operator as an alternative to the logical
function AND.

|| (Or) Evaluates if at least one of multiple values or expressions is true. Use this operator as an alternative to
the logical function OR.

Text Operators

Operator Description
& and + (Concatenate) Connects two or more strings.

Date and Time Functions

Function Description
ADDMONTHS Returns the date that is the indicated number of months before or after a specified date. If the specified
date is the last day of the month, the resulting date is the last day of the resulting month. Otherwise,
the result has the same date component as the specified date.

DATE Returns a date value from the year, month, and day values that you enter. Salesforce displays an error
on the detail page if the value of the DATE function in a formula field is an invalid date, such as February
29 in a non-leap year.

DATEVALUE Returns a date value for a date/time or text expression.

DATETIMEVALUE Returns a year, month, day, and GMT time value.

DAY Returns a day of the month in the form of a number from 1 through 31.

DAYOFYEAR Returns the day of the calendar year in the form of a number from 1 through 366.

FORMATDURATION Formats the number of seconds with optional days, or the difference between times or dateTimes as
HH:MI:SS.

HOUR Returns the local time hour value without the date in the form of a number from 1 through 24.

389
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Function Description
ISOWEEK Returns the ISO 8601-week number, from 1 through 53, for the given date, ensuring that the first week
starts on a Monday.

ISOYEAR Returns the ISO 8601 week-numbering year in 4 digits for the given date, ensuring that the first day is
a Monday.

MILLISECOND Returns a milliseconds value in the form of a number from 0 through 999.

MINUTE Returns a minute value in the form of a number from 0 through 60.

MONTH Returns the month, a number between 1 and 12 (December) in number format of a given date.

NOW Returns a date/time representing the current moment.

SECOND Returns a seconds value in the form of a number from 0 through 60.

TIMENOW Returns a time value in GMT representing the current moment. Use this function instead of the NOW
function if you only want to track time, without a date.

TIMEVALUE Returns the local time value without the date, such as business hours.

TODAY Returns the current date as a date data type.

UNIXTIMESTAMP Returns the number of seconds since 1 Jan 1970 for the given date, or number of seconds in the day
for a time.

WEEKDAY Returns the day of the week for the given date, using 1 for Sunday, 2 for Monday, through 7 for Saturday.

YEAR Returns the four-digit year in number format of a given date.

Logical Functions

Function Description
AND Returns a TRUE response if all values are true, and returns a FALSE response if one or more values are
false.

BLANKVALUE Determines if an expression has a value, and returns a substitute expression if it doesn’t. If the expression
has a value, it returns the value of the expression.

CASE Checks a given expression against a series of values. If the expression is equal to a value, it returns the
corresponding result. If it isn’t equal to any values, it returns the else_result.

IF Determines if expressions are true or false. Returns a given value if true and another value if false.

ISBLANK Determines if an expression has a value, and returns TRUE if it doesn’t. If it contains a value, this function
returns FALSE.

ISCLONE Checks if the record is a clone of another record, and returns TRUE if one item is a clone. Otherwise,
returns FALSE.

ISNEW Checks if the formula is running during the creation of a new record, and returns TRUE if it is. If an existing
record is being updated, this function returns FALSE.

390
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Function Description
ISNULL Determines if an expression is null (blank), and returns TRUE if it is. If it contains a value, this function
returns FALSE.
You must use ISBLANK instead of ISNULL in new formulas. ISBLANK has the same functionality as ISNULL,
but also supports text fields. Salesforce continues to support ISNULL, so you don’t change any existing
formulas.

ISNUMBER Determines if a text value is a number, and returns TRUE if it is. Otherwise, it returns FALSE.

NOT Returns FALSE for TRUE and TRUE for FALSE.

NULLVALUE Determines if an expression is null (blank) and returns a substitute expression if it is. If the expression
isn’t blank, returns the value of the expression.
You must use BLANKVALUE instead of NULLVALUE in new formulas. BLANKVALUE has the same
functionality as NULLVALUE, but it also supports text fields. Salesforce continues to support NULLVALUE,
so changing the existing formulas isn’t necessary.

OR Determines if expressions are true or false. Returns TRUE if any expression is true, and returns FALSE if
all expressions are false.

PRIORVALUE Returns the previous value of a field.

Math Functions

Function Description
ABS Calculates the absolute value of a number. The absolute value of a number is the number without its
positive or negative sign.

ACOS Returns the arc cosign of the number in radians, if the given number is between -1 and 1. Otherwise,
returns NULL.

ASIN Returns the arc sine of the number in radians, if the given number is between -1 and 1. Otherwise,
returns NULL.

ATAN Returns the arc tangent of the number in radians.

ATAN2 Returns the arc tangent of the quotient of y and x in radians.

CEILING Rounds a number up to the nearest integer, away from zero if negative.

CHR Returns a string with the first character’s code point as the given number.

COS Returns the cosine of the number in radians, if the given number is between -1 and 1. Otherwise, returns
NULL.

DISTANCE Calculates the distance between two locations in miles or kilometers.

EXP Returns a value for e raised to the power of a number that you specify.

FLOOR Returns a number rounded down to the nearest integer, towards zero if negative.

FROMUNIXTIME Returns the datetime that represents the given number as the seconds elapsed since 1 Jan 1970.

391
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Function Description
GEOLOCATION Returns a geolocation based on the provided latitude and longitude. Must be used with the DISTANCE
function.

LN Returns the natural logarithm of a specified number. Natural logarithms are based on the constant e
value of 2.71828182845904.

LOG Returns the base 10 logarithm of a number.

MAX Returns the highest number from a list of numbers.

MCEILING Rounds a number up to the nearest integer, towards zero if negative.

MFLOOR Rounds a number down to the nearest integer, away from zero if negative.

MIN Returns the lowest number from a list of numbers.

MOD Returns a remainder after a number is divided by a specified divisor.

PI Returns pi.

PICKLISTCOUNT Returns the number of selected values in a multi-select picklist.

ROUND Returns the nearest number to a number that you specify, constraining the new number by a specified
number of digits.

SIN Returns the sine of the number, where the number is given in radians.

SQRT Returns the positive square root of a given number.

TAN Returns the tangent of the number, where the number is given in radians.

TRUNC Truncates a number to a specified number of digits.

Text Functions

Function Description
ASCII Returns the first character’s code point from the given string as a number.

BEGINS Determines if text begins with specific characters. Returns TRUE if it does, and returns FALSE if it doesn't.

BR Inserts a line break in a string of text.

CASESAFEID Converts a 15-character ID to a case-insensitive 18-character ID.

CONTAINS Compares two arguments of text, and returns TRUE if the first argument contains the second argument.
If not, returns FALSE.

FIND Returns the position of a string within a string of text represented as a number.

GETSESSIONID Returns the user’s session ID.

HTMLENCODE Encodes text and merge field values for use in HTML by replacing characters that are reserved in HTML,
such as the greater-than sign (>), with HTML entity equivalents, such as &gt;.

HYPERLINK Creates a link to a URL specified that is linkable from the text specified.

392
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Function Description
IMAGE Inserts an image with alternate text and height and width specifications.

INCLUDES Determines if any value selected in a multi-select picklist field equals a text literal that you specify.

INITCAP Returns the text as lowercase with the first character of each word in uppercase.

ISPICKVAL Determines if the value of a picklist field is equal to a text literal that you specify.

JSENCODE Encodes text and merge field values for use in JavaScript by inserting escape characters, such as a
backslash (\), before unsafe JavaScript characters, such as the apostrophe (').

JSINHTMLENCOD Encodes text and merge field values for use in JavaScript inside HTML tags by replacing characters that
are reserved in HTML with HTML entity equivalents and inserting escape characters before unsafe
JavaScript characters. JSINHTMLENCODE(someValue) is a convenience function that is equivalent
to JSENCODE(HTMLENCODE((someValue)). That is, JSINHTMLENCODE first encodes
someValue with HTMLENCODE, and then encodes the result with JSENCODE.

LEFT Returns the specified number of characters from the beginning of a text string.

LEN Returns the number of characters in a specified text string.

LOWER Converts all letters in the specified text string to lowercase. Any characters that aren’t letters are unaffected
by this function. Locale rules are applied if a locale is provided.

LPAD Inserts characters that you specify to the left-side of a text string.

MID Returns the specified number of characters from the middle of a text string given the starting position.

REVERSE Returns the characters of a source text string in reverse order.

RIGHT Returns the specified number of characters from the end of a text string.

RPAD Inserts characters that you specify to the right-side of a text string.

SUBSTITUTE Substitutes new text for old text in a text string.

TEXT Converts a percent, number, date, date/time, or currency type field into text anywhere formulas are
used. Also, converts picklist values to text in approval rules, approval step rules, workflow rules, escalation
rules, assignment rules, auto-response rules, validation rules, formula fields, field updates, and custom
buttons and links.

TRIM Removes the spaces and tabs from the beginning and end of a text string.

UPPER Converts all letters in the specified text string to uppercase. Any characters that aren’t letters are unaffected
by this function. Locale rules are applied if a locale is provided.

URLENCODE Encodes text and merge field values for use in URLs by replacing characters that are illegal in URLs, such
as blank spaces, with the code that represent those characters as defined in RFC 3986, Uniform Resource
Identifier (URI): Generic Syntax. For example, blank spaces are replaced with %20, and exclamation points
are replaced with %21.

VALUE Converts a text string to a number.

393
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Summary Functions
These functions are available with summary, matrix, and joined reports.

Function Description
PARENTGROUPVAL This function returns the value of a specified parent grouping. A “parent” grouping is any level above
the one containing the formula. You can use this function only in custom summary formulas and at
grouping levels for reports, but not at summary levels.

PREVGROUPVAL This function returns the value of a specified previous grouping. A “previous” grouping is one that comes
before the current grouping in the report. Choose the grouping level and increment. The increment is
the number of columns or rows before the current summary. The default is 1, the maximum is 12. You
can use this function only in custom summary formulas and at grouping levels for reports, but not at
summary levels.

Advanced Functions

Function Description
CURRENCYRATE Returns the conversion rate to the corporate currency for the given currency ISO code. If the currency
is invalid, returns 1.0.

GETRECORDIDS Returns an array of strings in the form of record IDs for the selected records in a list, such as a list view
or related list.

IMAGEPROXYURL Securely retrieves external images, and prevents unauthorized requests for user credentials.

INCLUDE Returns content from an s-control snippet. Use this function to reuse common code in many s-controls.

ISCHANGED Compares the value of a field to the previous value, and returns TRUE if the values are different. If the
values are the same, this function returns FALSE.

JUNCTIONIDLIST Returns a JunctionIDList based on the provided IDs.

LINKTO Returns a relative URL in the form of a link (href and anchor tags) for a custom s-control or Salesforce
page.

PREDICT Returns an Einstein Discovery prediction for a record based on the specified record ID or for a list of fields
and their values.

REGEX Compares a text field to a regular expression, and returns TRUE if there’s a match. Otherwise, it returns
FALSE. A regular expression is a string used to describe a format of a string according to certain syntax
rules.

REQUIRESCRIPT Returns a script tag with source for a URL that you specify. Use this function when referencing the
Lightning Platform AJAX Toolkit or other JavaScript toolkits.

URLFOR Returns a relative URL for an action, s-control, Visualforce page, or a file in a static resource archive in a
Visualforce page.

VLOOKUP Returns a value by looking up a related value on a custom object similar to the VLOOKUP() Excel function.

394
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

All Formula Operators and Functions

Use operators and functions when building formulas. All functions are available everywhere that you can include a formula such as
formula fields, validation rules, approval processes, and workflow rules, unless otherwise specified.

SEE ALSO:
Examples of Advanced Formula Fields
Time Custom Field

All Formula Operators and Functions

Use operators and functions when building formulas. All functions are available everywhere that you can include a formula such as
formula fields, validation rules, approval processes, and workflow rules, unless otherwise specified.

+ (Add)
Calculates the sum of two values.
- (Subtract)
Calculates the difference of two values.
* (Multiply)
Multiplies its values.
/ (Divide)
Divides its values.
^ (Exponentiation)
Raises a number to a power of a specified number.
() (Open Parenthesis and Close Parenthesis)
Specifies that the expressions within the open parenthesis and close parenthesis are evaluated first. All other expressions are evaluated
using standard operator precedence.
= and == (Equal)
Evaluates if two values are equivalent. The = and == operators are interchangeable.
<> and != (Not Equal)
Evaluates if two values aren’t equivalent.
< (Less Than)
Evaluates if a value is less than the value that follows this symbol.
> (Greater Than)
Evaluates if a value is greater than the value that follows this symbol.
<= (Less Than or Equal)
Evaluates if a value is less than or equal to the value that follows this symbol.
>= (Greater Than or Equal)
Evaluates if a value is greater than or equal to the value that follows this symbol.
&& (AND)
Evaluates if two values or expressions are both true. Use this operator as an alternative to the logical function AND.
|| (OR)
Evaluates if at least one of multiple values or expressions is true. Use this operator as an alternative to the logical function OR.

395
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

& and + (Concatenate)

Connects two or more strings.
ABS
Calculates the absolute value of a number. The absolute value of a number is the number without its positive or negative sign.
ADDMONTHS
Returns the date that is the indicated number of months before or after a specified date. If the specified date is the last day of the
month, the resulting date is the last day of the resulting month. Otherwise, the result has the same date component as the specified
date.
AND
Returns a TRUE response if all values are true; returns a FALSE response if one or more values are false.
BEGINS
Determines if text begins with specific characters and returns TRUE if it does. Returns FALSE if it doesn't.
BLANKVALUE
Determines if an expression has a value and returns a substitute expression if it doesn’t. If the expression has a value, returns the
value of the expression.
BR
Inserts a line break in a string of text.
CASE
Checks a given expression against a series of values. If the expression is equal to a value, returns the corresponding result. If it isn't
equal to any values, it returns the else_result.
CASESAFEID
Converts a 15-character ID to a case-insensitive 18-character ID. In Salesforce Classic, the function converts only valid Salesforce
15-character IDs. If you pass in an invalid ID, the function returns the ID passed in. In Lightning Experience, the function converts
any 15-character ID.
CEILING
Rounds a number up to the nearest integer, away from zero if negative.
CONTAINS
Compares two arguments of text and returns TRUE if the first argument contains the second argument. If not, returns FALSE.
CURRENCYRATE
Returns the conversion rate to the corporate currency for the given currency ISO code. If the currency is invalid, returns 1.0.
DATE
Returns a date value from year, month, and day values you enter. Salesforce displays an error on the detail page if the value of the
DATE function in a formula field is an invalid date, such as February 29 in a non-leap year.
DATEVALUE
Returns a date value for a date/time or text expression.
DATETIMEVALUE
Returns a year, month, day, and GMT time value.
DAY
Returns a day of the month in the form of a number between 1 and 31.
DISTANCE
Calculates the distance between two locations in miles or kilometers.

396
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

EXP
Returns a value for e raised to the power of a number you specify.
FIND
Returns the position of a string within a string of text represented as a number.
FLOOR
Returns a number rounded down to the nearest integer, towards zero if negative.
GEOLOCATION
Returns a geolocation based on the provided latitude and longitude. Must be used with the DISTANCE function.
GETRECORDIDS
Returns an array of strings in the form of record IDs for the selected records in a list, such as a list view or related list.
GETSESSIONID
Returns the user’s session ID.
HOUR
Returns the local time hour value without the date in the form of a number from 1 through 24.
HTMLENCODE
Encodes text and merge field values for use in HTML by replacing characters that are reserved in HTML, such as the greater-than
sign (>), with HTML entity equivalents, such as &gt;.
HYPERLINK
Creates a link to a URL specified that is linkable from the text specified.
IF
Determines if expressions are true or false. Returns a given value if true and another value if false.
IMAGE
Inserts an image with alternate text and height and width specifications.
IMAGEPROXYURL
Securely retrieves external images and prevents unauthorized requests for user credentials.
INCLUDE
Returns content from an s-control snippet. Use this function to reuse common code in many s-controls.
INCLUDES
Determines if any value selected in a multi-select picklist field equals a text literal you specify.
ISBLANK
Determines if an expression has a value and returns TRUE if it does not. If it contains a value, this function returns FALSE.
ISCHANGED
Compares the value of a field to the previous value and returns TRUE if the values are different. If the values are the same, this function
returns FALSE.
ISCLONE
Checks if the record is a clone of another record and returns TRUE if one item is a clone. Otherwise, returns FALSE.
ISNEW
Checks if the formula is running during the creation of a new record and returns TRUE if it is. If an existing record is being updated,
this function returns FALSE.
ISNULL
Determines if an expression is null (blank) and returns TRUE if it is. If it contains a value, this function returns FALSE.

397
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

ISNUMBER
Determines if a text value is a number and returns TRUE if it is. Otherwise, it returns FALSE.
ISPICKVAL
Determines if the value of a picklist field is equal to a text literal you specify.
JSENCODE
Encodes text and merge field values for use in JavaScript by inserting escape characters, such as a backslash (\), before unsafe
JavaScript characters, such as the apostrophe (').
JSINHTMLENCODE
Encodes text and merge field values for use in JavaScript inside HTML tags by replacing characters that are reserved in HTML with
HTML entity equivalents and inserting escape characters before unsafe JavaScript characters.
JUNCTIONIDLIST
Returns a JunctionIDList based on the provided IDs.
LEFT
Returns the specified number of characters from the beginning of a text string.
LEN
Returns the number of characters in a specified text string.
LINKTO
Returns a relative URL in the form of a link (href and anchor tags) for a custom s-control or Salesforce page.
LN
Returns the natural logarithm of a specified number. Natural logarithms are based on the constant e value of 2.71828182845904.
LOG
Returns the base 10 logarithm of a number.
LOWER
Converts all letters in the specified text string to lowercase. Any characters that are not letters are unaffected by this function. Locale
rules are applied if a locale is provided.
LPAD
Inserts characters you specify to the left-side of a text string.
MAX
Returns the highest number from a list of numbers.
MCEILING
Rounds a number up to the nearest integer, towards zero if negative.
MFLOOR
Rounds a number down to the nearest integer, away from zero if negative.
MID
Returns the specified number of characters from the middle of a text string given the starting position.
MILLISECOND
Returns a milliseconds value in the form of a number from 0 through 999.
MIN
Returns the lowest number from a list of numbers.
MINUTE
Returns a minute value in the form of a number from 0 through 60.

398
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

MOD
Returns a remainder after a number is divided by a specified divisor.
MONTH
Returns the month, a number between 1 (January) and 12 (December) in number format of a given date.
NOT
Returns FALSE for TRUE and TRUE for FALSE.
NOW
Returns a date/time representing the current moment.
NULLVALUE
Determines if an expression is null (blank) and returns a substitute expression if it is. If the expression is not blank, returns the value
of the expression.
OR
Determines if expressions are true or false. Returns TRUE if any expression is true. Returns FALSE if all expressions are false.
PARENTGROUPVAL
This function returns the value of a specified parent grouping. A “parent” grouping is any level above the one containing the formula.
PREDICT
Returns an Einstein Discovery prediction for a record based on the specified record ID or for a list of fields and their values.
PREVGROUPVAL
This function returns the value of a specified previous grouping. A “previous” grouping is one that comes before the current grouping
in the report.
PRIORVALUE
Returns the previous value of a field.
REGEX
Compares a text field to a regular expression and returns TRUE if there is a match. Otherwise, it returns FALSE.
REQUIRESCRIPT
Returns a script tag with source for a URL you specify. Use this function when referencing the Lightning Platform AJAX Toolkit or
other JavaScript toolkits.
REVERSE
Returns the characters of a source text string in reverse order.
RIGHT
Returns the specified number of characters from the end of a text string.
ROUND
Returns the nearest number to a number you specify, constraining the new number by a specified number of digits.
RPAD
Inserts characters that you specify to the right-side of a text string.
SECOND
Returns a seconds value in the form of a number from 0 through 60.
SQRT
Returns the positive square root of a given number.
SUBSTITUTE
Substitutes new text for old text in a text string.

399
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

TEXT
Converts a percent, number, date, date/time, or currency type field into text anywhere formulas are used. Also, converts picklist
values to text in approval rules, approval step rules, workflow rules, escalation rules, assignment rules, auto-response rules, validation
rules, formula fields, field updates, and custom buttons and links.
TIMENOW
Returns a time value in GMT representing the current moment. Use this function instead of the NOW function if you only want to
track time, without a date.
TIMEVALUE
Returns the local time value without the date, such as business hours.
TODAY
Returns the current date as a date data type.
TRIM
Removes the spaces and tabs from the beginning and end of a text string.
UPPER
Converts all letters in the specified text string to uppercase.
URLENCODE
Encodes text and merge field values for use in URLs by replacing characters that are illegal in URLs, such as blank spaces, with the
code that represent those characters as defined in RFC 3986, Uniform Resource Identifier (URI): Generic Syntax.
URLFOR
Returns a relative URL for an action, s-control, Visualforce page, or a file in a static resource archive in a Visualforce page.
VALUE
Converts a text string to a number.
VLOOKUP
Returns a value by looking up a related value on a custom object similar to the VLOOKUP() Excel function. This function is only
available in validation rules.
WEEKDAY
Returns the day of the week for the given date, using 1 for Sunday, 2 for Monday, through 7 for Saturday.
YEAR
Returns the four-digit year in number format of a given date.

+ (Add)
Calculates the sum of two values.

Use
value1 + value2 and replace each value with merge fields, expressions, or other numeric values.

Note: If the values are text, the + concatenates.

Example: Formula Field Example

Amount + Maint_Amount__c + Services_Amount__c
This formula calculates the sum of the product Amount, maintenance amount, and services fees. Maint amount and
Service Fees are custom currency fields.

400
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Report Example

EMAIL_OPT_OUT:SUM + DO_NOT_CALL:SUM calculates all Email Opt Out fields plus all Do Not Call fields on the leads
in your report. This formula is a number data type that returns a positive integer.

Example: Validation Rule Example

Let’s say you have a custom object that allows users to track the total number of hours worked in a week. Use the following example
to ensure that users can’t save a time card record with more than 40 hours in a work week.
Monday_Hours__c +
Tuesday_Hours__c +
Wednesday_Hours__c +
Thursday_Hours__c +
Friday_Hours__c > 40

Use a formula like this one in a validation rule to display the following error message when the total number of hours entered for
each work day is greater than 40: “Your total hours can’t exceed 40.” This example requires five custom fields on your custom
object, one for each day of work.

- (Subtract)
Calculates the difference of two values.

Use
value1 - value2 and replace each value with merge fields, expressions, or other numeric values.

Example: Calculate Difference Example

This formula calculates the difference of the product Amount less the Discount Amount. Discount Amount is a custom currency
field.
Amount - Discount_Amount__c

Example: Report Example

AMOUNT:SUM - Product.Discount_Amount__c:SUM calculates the difference of all Amount fields and all Discounted
Amount custom fields on the products in your report. This formula is a currency data type that returns a currency sign and decimal
places.

* (Multiply)
Multiplies its values.

Use
value1 * value2 and replace each value with merge fields, expressions, or other numeric values.

Example: Consulting Days Example

This formula calculates the number of consulting days times 1200 given that this formula field is a currency data type and consulting
charges a rate of $1200 per day. Consulting Days is a custom field.
Consulting_Days__c * 1200

401
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Report Example

RowCount * AGE:AVG calculates the record count times the average age value of your report. This formula is a number data
type that returns a positive or negative integer or decimal.

/ (Divide)
Divides its values.
EDITIONS

Use Available in:

value1 / value2 and replace each value with merge fields, expressions, or other numeric
values.

Example: Revenue Amount

AnnualRevenue/ NumberOfEmployees
This formula calculates the revenue amount per employee using a currency field.
IF(NumberOfOpportunities > 0,
NumberOfWonOpportunities / NumberOfOpportunities, null)

Example: % Won Opportunities Example

WON:SUM / RowCount calculates the percent of Won opportunities using a record count representing the number of all
opportunities in your report. This formula is a number data type that returns a positive or negative integer.

Example: % Difference between Cost and Sales Price Example

(TOTAL_PRICE:SUM - QUANTITY:SUM * Product2.Cost__c:SUM) / (QUANTITY:SUM *
Product2.Cost__c:SUM) calculates the average percent difference between what a product costs and its selling price on
a product-by-product level. Product2.Cost__c:SUM is a custom currency field named Cost on products, which includes
the cost of each product. This formula is a percent data type that returns a positive or negative integer. For best results, use this
formula on a summary Opportunities with Products report that is summarized by Product Name and includes summary totals for
Quantity, Total Price, and Cost.

^ (Exponentiation)
Raises a number to a power of a specified number.

Use
number^integer and replace number with a merge field, expression, or another numeric value; replace integer with a merge
field that contains an integer, expression, or any integer.

Tips
Avoid replacing integer with a negative number.

Example: Number of Employees Example

NumberOfEmployees^4 calculates the number of employees to the 4th power.

402
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Report ExampleACTIVE:SUM ^ 2 calculates the number of active Salesforce users to the 2nd power for
administration. This formula is a number data type that returns a positive integer.

() (Open Parenthesis and Close Parenthesis)

Specifies that the expressions within the open parenthesis and close parenthesis are evaluated first. All other expressions are evaluated
using standard operator precedence.

Use
(expression1) expression2... and replace each expression with merge fields, expressions, or other numeric values.

Example: Subtraction and Division Example

(Unit_Value__c - Old_Value__c) / New_Value__c calculates the difference between the old value and new
value divided by the new value.

Example: Report Example

(DURATIONHOURS:SUM * RowCount) / 24 calculates the duration of all event times the record count per 24 hours.
This formula is a percent data type that returns a positive or negative integer or decimal, representing what percent of a day is
spent on events.

= and == (Equal)
Evaluates if two values are equivalent. The = and == operators are interchangeable.

Important: Don’t use this function for a null comparison, such as MyDateTime__c == null. Use ISBLANK instead.

Use
expression1=expression2 or expression1 == expression2, and replace each expression with merge fields,
expressions, or other numeric values.

Example: Due Date Example

Due Date = CreatedDate + 5 returns true if the due date is equal to five days following a record’s created date.

Example: Commission Amount Example

IF(Probability =1, ROUND(Amount*0.02, 2), 0)

This formula calculates the 2% commission amount of an opportunity that has a probability of 100%. All other opportunities have
a commission value of 0.
Possible results:
• An opportunity with a Probability of 90% has a commission of 0.
• An opportunity with a Probability of 100% and an Amount of $100,000 has a commission of $2,000.

<> and != (Not Equal)

Evaluates if two values aren’t equivalent.

403
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Description: Evaluates if two values aren’t equivalent.

Use: expression1 <> expression2 or expression1 != expression2, and replace

each expression with merge fields, expressions, or other numeric values.

Example:
IF(Maint_Amount__c + Services_Amount__c<> Amount,
"DISCOUNTED", "FULL PRICE")

This formula displays DISCOUNTED on product if its maintenance amount and services amount
don’t equal the product amount. Otherwise, displays FULL PRICE. Note that this example uses two
custom currency fields for Maint Amount and Services Amount.

Important: Don’t use this function for a null comparison, such as MyDateTime__c != null. Use ISBLANK instead.

Use
expression1 <> expression2 or expression1 != expression2, and replace each expression with merge
fields, expressions, or other numeric values.

Example: Discount Example

IF(Maint_Amount__c + Services_Amount__c<> Amount,
"DISCOUNTED", "FULL PRICE")

This formula displays DISCOUNTED on product if its maintenance amount and services amount don’t equal the product amount.
Otherwise, displays FULL PRICE. Note that this example uses two custom currency fields for Maint Amount and Services Amount.

< (Less Than)

Evaluates if a value is less than the value that follows this symbol.

Use
Evaluates if a value is less than the value that follows this symbol.

Example: Revenue ExampleIF(AnnualRevenue < 1000000, 1, 2) assigns the value 1 with revenues less than
one million and the value 2 to revenues greater than one million.

> (Greater Than)

Evaluates if a value is greater than the value that follows this symbol.

Use
value1 > value2 and replace each value with merge fields, expressions, or other numeric values.

Example: Net Worth ExampleIF(commission__c > 1000000, "High Net Worth", "General") assigns
the High Net Worth value to a commission greater than one million. Note, this is a text formula field that uses a commission custom
field.

404
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

<= (Less Than or Equal)

Evaluates if a value is less than or equal to the value that follows this symbol.

Use
value1 <= value2 and replace each value with merge fields, expressions, or other numeric values.

Example: Revenue Example

IF(AnnualRevenue <= 1000000, 1, 2) assigns the value 1 with revenues less than or equal to one million and the
value 2 with revenues greater than one million.

>= (Greater Than or Equal)

Evaluates if a value is greater than or equal to the value that follows this symbol.

Use
value1 >= value2 and replace each value with merge fields, expressions, or other numeric values.

Example: Commission Example

IF(Commission__c >= 1000000, "YES", "NO") assigns the YES value with a commission greater than or equal
to one million. Note, this is a text formula field that uses a custom currency field called Commission.

&& (AND)
Evaluates if two values or expressions are both true. Use this operator as an alternative to the logical function AND.

Use
(logical1) && (logical2) and replace logical1 and logical2 with the values or expressions that you want evaluated.

Example: Generic Example

IF((Price<100 && Quantity<5),"Small", null)
This formula displays Small if the price is less than 100 and quantity is less than five. Otherwise, this field is blank.

|| (OR)
Evaluates if at least one of multiple values or expressions is true. Use this operator as an alternative to the logical function OR.

Use
(logical1) || (logical2) and replace any number of logical references with the values or expressions you want evaluated.

Example: Case Example

IF((ISPICKVAL(Priority, "High")) || (ISPICKVAL(Status , "New")),
ROUND(NOW()-CreatedDate, 0), null)
This formula returns the number of days a case has been open if the Status is new or the Priority is high. If the case was opened
today, this field displays a zero.

405
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Validation Rule Example

(Discount_Rate__c < 0) || (Discount_Rate__c > 0.40)

This validation rule formula displays the following error message when the Discount Rate custom field isn’t between 0 and 40%:
"Discount Rate cannot exceed 40%."

& and + (Concatenate)

Connects two or more strings.

Use
string1&string2 and replace each string with merge fields, expressions, or other values.

Example: Trip Expense Example

"Expense-" & Trip_Name__c & "-" & ExpenseNum__c
This formula displays the text Expense- followed by trip name and the expense number. This is a text formula field that uses
an expense number custom field.

ABS
Calculates the absolute value of a number. The absolute value of a number is the number without its positive or negative sign.

Use
ABS(number) and replace number with a merge field, expression, or other numeric value that has the sign you want removed.

Example: Revenue Example

ABS(ExpectedRevenue) calculates the positive value of the Expected Revenue amount regardless of whether it’s
positive or negative.

ADDMONTHS
Returns the date that is the indicated number of months before or after a specified date. If the specified date is the last day of the month,
the resulting date is the last day of the resulting month. Otherwise, the result has the same date component as the specified date.

Use
ADDMONTHS (date, num) and replace date with the start date and num with the number of months to be added.

Example: Generic ExampleADDMONTHS (StartDate, 5)

Adds 5 months to the start date. For example, if the start date is September 20, 2017, the resulting date is February 20, 2018, If the
start date is September 30, 2017, the resulting date is February 28, 2018.

AND
Returns a TRUE response if all values are true; returns a FALSE response if one or more values are false.
Use the && (AND) function as an alternative to the operator.

406
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
AND(logical1,logical2,...) and replace logical1,logical2,... with the values that you want evaluated.

Example: Formula Field Example

IF(AND(Price<1,Quantity<1),"Small", null)
This formula displays Small if the price and quantity are less than one. This field is blank if the asset has a price or quantity greater
than one.

BEGINS
Determines if text begins with specific characters and returns TRUE if it does. Returns FALSE if it doesn't.

Use
BEGINS(text, compare_text) and replace text, compare_text with the characters or fields you want to compare.

Tips
• This function is case-sensitive so be sure your compare_text value has the correct capitalization.
• When using this function in a validation rule or workflow rule, fields that are blank are considered valid. For example, if you have a
validation rule that tests to see if the serial number of an asset begins with “3,” all assets that have a blank serial number are considered
valid.

Example: Generic Example

IF(BEGINS (Product_type__c, "ICU"), "Medical", "Technical")
This example returns the text Medical if the text in any Product Type custom text field begins with ICU. For all other products,
it displays Technical.

BLANKVALUE
Determines if an expression has a value and returns a substitute expression if it doesn’t. If the expression has a value, returns the value
of the expression.

Use
BLANKVALUE(expression, substitute_expression) and replace expression with the expression you want
evaluated; replace substitute_expression with the value you want to replace any blank values.

Tips
• Use BLANKVALUE instead of NULLVALUE in new formulas. BLANKVALUE has the same functionality as NULLVALUE, but also supports
text fields. Salesforce continues to support NULLVALUE, so you don’t need to change existing formulas.
• A field is not empty if it contains a character, blank space, or zero. For example, a field that contains a space inserted with the spacebar
is not empty.
• Use the BLANKVALUE function to return a specified string if the field doesn't have a value; use the ISBLANK function if you only want
to check if the field has a value.
• If you use this function with a numeric field, the function only returns the specified string if the field doesn't have a value and isn't
configured to treat blank fields as zeroes.

407
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Formula Example

BLANKVALUE(Department, “Undesignated”)
This formula returns the value of the Department field if the Department field contains a value. If the Department field is empty,
this formula returns the word Undesignated.
(BLANKVALUE(Payment_Due_Date__c, StartDate +5)
This formula returns the date five days after the contract start date whenever Payment Due Date is blank. Payment Due Date is a
custom date field.

BR
Inserts a line break in a string of text.

Use
BR()

Tips
• Don't remove the parentheses after the function name.
• Keep the parentheses empty. They don't contain values.
• Remember to surround the BR() with concatenation operators: & or +.
• Avoid using this function in mail merge templates.
• This function isn't available in custom buttons and links, s-controls, or reports.

Example: Formula Example

CASE(ShippingCountry,
"USA",
ShippingStreet & BR() &
ShippingCity & ",
" & ShippingState & " " &
ShippingPostalCode & BR()
& ShippingCountry,
"France",
ShippingStreet & BR() &
ShippingPostalCode & " " &
ShippingCity & BR() &
ShippingCountry, "etc")

This formula field displays a formatted mailing address for a contact in standard format, including spaces and line breaks where
appropriate depending on the country.

CASE
Checks a given expression against a series of values. If the expression is equal to a value, returns the corresponding result. If it isn't equal
to any values, it returns the else_result.

408
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
CASE(expression,value1, result1, value2, result2,..., else_result) and replace expression
with the field or value you want compared to each specified value. Replace each value and result with the value that must be equivalent
to return the result entry. Replace else_result with the value you want returned when the expression doesn't equal any values.

Tips
• Be sure your value1, value2... expressions are the same data type.
• Be sure your result1, result2... expressions are the same data type.
• CASE functions can’t contain functions that return true or false. Instead, make true or false expressions return numbers such as:
CASE(1, IF(ISPICKVAL (Term__c, "12"), 1, 0),
12 * Monthly_Commit__c,
IF(ISPICKVAL(Term__c, "24"), 1, 0),
24 * Monthly_Commit__c, 0)

In this formula, Term is a picklist field that is multiplied by the Monthly Commit whenever it contains the value 1 for true.

• The else_result value is required.

• CASE functions return an error whenever any of the expressions return an error, regardless of which one should be returned. For
example, CASE(Field__c,"Partner", "P", "Customer", "C", LEFT(Field__c, -5)) returns an error
even if the value of the field is “Partner” or “Customer” because the last statement is illogical.
• If the field in your CASE function is blank, it returns your else_result value. For example, this formula: CASE(Days_Open__c,
3, "Reassign", 2, "Assign Task", "Maintain") displays Maintain if the Days Open field is blank, 0, or any
value other than 2 or 3.
• Use CASE functions to determine if a picklist value is equal to a particular value. For example the formula CASE(Term__c,
"12", 12 * Monthly_Commit__c, "24", 24 * Monthly_Commit__c, 0) multiplies the Monthly Commit
amount by 12 whenever the Term is 12 or multiplies the Monthly Commit amount by 24 whenever the Term is 24. Otherwise, the
result is zero.

Example: Formula Field Example: Days Open for Cases

Use this example of a custom formula field called Days Open to display different text depending on the number of days a case has
been open:
CASE(Days_Open__c, 3,
"Reassign", 2, "Assign Task", "Maintain")

The following text is displayed:

• “Reassign” for any case open three days.
• “Assign Task” for any case open two days.
• “Maintain” for all other cases.

Example: Formula Field Example: Last Activity Month

This formula field displays the month of the last activity or None if there are no activities.
CASE(MONTH(LastActivityDate),
1, "January",
2, "February",
3, "March",
4, "April",

409
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

5, "May",
6, "June",
7, "July",
8, "August",
9, "September",
10, "October",
11, "November",
12, "December",
"None")

Example: Default Value Example: Discount Rate

Use the following default value formula to insert a different discount rate on an opportunity based on the department of the
person creating the opportunity:
CASE(User.Department, "IT", 0.25, "Field", 0.15, 0)

In this example, the formula inserts a discount rate of 25% on any opportunity created by a user in the IT department or 15% on
any opportunity created by someone in the Field department. A zero is applied if the creator doesn't belong to either of these
departments. This is a custom percent field on opportunities that uses the standard user field Department.

Example: Default Value Example: Product Language

You might want to associate a product with its language so that your users know the type of documentation or adapter to include.
Use the following default value formula to automatically set the language of a product based on the country of the user creating
the product. In this example, the default value is Japanese if the user's country is Japan and English if the user's country is US. If
neither is true, the default value unknown is inserted into the Product Language field.
CASE($User.Country , "Japan", "Japanese", "US", "English","unknown")

CASESAFEID
Converts a 15-character ID to a case-insensitive 18-character ID. In Salesforce Classic, the function converts only valid Salesforce 15-character
IDs. If you pass in an invalid ID, the function returns the ID passed in. In Lightning Experience, the function converts any 15-character ID.

Use
CASESAFEID(id) and replace id with the object’s ID.

Tips
• Convert to 18-character IDs for better compatibility with Excel.
• The CASESAFEID function is available everywhere that you can define a formula except reports and s-controls.
• If you’re using Lightning Experience, and you want the function to convert only valid 15-character IDs, contact Salesforce Customer
Support to enable this functionality.

Example: Formula Example in Salesforce Classic

CASESAFEID (Id)

This formula replaces the 15-character ID with the 18-character, case-insensitive ID.
• CASESAFEID('A01xx000003DHur') returns A01xx000003DHur. The ID isn’t valid because it begins with a capital
letter.

410
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• CASESAFEID('001xx000003DHur') returns something like 001xx000003DHurAAG because the ID passed in

is valid.

CEILING
Rounds a number up to the nearest integer, away from zero if negative.

Use
CEILING(number) and replace number with the field or expression you want rounded.

Example: Formula Example

CEILING(2.5) returns 3, which is 2.5 rounded up to the nearest integer.
CEILING(-2.5) returns -3, which is -2.5 rounded away from zero for a negative number.

CONTAINS
Compares two arguments of text and returns TRUE if the first argument contains the second argument. If not, returns FALSE.

Use
CONTAINS(text, compare_text) and replace text with the text that contains the value of compare_text.

Tips
• This function is case-sensitive so be sure your compare_text value has the correct capitalization.
• When using this function in a validation rule or workflow rule, fields that are blank are considered valid. For example, if you have a
validation rule that tests to see if the serial number of an asset contains “A,” all assets that have a blank serial number are considered
valid.
• The CONTAINS function doesn't support multi-select picklists. Use INCLUDES to see if a multi-select picklist has a specific value.

Example: Formula Example

IF(CONTAINS(Product_Type__c, "part"), "Parts", "Service")

This formula checks the content of a custom text field named Product_Type and returns Parts for any product with the
word “part” in it. Otherwise, it returns Service. Note that the values are case-sensitive, so if a Product_Type field contains the
text “Part” or “PART,” this formula returns Services.

CURRENCYRATE
Returns the conversion rate to the corporate currency for the given currency ISO code. If the currency is invalid, returns 1.0.

Use
CURRENCYRATE(currency_ISO_code) and replace currency_ISO_code with a currency ISO code, such as “USD”.

Example: Function ExampleCURRENCYRATE(”USD”) returns the conversion rate to US dollars.

411
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

DATE
Returns a date value from year, month, and day values you enter. Salesforce displays an error on the detail page if the value of the DATE
function in a formula field is an invalid date, such as February 29 in a non-leap year.

Use
DATE(year,month,day) and replace year with a four-digit year, month with a two-digit month, and day with a two-digit
day.

Example: Formula ExampleDATE(2005, 01, 02) creates a date field of January 2, 2005.

DATEVALUE
Returns a date value for a date/time or text expression.
As of Winter ’20, the DATAVALUE() formula option provides more accurate daylight savings time values without workarounds. The option
avoids an existing one-hour discrepancy when processing times between 11:00 PM and 1:00 AM. From Setup, in the Quick Find box,
enter Company Information. Under Locale Settings, select Improve DATEVALUE() accuracy for DST.

Important: If your org's custom formulas include workarounds that adjust date values between 11:00 PM and 1:00 AM, remove
them before enabling this setting. If you don't remove the workarounds, your data could be inaccurate. Enabling the preference
can also increase the compiled size of existing formulas with the DATEVALUE() function.

Use
DATEVALUE(expression) and replace expression with a date/time or text value, merge field, or expression.

Tips
• If the field referenced in the function isn't a valid text or date/time field, the formula field displays #ERROR!
• When entering a date, surround the date with quotes and use the following format: YYYY-MM-DD, that is, a four-digit year, two-digit
month, and two-digit day.
• If the expression doesn't match valid date ranges, such as the MM isn't between 01 and 12, the formula field displays #ERROR!
• Dates and times are always calculated using the user’s time zone, except in list views, reports, and related lists. These items calculate
dates and times using Coordinated Universal Time.

Example: Closed Date Example

DATEVALUE(ClosedDate) displays a date field based on the value of the Date/Time Closed field.

Example: Date Value Example

DATEVALUE("2005-11-15") returns November 15, 2005 as a date value.

DATETIMEVALUE
Returns a year, month, day, and GMT time value.

Use
DATETIMEVALUE(expression) and replace expression with a date/time or text value, merge field, or expression.

412
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips
• DATETIMEVALUE is always calculated using GMT time zone and can’t be changed.
• When entering a specific date, surround the date with quotes and use the following format: YYYY-MM-DD, that is, a four-digit year,
two-digit month, and two-digit day.
• If the expression doesn't match valid date ranges, such as the MM isn't between 01 and 12, the formula field displays #ERROR!

Example: Closed Date Example

DATETIMEVALUE(ClosedDate) displays a date field based on the value of the Date/Time Closed field.

Example: Date Value Example

DATETIMEVALUE("2005-11-15 17:00:00") returns November 15, 2005 5:00 PM GMT as a date and time value.

DAY
Returns a day of the month in the form of a number between 1 and 31.

Use
DAY(date) and replace date with a date field or value such as TODAY().

Example: Formula ExampleDAY(Code_Freeze__c) returns the day in your custom code freeze date. Note this doesn't
work on date/time fields.

DISTANCE
Calculates the distance between two locations in miles or kilometers.

Use
DISTANCE(mylocation1, mylocation2, 'unit') and replace mylocation1 and mylocation2 with two
location fields, or a location field and a value returned by the GEOLOCATION function. Replace unit with mi (miles) or km (kilometers).

Tips
• The DISTANCE function returns a number data type. Distance is always calculated in decimals, even if you’re displaying the geolocation
notation in degrees, minutes, and seconds in the user interface. Specify the number of decimal places to show when you create a
custom field.
• The DISTANCE function isn’t available in reports, but it can be used in list views. To use DISTANCE in your reports, set up a formula
field, and then reference the field in your reports.
• DISTANCE is the only formula function that can use GEOLOCATION parameters.
• There are limitations on DISTANCE accuracy and equality calculations.
– DISTANCE supports only the logical operators > and <, returning values within (<) or beyond (>) a specified radius.
– Distance is calculated as a straight line, regardless of geography and topography between the two points.
For more details, see “How SOQL Calculates and Compares Distances” in the SOQL and SOSL Reference.

Example: Example: Distance Between Two Geolocation Fields

DISTANCE(warehouse_location__c, store_location__c, 'mi')

413
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

This formula returns the distance, in miles, between the warehouse and the store. In this example, warehouse_location__c
and store_location__c are the names of two custom geolocation fields.

Example: Example: Distance Between an Address Field and a Geolocation Field

DISTANCE(BillingAddress, store_location__c, 'mi')
This formula returns the distance, in miles, between an account’s billing address and a store. In this example, BillingAddress
is the standard billing address field on an Account object, and store_location__c is the name of a custom geolocation
field.

Example: Example: Distances with Conditions

IF(DISTANCE(warehouse_location__c, ShippingAddress, 'mi')<10, "Near", "Far")
This formula updates a text formula field to Near if the distance between the warehouse and the account shipping address
compound field is less than 10 miles. Otherwise, it updates the text field to Far.

Tip: Although DISTANCE can be calculated in miles or kilometers, the unit isn't returned in the calculation. If possible, include
the unit of measure in the name of your distance formula field, so users know whether the distance is in miles or kilometers.

EXP
Returns a value for e raised to the power of a number you specify.

Use
EXP(number) and replace number with a number field or value such as 5.

Example: Exponent of a Literal Value Example

EXP(3)
This formula returns the value of e to the third power.

Example: Compound Interest Example

Principal__c * EXP(Rate__c * Years__c)
This formula calculates the compound interest based on a custom currency field for principal, custom percent field for rate, and
custom number field for years.

FIND
Returns the position of a string within a string of text represented as a number.

Use
FIND(search_text, text[, start_num]) and replace search_text with the string you want to find, replace text
with the field or expression you want to search, and replace start_num with the number of the character from which to start searching
from left to right.

Tips
• Be sure to remove the brackets, [ and ], from your formula before validating it.

414
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• If the field referenced in your text parameter is blank, the formula field displays 0.
• Your search_text parameter is case-sensitive and can't contain any wildcard characters.
• If your search doesn't return any results, a 0 displays in the field.
• The start_num parameter is optional. If you don't enter a start_num value, the formula uses the value one, or the first
character in the string.
• If your start_num isn't greater than zero, a 0 displays in the field.
• If your start_num is greater than the length of the text, a 0 displays in the field.
• When entering your start_num parameter, remember that some fields like the Website field are unique because a http://
is automatically appended to the beginning of the text you enter.
• The first character in a string is designated as one rather than zero.

Example: Street Address Example

FIND(" ", Street) returns the character position of the first space in the Street field. You can use this number to find
out the length of the street address as a means of separating a street address from street name in an address field.

Example: Deriving Website Addresses Example

SUBSTITUTE(Email, LEFT(Email, FIND("@", Email)), "www.") finds the location of the @ sign in a
person's email address to determine the length of text to replace with a “www.” as a means of deriving their website address.

FLOOR
Returns a number rounded down to the nearest integer, towards zero if negative.

Use
FLOOR(number) and replace number with a number field or value such as 5.245.

Example: Example
FLOOR(2.5) returns 2, which is 2.5 rounded down to the nearest integer.
FLOOR(-2.5) returns -2, which is -2.5 rounded towards zero for a negative number.

GEOLOCATION
Returns a geolocation based on the provided latitude and longitude. Must be used with the DISTANCE function.

Use
GEOLOCATION(latitude, longitude) and replace latitude and longitude with the corresponding geolocation,
numerical code values.

Tips
• The GEOLOCATION function returns a location data type that can be used only by, and must be used with, the DISTANCE function.
The GEOLOCATION function doesn’t work on its own.

Example: Example: Distance Between a Custom Geolocation Field and Fixed Coordinates
DISTANCE(warehouse_location__c, GEOLOCATION(37.775,-122.418), 'km')

415
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

This formula returns the distance, in kilometers, between the warehouse and the known latitude and longitude 37.775°, -122.418°
(San Francisco).

GETRECORDIDS
Returns an array of strings in the form of record IDs for the selected records in a list, such as a list view or related list.

Use
{!GETRECORDIDS(object_type)} and replace object_type with a reference to the custom or standard object for the
records you want to retrieve.

Tips
• Use global variables to access special merge fields for s-controls, custom buttons, and links.
• Activities are special types of objects. Use {!GETRECORDIDS($ObjectType.Task)} when creating a task list button. Use
{!GETRECORDIDS($ObjectType.Event)} when creating an event list button.
• This function is only available in custom buttons, links, and s-controls.

Example: Custom Button Example

{!REQUIRESCRIPT ("/soap/ajax/13.0/connection.js")} var records =
{!GETRECORDIDS($ObjectType.Sample)}; var newRecords = []; if
(records[0] == null) { alert("Please select at least one row") } else {
for (var n=0; n<records.length; n++) { var c = new
sforce.SObject("Case"); c.id = records[n]; c.Status = "New";
newRecords.push(c); } result = sforce.connection.update(newRecords);
window.location.reload(); }

In this example, all selected case records are updated with a Status of New. To set this up in your org, create a custom list button
for cases with the following attributes:
• Display Type is List Button
• Behavior is Execute JavaScript
• Content Source is OnClick JavaScript
Paste the sample code above into the content of your custom button. Finally, add the list button to the page layout that contains
the Cases related list, such as accounts or opportunities. Users can select any number of cases in the related list and click the list
button to change the status of those cases at once. Notice the check for records[0] == null, which displays a message
to users when they don't select at least one record in the list.

GETSESSIONID
Returns the user’s session ID.

Use
GETSESSIONID()

416
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips
Important: $Api.Session_ID and GETSESSIONID() return the same value, an identifier for the current session in the
current context. This context varies depending on where the global variable or function is evaluated. For example, if you use either
in a custom formula field, and that field is displayed on a standard page layout in Salesforce Classic, the referenced session is a
basic Salesforce session. That same field (or the underlying variable or formula result), when used in a Visualforce page, references
a Visualforce session instead.
Session contexts are based on the domain of the request. That is, the session context changes whenever you cross a hostname
boundary, such as from .salesforce.com to .vf.force.com or .lightning.force.com.
Session identifiers from different contexts, and the sessions themselves, are different. When you transition between contexts, the
old session is replaced by the new one, and the old session is no longer valid. The session ID also changes at this time.
Normally Salesforce transparently handles session hand-off between contexts, but if you’re passing the session ID around yourself,
you might need to re-access $Api.Session_ID or GETSESSIONID() from the new context to ensure a valid session ID.
Not all sessions are created equal. In particular, sessions obtained in a Lightning Experience context have reduced privileges, and
don't have API access. You can't use these session IDs to make API calls. {!$Api.Session_ID} isn’t generated for guest
users.

Example: Link Example

HYPERLINK
("https://www.myintegration.com?sId="&
GETSESSIONID() & "?&rowID="&Name & "action=CreateTask","Create
a Meeting Request")

creates a link to an application outside of Salesforce, passing the parameters so that it can connect to Salesforce via the API and
create the necessary event.

HOUR
Returns the local time hour value without the date in the form of a number from 1 through 24.

Use
HOUR(time) and replace time with a time value or value such as TIMENOW().

Example: ExampleHOUR(TIMEVALUE(ClosedDate)) displays only the hour in a time field based on the value of the
Time Closed field.
HOUR(TIMEVALUE("17:30:45.125")) returns 17.

HTMLENCODE
Encodes text and merge field values for use in HTML by replacing characters that are reserved in HTML, such as the greater-than sign
(>), with HTML entity equivalents, such as &gt;.

Use
{!HTMLENCODE(text)} and replace text with the merge field or text string that contains the reserved characters.

417
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips
This function is only available in custom buttons and links, and in Visualforce.

Example: ExampleIf the merge field foo__c contains <B>Enter the user's name<b>,
{!HTMLENCODE(foo__c)} results in: &lt;B&gt;Enter the user&#39;s name&lt;/b&gt;

HYPERLINK
Creates a link to a URL specified that is linkable from the text specified.

Use
HYPERLINK(url, friendly_name [,target]) and replace url with the Web address, replace friendly_name
with the link text, and, optionally, replace target with the window or frame in which to display the content.

Tips
• Hyperlink formula fields are of type text.
• Include the protocol and URL in quotes as in HYPERLINK("http://www.cnet.com", "cnet").
• Avoid using text functions such as LEN, LEFT, or RIGHT on HYPERLINK function results.
• The URL can’t contain JavaScript. This increases security for your org. Using JavaScript is permitted in packages, sandbox copies, and
change sets.
• Use a relative link to link to Salesforce pages. If your full link is https://yourInstance.salesforce.com/00U/e, then
its relative link is /00U/e. Relative links allow the hyperlink to work correctly on all Salesforce pages. Use the relative URL in a
hyperlink formula to add it to a search layout. Make sure to prepend your relative URL with a forward slash “/”.
• Use the $Api variable to reference API URLs.
• Be sure to remove the brackets, [ and ], from your formula before validating it.
• The target parameter is optional. If you don't specify a target, the link opens in a new browser window. Some common
target parameters are:
_blank
Displays link in a new unnamed window.
_self
Displays link in the same frame or window as the element that refers to it.
_parent
Displays link in the immediate frameset parent of the current frame. This value is the same as _self if the current frame has no
parent.
_top
Displays link in the full original window, canceling any other frames. This value is the same as _self if the current frame has no
parent.
For more information on basic HTML tags, consult an HTML reference on the Internet.
• In Chatter feed links created with a hyperlink formula, the target parameter doesn't render and defaults to _blank.
• The HYPERLINK function is available everywhere that you can define a formula except default values, field updates, s-controls,
validation rules, approval processes, custom buttons and links, and workflow rules.

418
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Create Events Example

HYPERLINK("/00U/e?
retURL=%2F006x0000001T8Om&what_id="
& Id,
"Create Event")

adds a link called Create Event that, when clicked, creates an event that is associated with the current object.

Example: Phone Dialer Example

HYPERLINK("http://servername/call?id=" & Id & "&phone=" & Phone, Phone)creates a linkable
phone number field that automatically dials the phone number when clicked. In this example, replace "servername" and
"call" with the name of your dialing tool and the command it uses to dial. The merge field, Id, inserts the identifier for the
contact, lead, or account record. The first Phone merge field tells the dialing tool what number to call and the last Phone merge
field uses the value of the Phone field as the linkable text the user clicks to dial.

IF
Determines if expressions are true or false. Returns a given value if true and another value if false.

Use
IF(logical_test, value_if_true, value_if_false) and replace logical_test with the expression you
want evaluated; replace value_if_true with the value you want returned if the expression is true; replace value_if_false
with the value you want returned if the expression is false.

Tips
• Make sure your value_if_true and value_if_false expressions are the same data type.
• When using an IF function with the $Profile.UserType variable to determine the type of Salesforce user license the logged in user
has, use the following values:
– Standard for Salesforce
– PowerPartner for PRM User
– CustomerSuccess for Customer Portal User
– PowerCustomerSuccess for Customer Portal Manager
For example, use the following formulas to determine if the logged in user has the license type in quotes:
IF(ISPICKVAL($Profile.UserType ,"Standard"), 100, 0.1)

IF(ISPICKVAL($Profile.UserType ,"PowerPartner"), 100, 0.1)

IF(ISPICKVAL($Profile.UserType ,"CustomerSuccess"), 100, 0.1)

Note: $Profile merge fields are only available in Enterprise, Unlimited, Performance, and Developer Editions.

Example: Formula Field Example: Overdue Payments

IF(AND(Payment_Due_Date__c < TODAY(),Payment_Status__c ="UNPAID") , "PAYMENT
OVERDUE", null)

419
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

This formula determines if the payment due date is past and the payment status is “UNPAID.” If so, returns the text “PAYMENT
OVERDUE” and if not, leaves the field blank. This example uses a custom date field called Payment Due Date and a text
custom field called Payment Status.

Example: Formula Field Example: Insert Tax Rate

Use this default value formula to set the tax rate of an asset based on the user's city. Create a custom percent field with the following
default value:
IF($User.City = "Napa", 0.0750,
IF($User.City = "Paso Robles", 0.0725,
IF($User.City = "Sutter Creek", 0.0725,
IF($User.City = "Los Olivos", 0.0750,
IF($User.City = "Livermore", 0.0875, null
)
)
)
)
)

Example: Custom Button Example

{!
IF(Sample.BillingCountry = "US",
"http://maps.google.com/maps?q="&Sample.BillingStreet&
"+"&Sample.BillingCity&"+"&Sample.BillingState&"+"&Sample.BillingCountry,
(IF(Sample.BillingCountry = "UK",
"http://maps.google.co.uk/maps?q="&Sample.BillingStreet
&"+"&Sample.BillingCity&"+"&Sample.BillingCountry,
"http://maps.google.com")))
}

This example uses the IF function to determine if an address is in the United States or United Kingdom so that it can use the
appropriate type of Google map to display the address.

IMAGE
Inserts an image with alternate text and height and width specifications.

Use
IMAGE(image_url, alternate_text, height, width) and replace image_url with the full path to the image.
Replace alternate_text with the string of text you want to appear when the image can’t be rendered for some reason. This text
can be used by screen reader software. Replace height with the vertical size of the image in pixels. Replace width with the horizontal
size of the image in pixels.
For reports, images aren't automatically resized to fit into a report column. Use the height and width parameters to explicitly size
the image so it fits into the column without being partially cut off.

Tips
• The height and width parameters are optional.
• Use a text string to replace the image_url and alternate_text parameters. Surround each text string in quotes.

420
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• Use numbers to replace the height and width parameters.

• Add images to your Documents tab if you want to display them elsewhere. For example, store the image of a product in a document
folder, copy the URL to the document, and paste that URL in the image_url parameter of a formula field on the Products tab.
• If you use Internet Explorer, you sometimes must to change your security settings so that Explorer doesn’t display a warning prompt
when images use HTTP protocol. See the online help for Internet Explorer for instructions on changing your security settings.
• The IMAGE function cannot include the GETSESSIONID function as one of its arguments.
• The IMAGE function is available only in formula fields and email templates.
• You can’t display an image related to a contact in a custom formula field if it’s referenced through a person account.

Example: ExampleHYPERLINK("ymsgr:sendIM?" & Yahoo_Name__c,

IMAGE("http://opi.yahoo.com/online?u=" & Yahoo_Name__c & "&m;=g&t;=0", "Yahoo"))
This formula displays a clickable Yahoo! Messenger icon indicating if the person is logged on to the service. Users can click the
icon to launch a Yahoo! Messenger conversation with the person. This example uses a custom text field called Yahoo Name
on contacts where you can store the contact's Yahoo! Messenger ID.

IMAGEPROXYURL
Securely retrieves external images and prevents unauthorized requests for user credentials.

Use
<apex:image value="{!IMAGEPROXYURL("http://exampledomain.com/pic.png")}"/> and replace
http://exampledomain.com/pic.png with your image.

Tips
• Use IMAGEPROXYURL for all images hosted on servers you don’t control.
• The rendered image URL can change at any time. Don’t copy and paste it anywhere.
• Don’t use the rendered image URL outside of Salesforce.

Example: Function Example

<apex:image id="salesforce-twitter"
value="{!IMAGEPROXYURL("https://pbs.twimg.com/profile_images/1014182734606897153/JfveQU3Z_400x400.jpg")}"

alt="Salesforce on Twitter" />

This IMAGEPROXYURL function retrieves and displays an image from Twitter’s image host, an external source. This function loads
the Salesforce Twitter profile image over HTTPS. This function also prevents the image from making unauthorized requests for
user credentials.

INCLUDE
Returns content from an s-control snippet. Use this function to reuse common code in many s-controls.

Use
{!INCLUDE(source, [inputs])} and replace source with the s-control snippet you want to reference. Replace inputs
with any information you need to pass the snippet.

421
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips
• Because this function references an s-control snippet and does not copy it, it always runs the latest content of the s-control snippet.
Remember that making a change to your s-control snippet affects all INCLUDE functions that refer to it.
• Use the $Request global variable to access any information inside the snippet.
• This function is only available in custom buttons, links, and s-controls.

Example: S-Control Example: Include a Header Snippet

<html> <body> {! INCLUDE($SControl.Header_Snippet, [title = "My Title",
theme = "modern"])} </body> </html>

This example references a snippet that provides a header for a page that you created to display in a Web tab. It displays the page
title “My Title.” Use the $SControl global variable to reference a custom s-control.

Example: S-Control Example: Include Input Parameters

Use the following two examples to see how you can create a reusable snippet and include it in an s-control.
<h2
class=”{!$Request.titleTheme}.title”>{!$Request.titleText}</h2>

This snippet requires two input parameters: titleTheme and titleText. It is a reusable HTML tag that presents a page
title and theme based on input parameters. Next, create an s-control that includes this snippet:
<html> <head> </head> <body> {!
INCLUDE($SControl.Title_Snippet, [titleTheme = "modern", titleText
= "My Sample Title"]) } ... Insert your page specific content
here ... </body> </html>

This s-control uses the snippet titled Title_Snippet to display the title of the page “My Sample Title” and modern theme. Replace
Insert your page specific content here with your own HTML content and use the s-control as the source of
a Web tab to create your own pages in Salesforce.

INCLUDES
Determines if any value selected in a multi-select picklist field equals a text literal you specify.

Use
INCLUDES(multiselect_picklist_field, text_literal) and replace multiselect_picklist_field
with the merge field name for the multi-select picklist; and replace text_literal with the multi-select picklist value you want to
match in quotes.

Tips
• The text_literal expression must be of type text and enclosed in quotes. It cannot be a merge field or the result of a function.
• Salesforce returns an error if any of the following occurs:
– You do not provide a text_literal expression.
– You provide an empty text_literal expression, such as "" or " ".

• Use ISBLANK to determine if a multi-select picklist field is empty.

422
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• Use the PRIORVALUE function inside the INCLUDES function to check if the previous value of a multi-select picklist field included a
specific value. For example:
INCLUDES(
PRIORVALUE(multiselect_picklist_field),
text_literal
)

Example: Function Example

INCLUDES(Hobbies__c, "Golf") returns TRUE if one of the selected values in the Hobbies custom multi-select
picklist field is Golf.

ISBLANK
Determines if an expression has a value and returns TRUE if it does not. If it contains a value, this function returns FALSE.

Use
ISBLANK(expression) and replace expression with the expression you want evaluated.

Tips
• Use ISBLANK instead of ISNULL in new formulas. ISBLANK has the same functionality as ISNULL, but also supports text fields. Salesforce
will continue to support ISNULL, so you do not need to change any existing formulas.
• A field is not empty if it contains a character, blank space, or zero. For example, a field that contains a space inserted with the spacebar
is not empty.
• Use the BLANKVALUE function to return a specified string if the field doesn't have a value; use the ISBLANK function if you only want
to check if the field has a value.
• If you use this function with a numeric field, the function only returns TRUE if the field has no value and is not configured to treat
blank fields as zeroes.
• If you use this function with a picklist, use ISBLANK(TEXT(<picklist>)) to convert the picklist items into a text value.

Example: Formula Example

(IF(ISBLANK(Maint_Amount__c), 0, 1) +
IF(ISBLANK(Services_Amount__c), 0,1) +
IF(ISBLANK(Discount_Percent__c), 0, 1) +
IF(ISBLANK(Amount), 0, 1) +
IF(ISBLANK(Timeline__c), 0, 1)) / 5

This formula takes a group of fields and calculates what percent of them are being used by your personnel. This formula field
checks five fields to see if they are blank. If so, a zero is counted for that field. A “1” is counted for any field that contains a value,
and this total is divided by five (the number of fields evaluated). This formula requires you to select the Treat blank fields as
blanks option under Blank Field Handling while the Advanced Formula subtab is showing.

ISCHANGED
Compares the value of a field to the previous value and returns TRUE if the values are different. If the values are the same, this function
returns FALSE.

423
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
ISCHANGED(field) and replace field with the name of the field you want to compare.

Tips
• This function is available only in:
– Assignment rules
– Validation rules
– Field updates
– Workflow rules if the evaluation criteria is set to Evaluate the rule when a record is: created, and
every time it’s edited .
– Formula criteria for executing actions in Process Builder.

• Use the NOT function to reverse the return values of TRUE and FALSE.
• This function returns FALSE when evaluating any field on a newly created record.
• If a text field was previously blank, this function returns TRUE when it contains any value.
• For number, percent, or currency fields, this function returns TRUE when:
– The field was blank and now contains any value
– The field was zero and now is blank
– The field was zero and now contains any other value

Example: Validation Rule ExampleThe following validation rule prevents users from changing an object name after it has
been created: ISCHANGED(Name).
NOT(AND(ISCHANGED(Priority), ISPICKVAL(Priority, “Low”))) is a validation rule that ensures if a user
changes the Priority of a case, the new priority cannot be “Low.”
NOT(AND(ISCHANGED(CloseDate), OR(MONTH(CloseDate) <> MONTH(TODAY()), YEAR(CloseDate)
<> YEAR(TODAY())),$Profile.Name <> "Sales Manager")) is a validation rule that prevents a user from
changing the Close Date of an opportunity to a date outside of the current month and year unless that user has the “Sales
Manager” profile.

Note: $Profile merge fields are only available in Enterprise, Unlimited, Performance, and Developer Editions.

ISCLONE
Checks if the record is a clone of another record and returns TRUE if one item is a clone. Otherwise, returns FALSE.

Use
ISCLONE()

Tips
• This function cannot be used with fields.
• Use the NOT function to reverse the return values of TRUE and FALSE.

424
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Validation Rule Example

Use (ISCLONE() to create a validation rule on an object and identify a record that’s a clone of another record.

ISNEW
Checks if the formula is running during the creation of a new record and returns TRUE if it is. If an existing record is being updated, this
function returns FALSE.

Use
ISNEW()

Tips
• This function is available only in validation rules, field updates, workflow rules, assignment rules, and processes.
• Use the NOT function to reverse the return values of TRUE and FALSE.
• This function always returns FALSE when used in a workflow rule with a time-based trigger.
• This function always returns FALSE when used in a field update for an approval action.

Example: Validation Rule Example Use the following validation rule to prevent users from creating a record with a close
date in the past. AND (ISNEW(), CloseDate < TODAY()) checks if the user is creating a new opportunity and, if so,
ensures that the Close Date is today or after today.
Use this validation rule to ensure users add at least one product to an opportunity after they have created it.
NOT(OR(ISNEW(),HasOpportunityLineItem))

In this example, the validation rule formula displays the following error message when an existing opportunity does not have any
products: “You must add products to this opportunity before saving.” This does not display an error on the initial save because
they cannot add products until after saving the record initially; but it prevents them from resaving or closing an opportunity that
does not contain products.

ISNULL
Determines if an expression is null (blank) and returns TRUE if it is. If it contains a value, this function returns FALSE.

Use
ISNULL(expression) and replace expression with the expression you want evaluated.

Tips
• Text fields are never null, so using this function with a text field always returns false. For example, the formula field
IF(ISNULL(new__c) 1, 0) is always zero regardless of the value in the New field. For text fields, use the ISBLANK function
instead.
• Multi-select picklist fields are never null in s-controls, buttons, and email templates, so using this function with a multi-select picklist
field in those contexts always returns false.
• Empty date and date/time fields always return true when referenced in ISNULL functions.
• Don’t use ISNULL for date/time fields.

425
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• Choose Treat blank fields as blanks for your formula when referencing a number, percent, or currency field in an ISNULL function.
Choosing Treat blank fields as zeroes gives blank fields the value of zero so none of them will be null.
• Merge fields can be handled as blanks, which can affect the results of components like s-controls because they can call this function.
• When using a validation rule to ensure that a number field contains a specific value, use the ISNULL function to include fields that
do not contain any value. For example, to validate that a custom field contains a value of '1', use the following validation rule to
display an error if the field is blank or any other number:
OR(ISNULL(field__c), field__c<>1)

Example: Formula Example

(IF(ISNULL(Maint_Amount__c), 0, 1) +
IF(ISNULL(Services_Amount__c), 0,1) +
IF(ISNULL(Discount_Percent__c), 0, 1) +
IF(ISNULL(Amount), 0, 1) +
IF(ISNULL(Timeline__c), 0, 1)) / 5

This formula takes a group of fields and calculates what percent of them are being used by your personnel. This formula field
checks five fields to see if they are blank. If so, a zero is counted for that field. A “1” is counted for any field that contains a value,
and this total is divided by five (the number of fields evaluated). This formula requires you to select the Treat blank fields as
blanks option under Blank Field Handling while the Advanced Formula subtab is showing.

Example: Validation Rule Example

AND(ISPICKVAL(StageName, "Closed Won"),
ISNULL(Project_Start_Date__c))

This validation rule makes the Project Start Date custom date field conditionally required whenever the stage is Closed
Won.

ISNUMBER
Determines if a text value is a number and returns TRUE if it is. Otherwise, it returns FALSE.

Use
ISNUMBER(text) and replace text with the merge field name for the text field.

Tips
• This function returns FALSE for blank values.
• The ISNUMBER function is not aware of your locale. For example, ISNUMBER("123,12") and ISNUMBER("1 000") return
FALSE even if the user's locale is “French.”
• Chinese, Japanese, Korean, and special characters including a space return FALSE.
• The ISNUMBER function returns TRUE for scientific formatting such as “2E2” or “123.123.”

Example: Validation Rule Example

OR(LEN(Bank_Account_Number__c) <> 10, NOT(ISNUMBER(Bank_Account_Number__c)))

This validation rule ensures a custom text field called Bank Account Number is a number of 10 digits and is not blank.

426
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

ISPICKVAL
Determines if the value of a picklist field is equal to a text literal you specify.

Use
ISPICKVAL(picklist_field, text_literal) and replace picklist_field with the merge field name for the
picklist; replace text_literal with the picklist value in quotes. text_literal cannot be a merge field or the result of a
function.

Tips
• Replace picklist_field with a custom or standard field of type picklist.
• Your text_literal expression must be of type text and enclosed in quotes. It cannot be a merge field or the result of a function.
• Use CASE functions to determine if a picklist value is equal to a particular value.
• When using the ISPICKVAL function to return the previous value of a picklist field, include the PRIORVALUE function inside the
ISPICKVAL function as in this example:
ISPICKVAL(PRIORVALUE
(picklist_field),
text_literal)

Example: Contract Activation Example

IF(ISPICKVAL(Status, "Activated"), NOW()-ActivatedDate, null) calculates the number of days
since the contract was activated. If the contract status is not “Activated,” this field is blank.

Example: Commission Accounts Example

IF(ISPICKVAL(StageName, "Closed Won"),
ROUND(Amount *0.02, 2), 0)

This example calculates the commission amount for any opportunity that has a “Closed Won” stage. The value of this field will be
the amount times 0.02 for any closed/won opportunity. Open or lost opportunities will have a zero commission value.

Example: Competitor-Triggered Workflow Example

ISPICKVAL(Stage, “Closed Lost”) && INCLUDES(Competitor__c, “Acme”)

In a workflow rule or process, this formula configures Salesforce to trigger the associated actions if the Competitor multi-select
picklist field on a lost business is Acme.

JSENCODE
Encodes text and merge field values for use in JavaScript by inserting escape characters, such as a backslash (\), before unsafe JavaScript
characters, such as the apostrophe (').

Use
{!JSENCODE(text)} and replace text with the merge field or text string that contains the unsafe JavaScript characters.

427
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips
This function is only available in custom buttons and links, and in Visualforce.

Example: Merge Field Example

If the merge field foo__c contains <B>Enter the user's name<b>, {!JSENCODE(foo__c)} results in:
\u003CB\u003EEnter the user\'s name\u003C\/b\u003E

JSINHTMLENCODE
Encodes text and merge field values for use in JavaScript inside HTML tags by replacing characters that are reserved in HTML with HTML
entity equivalents and inserting escape characters before unsafe JavaScript characters.
JSINHTMLENCODE(someValue) is a convenience function that is equivalent to JSENCODE(HTMLENCODE((someValue)).
That is, JSINHTMLENCODE first encodes someValue with HTMLENCODE, and then encodes the result with JSENCODE.

Use
{!JSINHTMLENCODE(text)} and replace text with the merge field or text string that contains the unsafe JavaScript characters.

Tips
• This function is only available in custom buttons and links, and in Visualforce.

Example: Merge Field Example

If the merge field foo__c contains <B>Enter the user's name<b>, {!JSINHTMLENCODE(foo__c)} results
in: &lt;B&gt;Enter the user&#39;s name&lt;/b&gt;

JUNCTIONIDLIST
Returns a JunctionIDList based on the provided IDs.
A JunctionIDList is a string array of referenced ID values that represent the many-to-many relationship of an underlying junction entity.

Use
JUNCTIONIDLIST(id, id,...) and replace id with the Salesforce ID you want to use.

Example: Contact Record ID Example

JUNCTIONIDLIST(Case.ContactId)
This formula returns the case’s contact record ID. When used on the email action for cases, you can use this formula as a predefined
value for the To Recipients field. Using this formula as a predefined value for the field ensures that sent emails are always associated
with a Salesforce record. In the case feed publisher, users see the contact name instead of the ID or email address.

LEFT
Returns the specified number of characters from the beginning of a text string.

428
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
LEFT(text, num_chars) and replace text with the field or expression you want returned; replace num_chars with the
number of characters from the left you want returned.

Tips
• Reference auto-number fields as text fields in formulas.
• If the num_chars value is less than zero, Salesforce replaces the value with zero.

Example: Custom Field Example

TRIM(LEFT(LastName, 5)) & "-" & TRIM(RIGHT(SSN__c, 4))
This formula displays the first five characters of a name and the last four characters of a social security number separated by a dash.
Note that this example uses a text custom field called SSN.

LEN
Returns the number of characters in a specified text string.

Use
LEN(text) and replace text with the field or expression whose length you want returned.

Example: Formula Example

LEN(PartNumber__c)

This formula returns the number of characters in a Product Code field.

LINKTO
Returns a relative URL in the form of a link (href and anchor tags) for a custom s-control or Salesforce page.

Use
{!LINKTO(label, target, id, [inputs], [no override]} and replace label with the text for the link, target
with the URL, and id with a reference to the record. Inputs are optional and can include any additional parameters you want to add
to the link. The no override argument is also optional and defaults to “false.” It applies to targets for standard Salesforce pages
such as $Action.Account.New. Replace no override with “true” when you want to display a standard Salesforce page regardless
of whether you have defined an override for it elsewhere.

Tips
• Avoid using this function in an inline s-control if you want it to open in a new window.
• Enclose multiple inputs in brackets to indicate they are together:
{!LINKTO("View Case", $Action.Case.View, Case.Id, [parm1="A", parm2="B"])}

• Set inputs to null if you do not have any to pass yet you want to set the no override argument:
{!LINKTO("View Case", $Action.Case.View, Case.Id, null, true)}

429
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• When you override the tab home page for a standard or custom tab, use the tab’s $Action global variable as the target value,
and the tab’s object type for the id value. For example, LINKTO("Accounts Tab", $Action.Account.Tab,
$ObjectType.Account)
• This function is only available in custom buttons, links, and s-controls.

Example: New Account S-Control Example

<html> <body> {!LINKTO("Create a New Account",
$Action.Account.New, $ObjectType.Account)} </body> </html>

This example allows users to click a link to create a new account. It is useful in account list views or Web tabs where you want users
to create an account directly from that page. Use the $Action global variable to access the new account page in Salesforce.

Example: Email Window S-Control Example

<html>
<body>
{!LINKTO("Email link",
"mailto:[email protected]?subject=Please%20Help")};
</body>
</html>

This example launches a new email window addressed to [email protected] with the subject “Please Help” whenever
a user clicks “Mail link.”

Example: Link to Another S-Control Example

<html>
<body>
{!LINKTO("Check for duplicates",
$Scontrol.dedup_account, Account.Id)}
</body>
</html>

Use this example to generate a page containing a hyperlink labeled “Check for duplicates.” When users click this link, Salesforce
runs your custom s-control. This example assumes you have already created a custom s-control to find duplicate accounts and
merge their information.

LN
Returns the natural logarithm of a specified number. Natural logarithms are based on the constant e value of 2.71828182845904.

Use
LN(number) and replace number with the field or expression for which you want the natural logarithm. Note: the LN function is
the inverse of the EXP function.

Example: Formula Example

LN(10) returns the natural logarithm of 10, which is 2.30.
LN(Value__c) returns the natural logarithm of a custom number field called Value.

430
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

LOG
Returns the base 10 logarithm of a number.

Use
LOG(number) and replace number with the field or expression from which you want the base 10 logarithm calculated.

Example: Salary Example

LOG(Salary__c) calculates the logarithm of a person’s salary. In this example, Salary is a custom currency field.

Example: Hydrogen Example

-LOG(Hydrogen__c) calculates the pH and acidity using the LOG function and a custom number field called Hydrogen,
which represents the concentration of Hydrogen ions in the liquid measured in moles per liter.

LOWER
Converts all letters in the specified text string to lowercase. Any characters that are not letters are unaffected by this function. Locale
rules are applied if a locale is provided.

Use
LOWER(text, [locale]) and replace text with the field or text you wish to convert to lowercase, and locale with the
optional two-character ISO language code or five-character locale code, if available.

Example: MYCOMPANY.COM Example

LOWER("MYCOMPANY.COM") returns “mycompany.com.”

Example: Ticker Symbol Example

LOWER(TickerSymbol) returns the text in Ticker Symbol in lower case characters.

Example: Turkish Language Locale Rules Example

The Turkish language has two versions of the letter “i”: one dotted and one dotless. The locale rules for Turkish require the ability
to capitalize the dotted i, and allow the dotless I to be lowercase. To correctly use the LOWER() function with the Turkish language
locale, use the Turkish locale code tr in the LOWER() function as follows:
LOWER(text, "tr")
This ensures that Salesforce does not transform any dotted i in the text to a dotless I.

LPAD
Inserts characters you specify to the left-side of a text string.

Use
LPAD(text, padded_length[, pad_string]) and replace the variables:
• text is the field or expression you want to insert characters to the left of.
• padded_length is the number of total characters in the text that will be returned.
• pad_string is the character or characters that should be inserted. pad_string is optional and defaults to a blank space.

431
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

If the value in text is longer than pad_string, text is truncated to the size of padded_length.

Tips
Leading blank spaces and zeros are omitted.

Example: Field Name Example: Padding

LPAD(Name, 20) truncates the Name field after 20 characters. For example, if the name is mycompany.com, the value
returned is "mycompany.com."

Example: My Company Example: No Change

LPAD('my_company.com', 14, 'z') returns “my_company.com” without change because it has 14 characters.

Example: Field Name Example: Padded with Z

LPAD(Name, 15, 'z') returns the name “zmycompany.com.”

Example: Field Name Example: Truncating Ex

LPAD(Name, 2) truncates the name after the second character. For example, if the name is mycompany.com, the value
returned is “my.”

MAX
Returns the highest number from a list of numbers.

Use
MAX(number, number,...) and replace number with the fields or expressions from which you want to retrieve the highest
number.

Example: Service Charge

MAX(0.06 * Total_Cost__c, Min_Service_Charge__c)
In this example, the formula field calculates a service charge of 6% of the total cost or a minimum service charge, whichever is
greater. Note that Min Service Charge is a custom currency field with a default value of $15. However, you could make
it a formula field if your minimum service charge is always the same amount.

Example: Book Royalties Example

MAX(0.10 * Pages__c,
(Retail_Price__c * 0.07) * Total_Sold__c)

This formula determines which amount to pay in royalties for a book. It displays the greater of two amounts: $0.07 for each book
sold or $0.10 per page. It assumes you have custom number fields for Pages and Total Sold and a custom currency field
for Retail Price.

Example: Commissions Example

MAX($User.Commission_Percent__c * Price,
Price * Account_Discount__c, 100)

432
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

This formula determines what commission to log for an asset based on which is greater: the user's commission percentage of the
price, the price times the discount percent stored for the account or 100 dollars. This example assumes you have two custom
percent fields on users and assets.

MCEILING
Rounds a number up to the nearest integer, towards zero if negative.

Use
MCEILING(number)

Example: Rounding Example

MCEILING(2.5) returns 3, which is 2.5 rounded up to the nearest integer.
MCEILING(-2.5) returns -2, which is -2.5 rounded up towards zero for a negative number.

MFLOOR
Rounds a number down to the nearest integer, away from zero if negative.

Use
MFLOOR(number)

Example: Rounding Example

MFLOOR(2.5) returns 2, which is 2.5 rounded down to the nearest integer.
MFLOOR(-2.5) returns -3, which is -2.5 rounded away from zero for a negative number.

MID
Returns the specified number of characters from the middle of a text string given the starting position.

Use
MID(text, start_num, num_chars) and replace text with the field or expression to use when returning characters;
replace start_num with the number of characters from the left to use as a starting position; replace num_chars with the total
number of characters to return.

Example: String ExampleMID(Division, 3, 4) returns four characters of the Division name beginning with the
third character from the left. On a user record, this represents the department code.

MILLISECOND
Returns a milliseconds value in the form of a number from 0 through 999.

Use
MILLISECOND(time) and replace time with a time value or value such as TIMENOW().

433
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Formula ExampleMILLISECOND(TIMEVALUE(ClosedDate)) displays only the milliseconds in a time

field based on the value of the Time Closed field.
MILLISECOND(TIMEVALUE("17:30:45.125")) returns 125.

MIN
Returns the lowest number from a list of numbers.

Use
MIN(number, number,...) and replace number with the fields or expressions from which you want to retrieve the lowest
number.

Example: 401k Matching Example

MIN(250, Contribution__c /2)

This example formula determines which amount to provide in employee 401K matching based on a matching program of half of
the employee's contribution or $250, whichever is less. It assumes you have custom currency field for Contribution.

Example: Bonus Example

MIN(Gross__c * Bonus_Percent__c,
Performance__c / Number_of_Employees__c)

This example determines an employee's bonus amount based on the smallest of two amounts: the employee's gross times bonus
percent or an equally divided amount of the company's performance amount among all employees. It assumes you have custom
number field for Number of Employees, a custom percent field for Bonus Percent, and currency custom fields for
the employee's Gross and company's Performance.

MINUTE
Returns a minute value in the form of a number from 0 through 60.

Use
MINUTE(time) and replace time with a time value or value such as TIMENOW().

Example: Formula Example

MINUTE(TIMEVALUE(ClosedDate)) displays only the minutes in a time field based on the value of the Time Closed field.
MINUTE(TIMEVALUE("17:30:45.125")) returns 30.

MOD
Returns a remainder after a number is divided by a specified divisor.

Use
MOD(number, divisor) and replace number with the field or expression you want divided; replace divisor with the
number to use as the divisor.

434
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Scheduling Example

MOD(3, 3) returns 0
MOD(4, 3) returns 1
MOD(123, 100) returns 23
To prevent users from scheduling meetings on a Saturday or Sunday, use a validation rule to apply a custom date field called My
Date.

CASE(MOD(My_Date__c - DATE(1900, 1, 7), 7),

0, 0,
6, 0,
1) = 0

This example displays the following error message when the value of My Date is not Monday through Friday: “My Date is not
a weekday.”

MONTH
Returns the month, a number between 1 (January) and 12 (December) in number format of a given date.

Use
MONTH(date) and replace date with the field or expression for the date containing the month you want returned.

Example: SLA Expiration Example

MONTH(SLAExpirationDate__c) returns the month that your service-level agreement expires. This example uses a
custom date field called SLA Expiration Date.

Example: Current Month Example

MONTH(TODAY()) returns the current month in a number format. For example, the month of February would be the value
“2.”

NOT
Returns FALSE for TRUE and TRUE for FALSE.

Use
NOT(logical) and replace logical with the expression that you want evaluated.

Example: Formula Example

IF(NOT(ISPICKVAL(Status, "Closed")), ROUND(NOW()-CreatedDate, 0), null checks to see if a
variable is open and if so, calculates the number of days it has been open by subtracting the date and time created from the current
date and time. The result is the number of days open rounded to zero decimal places. If the variable is not open, this field is blank.

NOW
Returns a date/time representing the current moment.

435
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
NOW()

Tips
• Do not remove the parentheses.
• Keep the parentheses empty. They do not need to contain a value.
• Use a date/time field in a NOW function instead of a date field. Created Date and Last Modified Date are date/time
fields whereas Last Activity Date is a date field.
• Use TODAY if you prefer to use a date field.
• Dates and times are always calculated using the user’s time zone.
• Use addition and subtraction operators with a NOW function and other date/time fields to return a number, representing number
of days. For example NOW() - CreatedDate calculates the number of days since the created date of a record. In this example,
the formula field data type is a number.
• Use addition and subtraction operators with a NOW function and numbers to return a date and time. For example NOW() +5
calculates the date and time five days ahead of now. In this example, the formula field data type is a date/time.

Example: Open Lead Example

IF(ISPICKVAL(Status, "Open"), ROUND(NOW()-CreatedDate, 0), null)
This formula checks to see if a lead is open and if so, calculates the number of days it has been open by subtracting the date and
time created from the current date and time. The result is the number of days open rounded to zero decimal places. If the lead is
not open, this field is blank.

NULLVALUE
Determines if an expression is null (blank) and returns a substitute expression if it is. If the expression is not blank, returns the value of
the expression.

Important: Use BLANKVALUE instead of NULLVALUE in new formulas. BLANKVALUE has the same functionality as NULLVALUE,
but also supports text fields. Salesforce continues to support NULLVALUE, so you don’t need to change existing formulas.

Use
NULLVALUE(expression, substitute_expression) and replace expression with the expression you want to
evaluate; replace substitute_expression with the value you want to replace any blank values.

Tips
• Avoid using this function with text fields because they are never null even when they are blank. Instead, use the BLANKVALUE
function to determine if a text field is blank.
• Don’t use NULLVALUE for date/time fields.
• Choose Treat blank fields as blanks for your formula when referencing a number, percent, or currency field in a
NULLVALUE function. Choosing Treat blank fields as zeroes gives blank fields the value of zero so none of them
will be null.
• Use the same data type for both the expression and substitute_expression.

436
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Custom Field Example(NULLVALUE(Sample_Due_Date__c, StartDate +5)

This formula returns the date five days after the start date whenever Sample Due Date is blank. Sample Due Date is
a custom date field.

OR
Determines if expressions are true or false. Returns TRUE if any expression is true. Returns FALSE if all expressions are false.
Use this function as an alternative to the operator || (OR) on page 405

Use
OR(logical1, logical2...) and replace any number of logical references with the expressions you want evaluated.

Example: Formula Field ExampleIF(OR(ISPICKVAL(Priority, "High"), ISPICKVAL(Status,

"New")), ROUND(NOW()-CreatedDate, 0), null)
This formula returns the number of days a case has been open if the Status is new or the Priority is high. If the case was
opened today, this field displays a zero.

Example: Validation Rule Example

OR(Sample_Rate__c < 0, Sample_Rate__c > 0.40)

This validation rule formula displays the following error message when the Sample Rate custom field is not between 0 and
40%: “SampleRate cannot exceed 40%.”

PARENTGROUPVAL
This function returns the value of a specified parent grouping. A “parent” grouping is any level above the one containing the formula.
You can use this function only in custom summary formulas and at grouping levels for reports, but not at summary levels.

Use
Summary and Joined:
PARENTGROUPVAL(summary_field, grouping_level)
Matrix:
PARENTGROUPVAL(summary_field, parent_row_grouping, parent_column_grouping)
Where summary_field is the summarized field value, grouping_level is GRAND_SUMMARY or the API name of the parent
level group for summary reports, and parent_row_level and parent_column_level are the parent levels for matrix
reports.
In reports with multiple grouping levels, you can set the grouping_level to be any group level higher than the formula display
level.

Example: Formula Example

TOTAL_PRICE:SUM/PARENTGROUPVAL(TOTAL_PRICE:SUM, GRAND_SUMMARY)

This formula calculates, for each product, its relative size compared to the grand total. In this example, the report is a summary of
opportunities and their products, grouped by Product Name.

437
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

PREDICT
Returns an Einstein Discovery prediction for a record based on the specified record ID or for a list of fields and their values.

Use
PREDICT(PredDefId, [recordId] | [field, value, ...]). Replace PredDefId with the Prediction Definition
ID of a deployed prediction in your org. Specify the recordId of the record to predict or a list of fields and their associated values
([field, value, ...]).

Tips
• The specified PredDefId must link to a deployed and active prediction in your Salesforce org. To insert a value, select PredDefId,
click Insert Field, select SmartDataDiscovery > Prediction Definitions, select an available prediction, select Prediction Definition
Id, and then click Insert.

Note: The syntax for PredDefId must match the following pattern:
$SmartDataDiscovery.PredictionDefinitions.<predictionDevName>.Id

• If you specify a recordId, the function returns a prediction for the data values in that record.
• If you specify a list of field names and values, the function returns a prediction for the data values you provided. Be sure to provide
all the fields that the prediction requires as input.
• To view Einstein Discovery predictions, users must have the View Einstein Discovery Recommendations system permission. To learn
more, see Assign Einstein Discovery Permission Sets to Users.
• The PREDICT function is available when defining formulas for the following Process Automation components: approval processes,
flows, processes (in Process Builder), workflow rules, and Next Best Action.
• The PREDICT function is not supported in formula-based fields on Salesforce objects.

Example: recordid Example

PREDICT($SmartDataDiscovery.PredictionDefinitions.Recommende_kFjqS_1370.Id, Id)

This example calls the PREDICT function and passes a prediction definition and recordId.

Example: List of Fields and Value Example

PREDICT($SmartDataDiscovery.PredictionDefinitions.Recommende_kFjqS_1370.Id,
‘Customer_Typec’, Text(Customer_Typec), ‘List_Price__c’, List_Price__c)

This example calls the PREDICT function and passes a prediction definition and list of fields with associated values.

PREVGROUPVAL
This function returns the value of a specified previous grouping. A “previous” grouping is one that comes before the current grouping
in the report.
Choose the grouping level and increment. The increment is the number of columns or rows before the current summary. The default is
1; the maximum is 12. You can use this function only in custom summary formulas and at grouping levels for reports, but not at summary
levels.

438
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
PREVGROUPVAL(summary_field, grouping_level [, increment])

Where summary_field is the name of the grouped row or column, grouping_level is the API name of the peer level group
whose summary value for the previous grouping is used, and increment is the number of groupings previous.
In reports with multiple grouping levels, you can specify the grouping_level to be the same group level as the formula display
level or a group level higher than the formula display level.

Example: Formula Example

AMOUNT:SUM - PREVGROUPVAL(AMOUNT:SUM, CLOSE_DATE)

This formula calculates, for each month, the difference in amount from the previous month shown in the report. In this example,
the report is an opportunity matrix with columns grouped by Close Date and rows by Stage.

PRIORVALUE
Returns the previous value of a field.

Use
PRIORVALUE(field)

Tips
• This function is available only in:
– Assignment rules
– Validation rules
– Field updates
– Workflow rules if the evaluation criteria is set to Evaluate the rule when a record is: created, and
every time it’s edited .
– Formula criteria for executing actions and setting input values in Process Builder.

• This function doesn’t return default values.

• When users create a record, this function returns the value of the field referenced rather than null. For example, if you create an
account named "Acme," PRIORVALUE(Account.Name) returns Acme.
• When using the ISPICKVAL function to return the previous value of a picklist field, include the PRIORVALUE function inside the
ISPICKVAL function as in this example:
ISPICKVAL(PRIORVALUE
(picklist_field),
text_literal)

• To check if the previous value of a multi-select picklist field includes a specific value, use the PRIORVALUE function inside the INCLUDES
function. For example:
INCLUDES(
PRIORVALUE(multiselect_picklist_field),
text_literal
)

439
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Validation Rule Example

This validation rule prevents users from changing the expected revenue of an opportunity after it’s closed:
AND(PRIORVALUE(Amount) > Amount, IsClosed).

REGEX
Compares a text field to a regular expression and returns TRUE if there is a match. Otherwise, it returns FALSE.
A regular expression is a string used to describe a format of a string according to certain syntax rules.

Use
REGEX(text, regex_text) and replace text with the text field, and regex_text with the regular expression you want
to match.

Tips
• Regular expression syntax is based on Java Platform SE 6 syntax. However, backslash characters (\) must be changed to double
backslashes (\\) because backslash is an escape character in Salesforce.
• The Salesforce regular expression engine matches an entire string as opposed to searching for a match within a string. For example,
if you are searching for the name Marc Benioff, use the regular expression, .*Marc Benioff.*, to find a match in a string like
the following:
According to Marc Benioff, the social enterprise increases customer success.

If you use the regular expression, Marc Benioff, the only string that this regular expression will match is:
Marc Benioff

• Capture groups and substitutions are ignored.

• This function is available everywhere formulas exist except formula fields and custom buttons and links.

Example: Validation Rule Example

This example ensures that a custom field called SSN matches a regular expression representing a valid social security number
format of the form 999-99-9999.

NOT(
OR(
LEN (SSN__c) = 0,
REGEX(SSN__c, "[0-9]{3}-[0-9]{2}-[0-9]{4}")
)
)

REQUIRESCRIPT
Returns a script tag with source for a URL you specify. Use this function when referencing the Lightning Platform AJAX Toolkit or other
JavaScript toolkits.

440
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
{!REQUIRESCRIPT(url)} and replace url with the link for the script that is required.
For the AJAX Toolkit:
{!requireScript("/soap/ajax/13.0/connection.js")}

Returns:
<script src="/soap/ajax/13.0/connection.js"></script>

Tips
• Use global variables to access special merge fields for s-controls.
• Use this function when creating custom buttons or links where you have set Behavior to "Execute JavaScript" and Content
Source to "OnClick JavaScript" because the script tag must be outside the OnClick code.
• This function is only available for custom buttons and links that have Content Source set to "OnClick JavaScript."
• When working in Visualforce, use INCLUDESCRIPT instead.

Example: Custom Button Example

{!REQUIRESCRIPT("/soap/ajax/13.0/connection.js")}
var c = new sforce.SObject("Case");
c.id = "{!Case.Id}";
c.Status = "New";
result = sforce.connection.update([c]);
window.location.reload();

This example sets the Status of a case to “New” whenever a user clicks a custom button from the case detail page. To set this
up in your organization, define a custom button for cases that has the following attributes:
• Display Type is “Detail Page Button”
• Behavior is “Execute JavaScript”
• Content Source is “OnClick JavaScript”
Next, paste the content above into your custom button definition and add it to your case page layouts.

REVERSE
Returns the characters of a source text string in reverse order.

Use
REVERSE(text) and replace text with the text string that you want returned in the reverse order.

Example: Formula ExampleREVERSE(Sample) returns the text elpmaS.

RIGHT
Returns the specified number of characters from the end of a text string.

441
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
RIGHT(text, num_chars) and replace text with the field or expression you want returned; replace num_chars with the
number of characters from the right you want returned.

Tips
• Reference auto-number fields as text fields in formulas.
• If the num_chars value is less than zero, Salesforce replaces the value with zero.

Example: Formula ExampleTRIM(LEFT(LastName, 5))&"-"&TRIM(RIGHT(SSN__c, 4)) displays the first

five characters of a name and the last four characters of a social security number separated by a dash. Note that this assumes you
have a text custom field called SSN

ROUND
Returns the nearest number to a number you specify, constraining the new number by a specified number of digits.

Use
ROUND(number, num_digits) and replace number with the field or expression you want rounded; replace num_digits
with the number of decimal places you want to consider when rounding.

Example: ROUND (1.5, 0) = 2

ROUND (1.2345, 0) = 1
ROUND (-1.5, 0) = -2
ROUND (225.49823, 2) = 225.50

Example: Simple Discounting Example

ROUND(Amount-Amount* Discount_Percent__c,2)
Use this formula to calculate the discounted amount of an opportunity rounded off to two digits. This example is a number formula
field on opportunities that uses a custom percent field called Discount Percent.

RPAD
Inserts characters that you specify to the right-side of a text string.

Use
RPAD(text, padded_length[, 'pad_string']) and replace the variables:
• text is the field or expression after which you want to insert characters.
• pad_length is the number of total characters in the text string that will be returned.
• pad_string is the character or characters to insert. pad_string is optional and defaults to a blank space.
If the value in text is longer than pad_string, text is truncated to the size of padded_length.

Tips
Ending blank spaces are omitted.

442
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Field Name Example: Padding Default

RPAD(Name, 20) truncates the Name field after 20 characters. For example, if the name is mycompany.com, the value
returned is “mycompany.com.”

Example: My Company Example: No Change

RPAD('my_company.com', 14, 'z') returns “my_company.com” without change because it has 14 characters.

Example: Field Name Example: Padding with a Character

RPAD(Name, 15, 'z') returns “mycompany.comz” .

Example: Field Name Example: Truncating

RPAD(Name, 2) truncates the name after the second character. For example, if the name is mycompany.com, the value
returned is “my.”

SECOND
Returns a seconds value in the form of a number from 0 through 60.

Use
SECOND(time) and replace time with a time value or value such as TIMENOW().

Example: Formula ExampleSECOND(ClosedDate) displays only the seconds in a time field based on the value of the
Time Closed field.
SECOND(TIMEVALUE("17:30:45.125")) returns 45.

SQRT
Returns the positive square root of a given number.

Use
SQRT(number) and replace number with the field or expression you want computed into a square root.

Tips
• Calculating the square root of a negative number results in an error on the detail page.
• Avoid division by zero errors by including an IF function such as: IF(Amplitude__c >= 0, SQRT(Amplitude__c),
null).

Example: Square Root Example

SQRT(25)returns the square root of 25, which is 5.

Example: Amplitude Example

SQRT(Amplitude__c) returns the square root of a custom number field representing the amplitude of an earthquake.

443
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

SUBSTITUTE
Substitutes new text for old text in a text string.

Use
SUBSTITUTE(text, old_text, new_text) and replace text with the field or value for which you want to substitute
values, old_text with the text you want replaced, and new_text with the text you want to replace the old_text
.

Tips
• Each term provided in quotes is case-sensitive.
• If the old_text appears more than once, each occurrence is replaced with the new_text value provided, even when that
results in duplicates.

Example: String Example

SUBSTITUTE(Name, "Coupon", "Discount")returns the name of an opportunity that contains the term “Coupon”
with the opportunity name plus “Discount” wherever the term “Coupon” existed.
SUBSTITUTE(Email, LEFT(Email, FIND("@", Email)), "www.") finds the location of the @ sign in a
person's email address to determine the length of text to replace with a “www.” as a means of deriving their website address.

TEXT
Converts a percent, number, date, date/time, or currency type field into text anywhere formulas are used. Also, converts picklist values
to text in approval rules, approval step rules, workflow rules, escalation rules, assignment rules, auto-response rules, validation rules,
formula fields, field updates, and custom buttons and links.

Use
TEXT(value) and replace value with the field or expression you want to convert to text format. Avoid using any special characters
besides a decimal point (period) or minus sign (dash) in this function.

Tips
• The returned text is not formatted with any currency, percent symbols, or commas.
• Values are not sensitive to locale. For example, 24.42 EUR is converted into the number 24.42.
• Percents are returned in the form of a decimal.
• Dates are returned in the form of YYYY-MM-DD, that is, a four-digit year and two-digit month and day.
• Date/time values are returned in the form of YYYY-MM-DD HH:MM:SSZ where YYYY is a four-digit year, MM is a two-digit month,
DD is a two-digit day, HH is the two-digit hour, MM are the minutes, SS are the seconds, and Z represents the zero meridian indicating
the time is returned in UTC time zone.
• Picklist fields are supported in TEXT functions used in these kinds of formulas: validation rules, approval rules, approval step rules,
workflow rules, escalation rules, assignment rules, auto-response rules, formula fields, field updates, and custom buttons and links.
In other formulas, use ISPICKVAL or CASE when referencing a picklist field.
• If the text value you enter is a URL, the text automatically converts as a hyperlink.
• When converting decimal results to text in Lightning, leading zeros are removed. When converting decimal results to text in Classic,
leading zeros are retained.

444
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Expected Revenue in Text Example

TEXT(ExpectedRevenue) returns the expected revenue amount of an opportunity in text format without a dollar sign. For
example, if the Expected Revenue of a campaign is "$200,000," this formula field displays “200000.”

Example: Asset ID Example

SerialNumber &"-"& TEXT(Quantity) returns an asset ID number starting with the serial number and ending with
the quantity separated by a dash. The Serial Number field is already text but the Quantity field is a number, requiring
the TEXT function before it.

Example: Picklist Values in Math Equations Example

VALUE(LEFT(TEXT(Quantity), 5)) * Unit

This formula multiplies the first five numbers of the Quantity picklist by the Unit numeric field.

Example: Compare Two Picklists Example

IF(TEXT(bug_status) = TEXT(case_status), "Match", "Out of Sync")

This formula compares the values of the bug_status picklist with values of the case_status picklist.

Example: Picklist Values from Parent Records Example

TEXT(Account.Industry)

This formula field on opportunities shows the industry of the associated account.

Example: Concatenate Picklist Values Example

TEXT(Account.Industry) & " - " & TEXT(Account.SubIndustry__c)

This formula field on opportunities shows the industry and subindustry of the associated account.

Example: Validation Rule Example: Block the Save of a Closed Opportunity

CONTAINS(TEXT(Status), "Closed") returns TRUE if the Status picklist contains the value “Closed,” such as
“Closed Won” and “Closed Lost.” This validation rule formula blocks users from saving changes to a closed opportunity.

Example: Validation Rule Example: Use Numeric Functions on Numeric Picklist Values
VALUE(LEFT(TEXT(Quantity), 5)) * Unit > 10000 multiplies the first five numbers of the Quantity picklist
by the Unit numeric field, and returns TRUE if the result is greater than 10,000.

Example: Directly Compare Two Picklists Example

TEXT(bug_status) = TEXT(case_status) compares the values of the bug_status picklist with values of the
case_status picklist, and returns TRUE if they are equal.

TIMENOW
Returns a time value in GMT representing the current moment. Use this function instead of the NOW function if you only want to track
time, without a date.

445
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use
TIMENOW()

Tips
• Do not remove the parentheses.
• Keep the parentheses empty. They do not need to contain a value.
• Use TODAY if you prefer to use a date field.
• The displayed value is based on the organization’s Locale settings.

Example: Formula ExampleIF(ISPICKVAL( Rating , "Hot"), TIMENOW(),

TIMEVALUE(CreatedDate))
This formula checks to see if a lead is rated “Hot” and if so, returns the current time. Otherwise it returns the time since someone
created the lead.

TIMEVALUE
Returns the local time value without the date, such as business hours.

Use
TIMEVALUE(value) and replace value with a date/time or text value, merge field, or expression.

Tips
• The displayed value is based on the organization’s Locale settings.
• Don’t use TIMEVALUE on a time field. A time field’s value is already in time format. For example, for a time field with API name
timefield__c, TIMEVALUE(timefield__c) doesn’t do anything.

Example: Time Example

TIMEVALUE(ClosedDate) displays a time value based on the value of the Date/Time Closed field.
TIMEVALUE("17:30:45.125") returns 5:30 PM.

TODAY
Returns the current date as a date data type.

Use
TODAY()

Tips
• Do not remove the parentheses.
• Keep the parentheses empty. They do not need to contain a value.
• Use a date field with a TODAY function instead of a date/time field. Last Activity Date is a date field whereas Created
Date and Last Modified Date are date/time fields.

446
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• See NOW if you prefer to use a date/time field.

• Dates and times are always calculated using the user’s time zone.
• Use addition and subtraction operators with a TODAY function and other date fields to return a number, representing number of
days. For example TODAY()-LastActivityDate calculates the number of days since the last activity date. In this example,
the formula field data type is a number.
• Use addition and subtraction operators with a TODAY function and numbers to return a date. For example TODAY() +5 calculates
the date five days ahead of today. In this example, the formula field data type is a date.

Example: Formula ExampleTODAY()-Sample_date_c calculates how many days in the sample are left.

Example: Validation Rule Example

SampleDate < TODAY()

This example ensures that users cannot change the Sample Date to any date in the past.

TRIM
Removes the spaces and tabs from the beginning and end of a text string.

Use
TRIM(text) and replace text with the field or expression you want to trim.

Example: Formula ExampleTRIM(LEFT(LastName,5))& "-" & RIGHT(FirstName, 1) returns a network

ID for users that contains the first five characters of their last name and first character of their first name separated by a dash.

UPPER
Converts all letters in the specified text string to uppercase.
Any characters that are not letters are unaffected by this function. Locale rules are applied if a locale is provided.

Use
UPPER(text, [locale]) and replace text with the field or expression you wish to convert to uppercase, and locale with
the optional two-character ISO language code or five-character locale code, if available.

Example: MYCOMPANY.COM Example

UPPER("mycompany.com") returns “MYCOMPANY.COM.”

Example: MYCOMPANY.COM 123 Example

UPPER("Mycompany.com 123") returns “MYCOMPANY.COM 123.”

Example: Turkish Language Locale Rules Example

The Turkish language has two versions of the letter i: one dotted and one dotless. The locale rules for Turkish require the ability to
capitalize the dotted i, and allow the dotless I to be lowercase. To correctly use the UPPER() function with the Turkish language
locale, use the Turkish locale code tr in the UPPER() function as follows:
UPPER(text, "tr")
This ensures that any dotted i in the text does not transform to a dotless I.

447
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

URLENCODE
Encodes text and merge field values for use in URLs by replacing characters that are illegal in URLs, such as blank spaces, with the code
that represent those characters as defined in RFC 3986, Uniform Resource Identifier (URI): Generic Syntax.
For example, blank spaces are replaced with %20, and exclamation points are replaced with %21.

Use
{!URLENCODE(text)} and replace text with the merge field or text string that you want to encode.

Tips
• This function is only available in custom buttons and links, and in Visualforce.
• Custom buttons and links with URL content sources have separate encoding settings. If you use the URLENCODE function to encode
a custom button or link that has an encoding setting specified, Salesforce first encodes the URL according to the custom button or
link setting, then encodes the result. For example, if the URL in a custom link contains a space and its encoding setting is UTF8,
Salesforce first encodes the space to a plus sign (+), then the URLENCODE function converts the plus sign to its character code, %2B.
• When you include the standard Account field on opportunities (Opportunity.Account) in the URLENCODE function, the
value of the field is the account ID, not the account name. To encode the account name, create a custom cross-object formula field
on opportunities that spans to the account name, and use that field in the URLENCODE function instead of
Opportunity.Account. For example, if the cross-object formula is AccountNameFormula__c, use the following:

http://www.google.com/search?q={!URLENCODE
(Opportunity.AccountNameFormula__c)}

Example: Merge Field Example

If the merge field foo__c contains <B>Mark's page<b>, {!URLENCODE(foo_c)} results in:
%3CB%3EMark%27s%20page%3C%2Fb%3E

URLFOR
Returns a relative URL for an action, s-control, Visualforce page, or a file in a static resource archive in a Visualforce page.

Use
{!URLFOR(target, [id], [inputs], [no override])} and replace target with the URL or action, s-control,
or static resource merge variable, id with an optional reference to the record, and inputs with any optional parameters. The no
override argument is also optional and defaults to “false.” It applies to targets for standard Salesforce pages such as
$Action.Account.New. Replace no override with “true” when you want to display a standard Salesforce page regardless of whether
you have defined an override for it elsewhere.
The input values can be dynamic. For example, to include an account ID, specify:
{!URLFOR($Page.myVisualforcePage, null, [accountId=Account.Id])}

The resulting URL includes a parameter with the ID, such as:
https://instance.salesforce.com/apex/myVisualforcePage?accountId=001B0000002txol

You can also use non-string variables, like an SObject variable. For example, if you supply [myAccountParam=Account], the
value is converted to a string, and the URL contains ?MyAccountParam=001B0000002txol. You can also use a parameter to
supply a static value, such as [param1=55].

448
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Note: Because parameter names are static, you can’t use a variable to determine the parameter name. For example, if you use
[myVariable=”value”] and set myVariable to “param1”, the resulting URL includes ?myVariable=value1
and not the param1 value.

Tips
• Use global variables to access special merge fields for actions, s-controls, and static resources.
• If an input parameter name begins with any character other than a letter or dollar sign ($), enclose it in quotation marks.
• Enclose multiple inputs in brackets to indicate they are together:
{!URLFOR($Action.Case.View, Case.Id, [param1="A", param2="B"])}

• Set inputs to null if you do not have any to pass yet you want to set the no override argument:
{!URLFOR($Action.Case.View, Case.Id, null, true)}

• When you override a standard action, that action is no longer available in Salesforce. For example, if you override the new account
action, that affects the New button on all pages, such as the account detail page, account related lists on other detail pages, and
the Create New dropdown list in the sidebar. To override a standard action yet still access it, use the no override argument in
your s-control to reference that action.
• When you override the tab home page for a standard or custom tab, use the tab’s $Action global variable as the target value,
and the tab’s object type for the id value. For example, URLFOR($Action.Account.Tab, $ObjectType.Account).
• This function is only available in custom buttons, links, s-controls, and Visualforce pages.

Example: Visualforce Example

<apex:image url="{!URLFOR($Resource.TestZip,
'images/Bluehills.jpg')}" width="50" height="50"/>

In this example, the <apex:image> component references a .jpg file contained within a .zip file that has been uploaded as a
static resource. When uploaded, the name of the static resource was defined as TestZip, and the path to the image within the
resource is images/Bluehills.jpg.

VALUE
Converts a text string to a number.

Use
VALUE(text) and replace text with the field or expression you want converted into a number.

Tips
Make sure the text in a VALUE function doesn’t include special characters other than a decimal point (period) or minus sign (dash). If the
text in a VALUE function is a non-numerical/invalid format, the formula isn’t calculated and resolves to a blank value. For example, the
formula 1 + VALUE(Text_field__c) produces these results:
• If Text field is 123, the result is 124.
• If Text field is blank, the result is blank.
• If Text field is $123, the result is blank.
• If Text field is EUR123, the result is blank.

449
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Example: Lead Number Example

VALUE(Lead_Number__c) returns a number for the text value in the auto-number field Lead Number. This can be useful
if you want to use the Lead Number field in a calculation. Note that auto-number fields are actually text fields and must be
converted to a number for numeric calculations.

Example: Round Robin Lead Assignment Example

Round Robin Lead Assignment
MOD(VALUE(Lead_Number__c), 3)
This formula is for a custom formula field named Round_Robin_ID that assigns each lead a value of 0, 1, or 2. This formula uses a
custom auto-number field called Lead Number that assigns each lead a unique number starting with 1. The MOD function
divides the lead number by the number of lead queues available (three in this example) and returns a remainder of 0, 1, or 2. Use
the value of this formula field in your lead assignment rules to assign lead records to different queues. For example:
• Round_Robin_ID = 0 is assigned to Queue A
• Round_Robin_ID = 1 is assigned to Queue B
• Round_Robin_ID = 2 is assigned to Queue C

VLOOKUP
Returns a value by looking up a related value on a custom object similar to the VLOOKUP() Excel function. This function is only available
in validation rules.

Use
VLOOKUP (field_to_return, field_on_lookup_object, lookup_value). Replace field_to_return with the
field that contains the value you want returned, field_on_lookup_object with the field on the related object that contains
the value you want to match, and lookup_value with the value you want to match.

Tips
• field_to_return must be an auto number, roll up summary, lookup relationship, master-detail relationship, checkbox, date,
date/time, email, number, percent, phone, text, text area, or URL field type.
• field_on_lookup_object must be the Record Name field on a custom object.
• field_on_lookup_object and lookup_value must be the same data type.
• If more than one record matches, the value from the first record is returned.
• The value returned must be on a custom object.
• You can’t delete the custom field or custom object referenced in this function.

Example: Validation Rule Example

This example checks that a billing postal code is valid by looking up the first five characters of the value in a custom object called
Zip_Code__c that contains a record for every valid ZIP code in the US. If the ZIP code isn’t found in the Zip_Code__c object or
the billing state doesn’t match the corresponding State_Code__c in the Zip_Code__c object, an error displays.
AND( LEN(BillingPostalCode) > 0, OR(BillingCountry = "USA", BillingCountry = "US"),
VLOOKUP( $ObjectType.Zip_Code__c.Fields.State_Code__c,
$ObjectType.Zip_Code__c.Fields.Name, LEFT(BillingPostalCode,5)) <>
BillingState )

450
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Note:
• Use this example when the billing country is US or USA.
• You can download US ZIP codes in CSV file format from http://zips.sourceforge.net.

SEE ALSO:
Validation Rules

WEEKDAY
Returns the day of the week for the given date, using 1 for Sunday, 2 for Monday, through 7 for Saturday.

Use
WEEKDAY(date)

Example: Formula Example

WEEKDAY(customdate1__c) returns the day of the week for the given date in customdate1__c

YEAR
Returns the four-digit year in number format of a given date.

Use
YEAR(date) and replace date with the field or expression that contains the year you want returned.

Example: Formula Example

YEAR(TODAY())- YEAR(Initial_Meeting__c) returns the number of years since your initial meeting with a client.
This example uses a custom date field called Initial Meeting.

Using Date, Date/Time, and Time Values in Formulas

Date formulas are useful for managing payment deadlines, contract ages, or any other features of
EDITIONS
your organization that are time or date dependent.
Two data types are used for working with dates: Date and Date/Time. One data type, Time, is Available in: both Salesforce
independent of the date for tracking time such as business hours. Most values that are used when Classic and Lightning
working with dates are of the Date data type, which store the year, month, and day. Some fields, Experience
such as CreatedDate, are Date/Time fields, meaning they not only store a date value, but also
Available in: All Editions
a time value (stored in GMT but displayed in the users’ time zone). Date, Date/Time, and Time fields
are formatted in the user’s locale when viewed in reports and record detail pages. A Time value’s
precision is in milliseconds. A Date/Time value’s precision is in seconds.
You can use operations like addition and subtraction on Date, Date/Time, and TIme values to calculate a future date or elapsed time
between two dates or times. If you subtract one date from another, for example, the resulting value will be the difference between the
two initial values in days (Number data type). The same operation between two Date/Time values returns a decimal value indicating
the difference in number of days, hours, and minutes. The same operation between two Time values returns millisecond

451
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

For example, if the difference between two Date/Time values is 5.52, that means the two values are separated by five days, 12 hours (0.5
of a day), and 28 minutes (0.02 of a day). You can also add numeric values to Dates and Date/Times. For example, the operation TODAY()
+ 3 returns three days after today’s date. For more information and examples of working with dates, see the list of Sample Date
Formulas.
Throughout the examples, the variables date and date/time are used in place of actual Date and Date/Time fields or values.
Keep in mind that complex date functions tend to compile to a larger size than text or number formula functions, so you might run into
issues with formula compile size. See Tips for Reducing Formula Size for help with this problem.

TODAY(), NOW() and TIMENOW()

The TODAY() function returns the current day, month, and year as a Date data type. This function is useful for formulas where you are
concerned with how many days have passed since a previous date, the date of a certain number of days in the future, or if you just want
to display the current date.
The NOW() function returns the Date/Time value of the current moment. It’s useful when you are concerned with specific times of day
as well as the date.
The TIMENOW() function returns a value in GMT representing the current time without the date. Use this function instead of the
NOW() function if you want the current hour, minute, seconds, or milliseconds. This value is useful for tracking time like work shifts or
elapsed time,
For details on how to convert between Date values and Date/Time values, see Converting Between Date/Time and Date on page 452.

The DATE() Function

The DATE() function returns a Date value, given a year, month, and day. Numerical Y/M/D values and the YEAR(), MONTH(), and
DAY() functions are valid parameters for DATE(). For example DATE( 2013, 6, 1 ) returns June 1, 2013. Similarly, DATE(
YEAR( TODAY() ), MONTH( TODAY() ) + 3, 1) returns the Date value of the first day three months from today in the
current year, assuming the date is valid (for example, the month falls between 1 and 12).
If the inputted Y/M/D values result in an invalid date, the DATE() function returns an error, so error checking is an important part of
working with Date values. You can read about methods for handling invalid dates in Sample Date Formulas.

Converting Between Date/Time and Date

Date and Date/Time aren’t interchangeable data types, so when you want to perform operations between Date and Date/Time values,
you need to convert the values so they are both the same type. Some functions (such as YEAR(), MONTH(), and DAY()) also only
work on Date values, so Date/Time values must be converted first.
Use the DATEVALUE( date/time ) function to return the Date value of a Date/Time. For example, to get the year from a
Date/Time, use YEAR( DATEVALUE( date/time ) ) ).
You can convert a Date value to a Date/Time using the DATETIMEVALUE( date ) function. The time will be set to 12:00 a.m. in
Greenwich Mean Time (GMT), and then converted to the time zone of the user viewing the record when it’s displayed. For a user located
in San Francisco, DATETIMEVALUE( TODAY() ) returns 5:00 p.m. on the previous day (during Daylight Saving Time) rather than
12:00 a.m. of the current day. See A Note About Date/Time and Time Zones on page 454 for more information.

Converting Between Date/Time and Time

The TIMEVALUE() function returns a Time data type value in “HH:MM:SS.MS” (hours:minutes:seconds.milliseconds) format using a
24-hour clock. Numerical H/M/S/MS values and the HOUR(), MINUTE(), SECONDS(), and MILLISECONDS() functions are
valid parameters for TIMEVALUE().

452
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Use the TIMEVALUE(value) function to return the Time value of a Date/Time type, text, merge field or expression. For example,
extract the time from a ClosedDate Date/Time value with TIMEVALUE(ClosedDate).

Converting Between Date and Text

If you want to include a date as part of a string, wrap the Date value in the TEXT() function to convert it to text. For example, if you
want to return today’s date as text, use:
"Today's date is " & TEXT( TODAY() )

This returns the date in the format “YYYY-MM-DD” rather than in the locale-dependent format. You can change the format by extracting
the day, month, and year from the date first and then recombining them in the format you want. For example:

"Today's date is " & TEXT( MONTH( date ) ) & "/" & TEXT( DAY( date ) ) & "/" & TEXT( YEAR(
date ) ) )

You can also convert text to a Date so you can use the string value with your other Date fields and formulas. You’ll want your text to be
formatted as “YYYY-MM-DD”. Use this formula to return the Date value:
DATEVALUE( "YYYY-MM-DD" )

Converting Between Date/Time and Text

You can include Date/Time values in a string using the TEXT() function, but you need to be careful of time zones. For example,
consider this formula:
"The current date and time is " & TEXT( NOW() )

In this formula, NOW() is offset to GMT. Normally, NOW() would be converted to the user’s time zone when viewed, but because it’s
been converted to text, the conversion won’t happen. So if you execute this formula on August 1st at 5:00 PM in San Francisco time
(GMT-7), the result is “The current date and time is 2013–08–02 00:00:00Z”.
When you convert a Date/Time to text, a “Z” is included at the end to indicate GMT. TEXT( date/time ) returns “Z” if the field is
blank. So if the Date/Time value you’re working with might be blank, check for this before converting to text:
IF(
ISBLANK( date/time ),
"",
TEXT( date/time )
)

To convert a string to a Date/Time value, use DATETIMEVALUE() passing in a string in the format “YYYY-MM-DD HH:MM:SS”. This
method returns the Date/Time value in GMT.

Converting Between Time and Text

If you want to include time as part of a string, wrap the Time value in the TEXT() function to convert it to text. For example, if you
want to return the current time as text, use:
"The time is " & TEXT( TIMENOW() )

This function returns the time in the format “HH:MM:SS.MS”.

453
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

You can also convert text to a Time data type so you can use the string value with your other Time fields and formulas. Format your text
as “HH:MM:SS.MS” on a 24-hour clock. Use the TIMEVALUE() function:

TIMEVALUE("17:30:45.125")

A Note About Date/Time and Time Zones

Date and Date/Time values are stored in GMT. When a record is saved, field values are adjusted from the user’s time zone to GMT, and
then adjusted back to the viewer’s time zone when displayed in record detail pages and reports. With Date conversions this doesn't
pose a problem, since converting a Date/Time to a Date results in the same Date value.
When working with Date/Time fields and values, however, the conversion is always done in GMT, not the user’s time zone. Subtracting
a standard Date/Time field from another isn’t a problem because both fields are in the same time zone. When one of the values in the
calculation is a conversion from a Text or Date value to a Date/Time value, however, the results are different.
Let’s say a San Francisco user enters a value of 12:00 AM on August 2, 2013 in a custom Date/Time field called Date_Time_c. This
value is stored as 2013–08–02 07:00:00Z, because the time difference in Pacific Daylight Time is GMT-7. At 12:00 p.m. PDT on August
1st, the user views the record and the following formula is run:
Date_Time_c - NOW()

In the calculation, NOW() is 2013–08–01 19:00:00Z, and then subtracted from 2013–08–02 07:00:00Z, to return the expected result of
0.5 (12 hours).
Suppose that instead of NOW(), the formula converts the string “2013–08–01 12:00:00” to a Date/Time value:
Date_Time_c - DATETIMEVALUE( "2013-08-01 12:00:00" )

In this case, DATETIMEVALUE( “2013–08–01 12:00:00” ) is 2013–08–01 12:00:00Z, and returns a result of 0.79167, or
19 hours.
There’s no way to determine a user’s time zone in a formula. If all of your users are in the same time zone, you can adjust the time zone
difference by adding or subtracting the time difference between the users’ time zone and GMT to your converted values. However, since
time zones can be affected by Daylight Saving Time, and the start and end dates for DST are different each year, this is difficult to manage
in a formula. We recommend using Apex for transactions that require converting between Date/Time values and Text or Date values.

SEE ALSO:
Tips for Building Formulas
Time Custom Field

454
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Build a Formula Field

Your custom formula fields require special attributes.
EDITIONS
Note: The Getting Started with Formulas (Salesforce Classic) help video includes a live demo
of these steps. Available in: both Salesforce
Classic (not available in all
1. Begin building a formula field the same way you create a custom field. See Create Custom Fields orgs) and Lightning
on page 237. Experience
2. Select the data type for the formula. Choose the appropriate data type for your formula based
Available in: All Editions
on the output of your calculation. See Formula Data Types on page 385.
3. Choose the number of decimal places for currency, number, or percent data types. This setting
USER PERMISSIONS
is ignored for currency fields in multicurrency organizations. Instead, the Decimal Places
for your currency setting apply. Salesforce uses the round half up tie-breaking rule for numbers To view formula field details:
in formula fields. For example, 12.345 becomes 12.35 and −12.345 becomes −12.35. • View Setup and
4. Click Next. Configuration

5. Build your formula. Formula fields can contain up to 3,900 characters, including spaces, return To create, change, or delete
formula fields:
characters, and comments. If your formula requires more characters, create separate formula
• Customize Application
fields and reference them in another formula field. The maximum number of displayed characters
after an evaluation of a formula expression is 1,300
a. If you are building a formula in the Advanced Formula tab or for approvals or rules, such as workflow, validation, assignment,
auto-response, or escalation, click Insert Field, choose a field, and click Insert. To create a basic formula that passes specific
Salesforce data, select the Simple Formula tab, choose the field type in the Select Field Type drop-down list, and
choose one of the fields listed in the Insert Field drop-down list. Build cross-object formulas to span to related objects
and reference merge fields on those objects.
b. To insert an operator, choose the appropriate operator icon from the Insert Operator drop-down list.
c. Optionally, click the Advanced Formula tab to use functions and view other operators and merge fields. Functions are prebuilt
formulas that you can customize with your input parameters.
d. To insert a function, double-click its name in the list, or select it and click Insert Selected Function. To filter the list of functions,
choose a category from the Functions drop-down list. Select a function and click Help on this function to view a description
and examples of formulas using that function.
e. Consider adding comments to your formula, especially if it is complicated. Comments must begin with a forward slash followed
by an asterisk (/*), and conclude with an asterisk followed by a forward slash (*/).
Comments are useful for explaining specific parts of a formula to anyone viewing the formula definition. For example:
AND(
/*competitor field is required, check to see if field is empty */
LEN(Competitor__c) = 0,
/* rule only enforced for ABCD record types */
RecordType.Name = "ABCD Value",
/* checking for any closed status, allows for additional closed picklist values in
the future */
CONTAINS(TEXT(StageName), "Closed")
)

6. To check your formula for errors, click Check Syntax.

7. Optionally, enter a description of the formula in the Description box.

455
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

8. If your formula references any number, currency, or percent fields, choose an option for handling blank fields. To give any blank
fields a zero value, choose Treat blank fields as zeros. To leave these fields blank, choose Treat blank fields
as blanks.
9. Click Next.
10. Set the field-level security to determine whether the field should be visible for specific profiles, and click Next.
11. Choose the page layouts that should display the field. The field is added as the last field in the first two-column section on the page
layout. For user custom fields, the field is automatically added to the bottom of the user detail page.
12. Click Save to finish or Save & New to create more custom fields.

Note: Because formula fields are automatically calculated, they are read-only on record detail pages and do not update last
modified date fields. Formula fields are not visible on edit pages.
In account formulas, all business account fields are available as merge fields. However, account fields exclusive to person accounts
such as Birthdate and Email are not available.

Tips for Building Formulas

What Is a Cross-Object Formula?

SEE ALSO:
Elements of a Formula
Merge Fields for Formulas
Tips for Building Formulas
Formula Operators and Functions by Context

Tips for Building Formulas

Watch a Demo: Formulas: Tips and Gotchas (Salesforce Classic) EDITIONS
• Formula fields that a user can see may reference fields that are hidden or read only using
field-level security. If the formula field contains sensitive information, use field-level security to Available in: both Salesforce
hide it. Classic and Lightning
Experience
• You can add activity formula fields to task and event page layouts. Note that a task-related
formula field on an event page layout may not be useful. Likewise, event-related formula fields Available in: All Editions
on task page layouts may not be useful.
• To determine if a record is a task or event, use the IsTask merge field. For example:
IF(IsTask, "This is a task", "This is an event")

Tips for Working with Date and Date/Time Formula Fields

Tips for Working with Hyperlink Formula Fields
Use these tips to understand how links open from formula custom fields that contain a HYPERLINK function.
Tips for Using Merge Fields in Formulas
Tips for Working with Number Formula Fields
Useful tips for working with number fields.

456
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips for Working with Picklist and Multi-Select Picklist Formula Fields
Consider these tips when creating single- and multi-select picklist formula fields.
Tips for Referencing Record Types in Formulas
Reference record types in formulas if you want different workflow rules, validation rules, and lookup filters to apply to different record
types.
Tips for Working with Text Formula Fields

SEE ALSO:
Build a Formula Field
Common Formula Errors

Tips for Working with Date and Date/Time Formula Fields

• Dates and times are always calculated using the user’s time zone.
EDITIONS
• Date and date/time fields can’t be used interchangeably. The name alone may not indicate if
a field is a date or date/time. For example, Created Date and Last Modified Date Available in: both Salesforce
are date/time fields whereas Last Activity Date is a date field. Use the DATEVALUE Classic and Lightning
function to convert a date/time field into a date field. Experience

Note: The Created Date and Last Modified Date fields display only the Available in: All Editions
date, not the date and time.

• Use addition and subtraction operators with date or date/time fields to calculate duration. For example, subtract a date from another
date to calculate the number of days between the two. Likewise, you can subtract the date/time from another date/time to get the
number of days between the two as a number. See NOW or TODAY for suggested use.
• Use addition and subtraction operators with numbers to return another date or date/time. For example, {!CreatedDate} +
5 calculates the date and time five days after a record’s created date. Note that the expression returns the same data type as the
one given; a date field plus or minus a number returns a date, and a date/time field plus or minus a number returns a date/time.
• When calculating dates using fractions, Salesforce ignores any numbers beyond the decimal. For example:
TODAY() + 0.7 is the same as TODAY() + 0, which is today’s date.
TODAY() + 1.7 is the same asTODAY() + 1, which is tomorrow’s date.
TODAY() + (-1.8) is the same as TODAY() + (-1), which is yesterday’s date.

• To calculate the value of two fractions first, group them within parentheses. For example:
TODAY() + 0.5 + 0.5 is the same as TODAY() + 0 + 0, which is today’s date.
TODAY() + (0.5+0.5) is the same as TODAY() + 1, which is tomorrow’s date.

• Years can’t be zero and must be between -4713 and 9999.

SEE ALSO:
Tips for Building Formulas

457
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips for Working with Hyperlink Formula Fields

Use these tips to understand how links open from formula custom fields that contain a HYPERLINK
EDITIONS
function.
If you have formula custom fields that contain a HYPERLINK function, the server generates an Available in: both Salesforce
HTML anchor for the link. For example, this function: HYPERLINK("/apex/VF_TEST", Classic and Lightning
"VFLINK",'_self') generates this HTML output: <a href="/apex/VF_TEST" Experience
target="_self">VFLINK</a>. If the HYPERLINK function doesn't contain a target Available in: All Editions
attribute, it defaults to a value of target="_blank" in the generated HTML. A value of
"_blank" opens the link in a new window or tab, outside of Lightning Experience or the Lightning
Console.

Note: The HYPERLINK function doesn’t support the biztel protocol on record home pages for custom objects in Lightning
Experience.
The Lightning Experience Honors Target Values for Hyperlinks in Formula Fields critical update ensures that the target value
for hyperlinks is honored, whether it's explicitly configured or set by default. If you have enabled the critical update, you can keep the
target page within Lightning navigation by adding a value of target="_self" to your formula field HYPERLINK functions. If
you specify something other than target="_self", the link opens with standard browser navigation outside of Lightning Experience.
If you haven’t enabled the critical update, relative links open in a new tab regardless of the target value.

Note: This critical update is automatically enabled in Summer ’20. Both before and after enabling the critical update, external
links always open in a new tab, regardless of the target value.

Link Type Target Expected Behavior Example

Relative Visualforce page or _self The Visualforce page or image HYPERLINK("/apex/VFPAGE",
image opens in Lightning Experience "Visualforce Page",
or Console inside the same tab. "_self")

Relative Visualforce page or _blank The Visualforce page or image HYPERLINK("/img/logo214",

image opens outside of Lightning "Logo", "_blank")
Experience or Console in a new
tab.

Note: A critical update

that is available in Winter
’19 and automatically
enabled in Summer ’19
on May 17, 2019 controls
this behavior. If you don’t
enable the critical
update, these links open
inside Lightning
Experience or Console in
a new tab.

External website _self The website opens in a new tab. HYPERLINK("https://salesforce.com",

"Salesforce",
"_self")

458
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Link Type Target Expected Behavior Example

External website _blank The website opens in a new tab. HYPERLINK("https://salesforce.com",
"Salesforce",
"_blank")

Tips for Using Merge Fields in Formulas

• Delegated administrators need to have access to custom objects to access the objects’ merge
EDITIONS
fields from formulas.
• In account formulas, all business account fields are available as merge fields. However, account Available in: both Salesforce
fields exclusive to person accounts such as Birthdate and Email are not available. Classic and Lightning
• You can’t use formula fields that include related object merge fields in roll-up summary fields. Experience

• Formulas and roll-up summary fields can’t reference fields on external objects. Available in: All Editions
• Using RecordType.Id can make your formula less readable; when you do use it, write
in-line comments into the formula to clarify.
• To determine if a record is a task or event, use the IsTask merge field. For example:
IF(IsTask, "This is a task", "This is an event")

• To reference the unique identifier for your Salesforce organization in a formula, insert the $Organization.Id merge field. This
merge field can display anywhere formula fields can except in reports.
• Some merge fields display as radio buttons but function like picklist fields when referenced in a formula.
Use the values “Read,” “Edit,” and “None” in a formula when referencing:
– $UserRole.CaseAccessForAccountOwner
– $UserRole.OpportunityAccessForAccountOwner
– CaseAccessLevel (on Territory)
– OpportunityAccessLevel (on Territory)
Use the values “Read,” “Edit,” and “All” in a formula when referencing:
– AccountAccessLevel (on Territory)

• If you create a contacts formula field that references account merge fields, that field can be included in contact page layouts but
should not be included in person accounts page layouts. The formula field will display a value of #Error on the person accounts
page.

SEE ALSO:
Tips for Building Formulas

459
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips for Working with Number Formula Fields

Useful tips for working with number fields.
EDITIONS
• Use the decimal version of a percent when working with percent fields in formulas. For example,
IF(Probability =1...) for 100% probability or IF(Probability =0.9...) Available in: both Salesforce
for 90% probability. Classic and Lightning
Experience
• Reference auto-number fields as text fields in formulas.
• The output of your formula must be less than 19 digits. Available in: All Editions
• Formulas can contain a mix of numbers, percents, and currencies as in this example:
AnnualRevenue / NumberOfEmployees.
• Salesforce uses the round half up tie-breaking rule for numbers in formula fields. For example, 12.345 becomes 12.35 and −12.345
becomes −12.35.

SEE ALSO:
Tips for Building Formulas

Tips for Working with Picklist and Multi-Select Picklist Formula Fields
Consider these tips when creating single- and multi-select picklist formula fields.
EDITIONS
• You can use special picklist fields in your formulas, such as IsEscalated for cases and
IsWon for opportunities. Available in: both Lightning
• Picklist fields can only be used in these functions. Experience and Salesforce
Classic
– ISPICKVAL—Compares the value of a picklist to a single value.
Available in: All Editions
– CASE—Compares the value of a picklist to multiple values.
– TEXT—Returns a picklist value’s API Name so that you can work with a reference to the
value (even if the displayed value changes) in functions that support text values, such as CONTAINS. (Available in only flow
formula resources, formula fields, validation rules, and workflow field updates.)

• Multi-select picklist fields can only be used in these functions:

– CONTAINS (in Process Builder in which the criteria for executing actions are set to Conditions are met)
– INCLUDES
– ISBLANK
– ISNULL
– ISCHANGED (Only in assignment rules, validation rules, workflow field updates, and workflow rules in which the evaluation
criteria are set to Evaluate the rule when a record is: created, and every time it’s edited)
– PRIORVALUE (Only in assignment rules, validation rules, workflow field updates, and workflow rules in which the evaluation
criteria are set to Evaluate the rule when a record is: created, and every time it’s edited)

For more details about the functions, see Formula and Operator Functions.

SEE ALSO:
Tips for Building Formulas

460
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Tips for Referencing Record Types in Formulas

Reference record types in formulas if you want different workflow rules, validation rules, and lookup
EDITIONS
filters to apply to different record types.
For example, you can: Available in: both Salesforce
Classic and Lightning
• Create a workflow rule on accounts that emails different teams based on the account record
Experience
type the user selects when creating the account.
• Create a validation rule on opportunities that allows only members of the North American sales Available in: All Editions
team to save opportunities with the Domestic record type. Record types available in:
When possible, use RecordTypeId instead of RecordType.Name to reference a specific Professional, Enterprise,
record type. While RecordType.Name makes a formula more readable, you must update the Performance, Unlimited,
formula if the name of the record type changes, whereas the ID of a record type never changes. and Developer Editions
Also, RecordType.Name requires a cross-object reference to the record type, while
RecordTypeId doesn’t. However, if you are deploying formulas across organizations (for
example, between sandbox and production), use RecordType.Name because IDs are not the same across organizations.
Avoid using $RecordType in formulas, except in default value formulas. Instead, use the RecordType merge field (for example,
Account.RecordType.Name) or the RecordTypeId field on the object.

SEE ALSO:
Tips for Building Formulas

Tips for Working with Text Formula Fields

• Before using the HYPERLINK function, consider the differences between hyperlinks and custom
EDITIONS
links.
– Hyperlink formula fields are just like other custom fields that you can show in list views and Available in: both Salesforce
reports. Classic and Lightning
Experience
– Custom links appear on detail pages in a predefined section; hyperlink formula fields can
appear on a detail page wherever you specify. Available in: All Editions
– Using custom links, you can specify display properties such as window position and opening
in a separate popup position. Hyperlink formula fields open in a new browser window by
default or you can specify a different target window or frame.
– Your formulas can reference custom links. Before deleting a custom link, make sure that it’s not referenced in a formula field.
– Hyperlink formula fields that contain relative URLs to Salesforce pages, such as /rpt/reportwizard.jsp, can be added
to list views, reports, and related lists. However, use a complete URL, including the server name and https://, in your hyperlink
formula before adding it to a search layout.

• To insert text in your formula field, surround the text with quotation marks. For example, to display “CASE: 123,” use this formula
"CASE: "& CaseNumber__c.
• If a formula field is used in a Classic email template, surround empty spaces with quotation marks. Otherwise, use BR(). For example,
use this formula for Classic email templates: TEXT( Amount ) &“ ”& TEXT( CloseDate ) &“ ”& TEXT(
CreatedDate )
• Use the backslash (\) character before a quote or backslash to insert it as a literal value in your output. For example,
"Trouble\\Case \"Ticket\": " in your formula displays Trouble\Case "Ticket": on detail pages.

461
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• In Salesforce Classic, Knowledge articles show URLs from Formula (Text) fields as plain text. In Lightning Experience, Knowledge
articles show such URLs as clickable links.

SEE ALSO:
Tips for Building Formulas

What Is a Cross-Object Formula?

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: both Salesforce
A Cross-object formula is a formula that spans two related objects and references merge fields on Classic and Lightning
Experience
those objects. A cross-object formula can reference merge fields from a master (“parent”) object if
an object is on the detail side of a master-detail relationship. A cross-object formula also works with Available in: all editions
lookup relationships.
You can reference fields from objects that are up to 10 relationships away. A cross-object formula
is available anywhere formulas are used except when creating default values.

Note: If you create a formula that references a field on another object and display that formula in your page layout, users can see
the field on the object even if they don’t have access to that object record. For example, if you create a formula field on the Case
object that references an account field, and display that formula field in the case page layout, users can see this field even if they
don’t have access to the account record.
You can't include an object as the lookup field in a formula. To reference an object, reference the object's ID field or another field on the
object. For example, Account.Owner is invalid because it references the object directly. Account.Owner.FirstName or
Account.OwnerId are valid references for your formula.

Building Cross-Object Formulas in the Simple Formula Tab

Build Cross-Object Formulas in the Advanced Formula Tab
Create a cross-object formula when building a formula in the Advanced Formula tab or for approvals or rules, such as workflow,
validation, assignment, auto-response, or escalation rules.
Tips for Building Cross-Object Formulas

SEE ALSO:
Build a Formula Field

462
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Building Cross-Object Formulas in the Simple Formula Tab

To create a cross-object formula when building a formula in the Simple Formula tab, enter the
EDITIONS
relationship names of the objects to which you are spanning followed by the field you want to
reference. Separate the relationship names of each object and the field with periods. Available in: both Salesforce
Example: For example, enter Contact.Account.Name to reference the Account Classic and Lightning
Experience
Name for a contact associated with a case in a formula field on the Case object. Be sure to
use the relationship names of the objects, not the labels. Although the relationship name is Available in: All Editions
often the same as the object name, it is technically the field name of the relationship field.
To reference the parent account name from Account object, the syntax is Parent.Name, USER PERMISSIONS
not Account.Name. When referencing a custom object, add two underscores and the
letter r to its name. For example, Position__r.title__c references the Job Title To create or change
field (title__c) on a Position custom object. cross-object formulas:
• Customize Application
Note: If you create a formula that references a field on another object and display that
formula in your page layout, users can see the field on the object even if they don’t
have access to that object record. For example, if you create a formula field on the Case
object that references an account field, and display that formula field in the case page
layout, users can see this field even if they don’t have access to the account record.

SEE ALSO:
Build Cross-Object Formulas in the Advanced Formula Tab
What Is a Cross-Object Formula?

Build Cross-Object Formulas in the Advanced Formula Tab

Create a cross-object formula when building a formula in the Advanced Formula tab or for approvals
EDITIONS
or rules, such as workflow, validation, assignment, auto-response, or escalation rules.
Related objects are denoted by a “>” sign. Available in: both Salesforce
Classic and Lightning
Note: If you create a formula that references a field on another object and display that Experience
formula in your page layout, users can see the field on the object even if they don’t have
access to that object record. For example, if you create a formula field on the Case object that Available in: All Editions
references an account field, and display that formula field in the case page layout, users can
see this field even if they don’t have access to the account record. USER PERMISSIONS
Example: The value of the Profile.Name merge field differs depending on the context
To create or change
of the cross-object formula field that references it. On detail pages, the value is the profile cross-object formulas:
name, as expected. In list views and reports, the value is the internal value of the associated • Customize Application
profile instead. If you use Profile.Name in a formula, use it within an OR function to
ensure that the formula always returns the intended result. For example:

IF
(OR
(LastModifiedBy.Profile.Name = "Standard User",
LastModifiedBy.Profile.Name = "PT2"),
"Standard", "Not Standard")

463
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

None of the above applies to profile names referenced by the $Profile global variable.

SEE ALSO:
Building Cross-Object Formulas in the Simple Formula Tab
What Is a Cross-Object Formula?

Tips for Building Cross-Object Formulas

• Cross-object formulas that reference currency fields convert the value to the currency of the
EDITIONS
record that contains the formula. If the referenced currency field is from a custom setting, the
field value isn’t converted to the record’s currency. Available in: both Salesforce
• Salesforce allows a maximum of 10 unique relationships per object in cross-object formulas. Classic and Lightning
The limit is cumulative across all formula fields, rules, and lookup filters. For example, if two Experience
different formulas on opportunities reference two different fields of an associated account, only
Available in: All Editions
one unique relationship exists (from opportunities to accounts).
• You can’t reference cross-object formulas in roll-up summary fields.
• In cross-object formulas, you can’t reference merge fields for objects related to activities. For example, merge fields for contacts and
accounts aren’t available in task and event formulas.
• In cross-object formulas, you can’t reference fields from contacts through person accounts. For more information, see Using custom
formula fields with person accounts.

Using the Owner Field

Some objects support different object types for the Owner field, such as a User, Queue, or Calendar. When you create a cross-object
formula using Owner on such objects, be explicit about the owner type that you reference.
For example, for owner email where you don’t use queues, your formula is Owner:User.Email. If you do use queues, your formula
can be
IF( ISBLANK( Owner:User.Id ), Owner:Queue.QueueEmail, Owner:User.Email )

Here’s how to select Owner object fields on a Lead in the Advanced formula tab.

• Owner references aren’t supported in Visualforce pages. For example, on a page with Case as a controller, you can’t include
{!Case.Owner:User.FirstName}. However, you can include an existing spanning formula on a Visualforce page. For
example, if you have a custom text formula MyFormula__c on a Case with value Owner:User.FirstName, you can include
{!Case.MyFormula__c} on your Visualforce page.
• Owner references aren’t supported on the Queue object. For example, you can't reference Owner:Queue.Owner.Email.

464
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

• If your formula has Owner:User.fieldname and Owner:Queue.fieldname, they count against the limit of 10 unique
relationships per object in cross-object formulas.
• On objects that don’t support Queues, User is implicit when referencing Owner. Have your formula as Owner.fieldname, not
Owner:User.fieldname.

Using Profile.Name
The value of the Profile.Name merge field differs depending on the context of the cross-object formula field that references it. On
detail pages, the value is the profile name, as expected. In list views and reports, the value is the internal value of the associated profile
instead. If you use Profile.Name in a formula, use it within an OR function to ensure that the formula always returns the intended
result. For example:
IF
(OR
(LastModifiedBy.Profile.Name = "Standard User", LastModifiedBy.Profile.Name =
"PT2"),
"Standard", "Not Standard")

None of the above applies to profile names referenced by the $Profile global variable.

Fields That Can’t Be Used In Formulas

Fields that are calculated from other fields, like Name fields
For example, the Account object has an OwnerId field that refers to users. The relationship name is Owner.
So you can use the Owner.Email field in a formula. But if you try to use Owner.Name field in a formula, you get this message:
Error: Field name doesn’t exist. Check spelling.
To work around this issue, you can use a formula that builds a name directly. For example, on an Account object, you can use
Owner.FirstName & " " & Owner.LastName
Polymorphic relationship fields
For example, the Case object has a polymorphic relationship field called OwnerId that can refer to Groups or Users. The relationship
name is Owner. If you try to use Owner.Email in a formula, you get this message: Error: Specify an object type for the Owner
Field.
To work around this issue:
1. Create a custom field on the object that has a lookup relationship to the object that you want to use in the formula.
For example, create a UserOwner custom field on the Case object that has a lookup relationship to Users.

2. Set the custom field to refer to the object.

To continue the example, set the UserOwner field for a specific Case to refer to the required user.

3. Use the custom field in a formula.

For example, you can use UserOwner__r.Email, or UserOwner__r.FirstName & " " &
UserOwner__r.LastName

SEE ALSO:
Build Cross-Object Formulas in the Advanced Formula Tab
What Is a Cross-Object Formula?

465
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Formula Field Limits and Restrictions

Before you create formula fields, be aware of their limits and limitations.
EDITIONS
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 Available in: both Salesforce
implementations. Classic and Lightning
Experience
• Formula fields have these limits.
Available in: All Editions
– Character limit — Formula fields can contain up to 3,900 characters, including spaces,
return characters, and comments. If your formula needs more characters, create separate
formula fields and reference them in another formula field.

Note: The maximum number of displayed characters after an evaluation of a formula expression is 1,300.

– Save size limit — Formula fields can’t exceed 4,000 bytes when saved. If you use multi-byte characters in your formula, the save
size is different from the number of characters
– Compile size limit —Formula fields can’t exceed 15,000 bytes when compiled. The compile size is the size of the formula (in
bytes) including all of the fields, values, and formulas it references. There’s no direct correlation between the compile size and
the character limit. Some functions, such as TEXT, DATEVALUE, DATETIMEVALUE, and DATE significantly increase the compile
size.

Tip: For tips on how to rework your formulas to avoid these limits, see Tips for Reducing Formula Size

• Default value formulas for a record type can only reference fields for that record type. But formula fields and formulas for approvals
or rules for a record type can reference fields for that record type and any records that are related through a lookup or master-detail
relationship. For example, a formula for a validation rule on opportunities can reference merge fields for accounts, campaigns, and
opportunities. A formula field on accounts can reference fields for cases.
• You can’t use long text area, encrypted, or Description fields in formulas.
• The value of a field can’t depend on another formula that references it.
• You can’t delete fields referenced in formulas. Remove the field from the formula before deleting it.
• Campaign statistic fields can’t be referenced in formulas for field updates, approval processes, workflow rules, or validation rules,
but can be referenced in custom formula fields.
• The UI escapes HTML tags used in formula fields. To create an HTML element, replace your HTML with a function, like HYPERLINK or
IMAGE.
• Custom formula fields from contacts can’t be referenced through person accounts. For more information, see Using custom formula
fields with person accounts.
• The use of NULL as an expression isn’t supported in a Checkbox formula field.

SEE ALSO:
Tips for Building Formulas
Build a Formula Field

466
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Formula Best Practices

You can use the Formula Editor in Salesforce to construct a simple formula with a few clicks. But
EDITIONS
what if you want to build something more complex? Use these tips to help you map out formula
logic and make it easier to troubleshoot errors. Available in: both Salesforce
Thank you: Special thanks to Trailblazer Chris Emmett for contributing this content. Classic and Lightning
Experience

Available in: All Editions

Tip 1: Put Every Function on a Separate Line
It’s easy to fall into the habit of keeping an entire formula on a single line, especially when the
formula is small. Putting each function on its own line makes the formula easier to read and troubleshoot. These examples show the
same formula, first with no line breaks, and then with each function on a separate line.
IF(AND(ISBLANK(myDate_c),active_c=true),"Missing Date","Not Applicable")

IF(
AND(
ISBLANK(myDate_c),
active_c=true
),
"Missing Date",
"Not Applicable"
)

Tip 2: Indent Sections Within Parentheses

When your formula involves multiple functions, indentation helps visually isolate each function and makes it easier to identify errors,
such as misplaced characters.
In this example, with indentation, you see that the bulk of the formula sits within a single IF statement and that the AND statement
contains two functions. Inside the AND statement, the function ISBLANK is enclosed in parentheses.
IF(
AND(
ISBLANK(myDate_c),
active_c=true
),
"Missing Date",
"Not Applicable"
)

Indentation can also help you zero in on mistakes. With a flat layout, it’s difficult to see that an extra “)” is included after the ISBLANK
statement, and there are no visual clues about how the formula is structured.
IF(
AND(
ISBLANK(myDate_c)
),
active_c=true
),
"Missing Date",
"Not Applicable"
)

467
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

The indented layout makes it easy see the formula’s structure. You can quickly find and remove the extra character so that the AND
statement is correctly formatted.
IF(
AND(
ISBLANK(myDate_c)
),
active_c=true
),
"Missing Date",
"Not Applicable"
)

Tip 3: Write Statement and Function Names in Uppercase

All the examples here use uppercase letters for statement and function names, such as IF, AND, and ISBLANK. Using uppercase for
these terms creates a clear distinction between functions and parameters and brings some visual clarity to a complex formula.

Tip 4: Handle Null and Required Input Field Values

These examples reference a field called myDate__c and use the ISBLANK check to confirm that the field is populated. It’s important
to verify the contents of any field in a formula. Without this verification, a formula can fail. For example, if you add a second date to the
formula and perform a greater than operation, include the ISBLANK check for the second date to ensure that the formula executes
correctly.
IF(
AND(
ISBLANK(myDate__c),
ISBLANK(mySecondDate__c),
active__c=true,
mySecondDate__c > myDate__c
),
"Missing Date",
"Not Applicable"
)

468
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Examples of Advanced Formula Fields

Review examples of formula fields for various types of apps that you can use and modify for your
EDITIONS
own purposes.
This document contains custom formula samples for the following topics. For details about using Available in: both Salesforce
the functions included in these samples, see Formula Operators and Functions by Context on page Classic and Lightning
388. Experience

Available in: All Editions

Sample Account Management Formulas
Sample Account Media Service Formulas USER PERMISSIONS
Sample Case Management Formulas
To view formula field details:
Sample Commission Calculations Formulas • View Setup and
Sample Contact Management Formulas Configuration
To create, change, or delete
Sample Data Categorization Formulas
formula fields:
Sample Date Formulas • Customize Application
Sample Discounting Formulas
Sample Employee Services Formulas
Sample Expense Tracking Formulas
Sample Financial Calculations Formulas
Sample Image Link Formulas
Sample Integration Link Formulas
Sample Lead Management Formulas
Sample Metric Formulas
Sample Opportunity Management Formulas
Sample Pricing Formulas
Sample Scoring Calculations Formulas

SEE ALSO:
Formulas: How Do I ... ?
Tips for Building Formulas

Sample Account Management Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Classic and Lightning
Experience

Available in: All Editions

469
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Account Rating
This formula evaluates Annual Revenue, Billing Country, and Type, and assigns a value of “Hot,” “Warm,” or “Cold.”
IF (AND (AnnualRevenue > 10000000,
CONTAINS (CASE (BillingCountry, "United States", "US", "America", "US", "USA", "US", "NA"),
"US")),
IF(ISPICKVAL(Type, "Manufacturing Partner"), "Hot",
IF(OR (ISPICKVAL (Type, "Channel Partner/Reseller"),
ISPICKVAL(Type, "Installation Partner")), "Warm", "Cold")),
"Cold")

In addition, you can reference this Account Rating formula field from the contact object using cross-object formulas.
Account.Account_Rating__c

Account Region
This formula returns a text value of “North,” “South,” “East,” “West,” or “Central” based on the Billing State/Province of the
account.
IF(ISBLANK(BillingState), "None",
IF(CONTAINS("AK:AZ:CA:HA:NV:NM:OR:UT:WA", BillingState), "West",
IF(CONTAINS("CO:ID:MT:KS:OK:TX:WY", BillingState), "Central",
IF(CONTAINS("CT:ME:MA:NH:NY:PA:RI:VT", BillingState), "East",
IF(CONTAINS("AL:AR:DC:DE:FL:GA:KY:LA:MD:MS:NC:NJ:SC:TN:VA:WV", BillingState), "South",
IF(CONTAINS("IL:IN:IA:MI:MN:MO:NE:ND:OH:SD:WI", BillingState), "North", "Other"))))))

Contract Aging
This formula calculates the number of days since a contract with an account was activated. If the contract Status is not “Activated,”
this field is blank.
IF(ISPICKVAL(Contract_Status__c, "Activated"),
NOW() - Contract_Activated_Date__c, null)

Sample Account Media Service Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
BBC™ News Search Classic and Lightning
Experience
This formula creates a link to a BBC news search site based on the Account Name.
Available in: All Editions

HYPERLINK(
"http://www.bbc.co.uk/search/news/?q="&Name,
"BBC News")

470
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Bloomberg™ News Search

This formula creates a link to an account's ticker symbol on the Bloomberg website.
HYPERLINK(
"http://www.bloomberg.com/markets/symbolsearch?query="&TickerSymbol,
"Bloomberg News")

CNN™ News Search

This formula creates a link to a CNN news search site using the Account Name.
HYPERLINK(
"http://http://www.cnn.com/search/?query="&Name,
"CNN News")

MarketWatch™ Search
This formula creates a link to an account's ticker symbol on the Marketwatch.com website.
HYPERLINK(
"http://www.marketwatch.com/investing/stock/"&TickerSymbol,
"Marketwatch")

Google™ Search
This formula creates a link to a Google search site using the Account Name.
HYPERLINK(
"http://www.google.com/#q="&Name,
"Google")

Google News Search

This formula creates a link to a Google news search site using the Account Name.
HYPERLINK(
"http://news.google.com/news/search?en&q="&Name,
"Google News")

Yahoo!™ Search
This formula creates a link to a Yahoo! search site using the Account Name.
HYPERLINK(
"http://search.yahoo.com/search?p="&Name,
"Yahoo Search")

471
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Yahoo! News Search

This formula creates a link to a Yahoo! news search site using the Account Name.
HYPERLINK(
"http://news.search.yahoo.com/search/news?p="&Name,
"Yahoo News")

Sample Case Management Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: Salesforce
Autodial Classic

This formula creates a linkable phone number field that automatically dials the phone number Available in: All Editions
when clicked. In this example, replace "servername" and "call" with the name of your
dialing tool and the command it uses to dial. The merge field, Id, inserts the identifier for the contact,
lead, or account record. The first Phone merge field tells the dialing tool what number to call and the last Phone merge field uses the
value of the Phone field as the linkable text the user clicks to dial.
HYPERLINK("http://servername/call?id=" & Id & "&phone=" &
Phone, Phone)

Case Categorization
This formula displays a text value of “RED,” “YELLOW,” or “GREEN,” depending on the value of a case age custom text field.
IF(DaysOpen__c > 20, "RED",
IF(DaysOpen__c > 10, "YELLOW",
"GREEN") )

Case Data Completeness Tracking

This formula calculates the percentage of specific custom fields that contain data. The formula checks the values of two custom number
fields: Problem Num and Severity Num. If the fields are empty, the formula returns the value “0.” The formula returns a value
of “1” for each field that contains a value and multiplies this total by fifty to give you the percentage of fields that contain data.
(IF(ISBLANK(Problem_Num__c), 0, 1) + IF(ISBLANK(Severity_Num__c ), 0,1)) * 50

Suggested Agent Prompts

This formula prompts an agent with cross-sell offers based on past purchases.
CASE(Product_Purch__c,
"Printer", "Extra toner cartridges", "Camera", "Memory cards",
"Special of the day")

472
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Suggested Offers
This formula suggests a product based on the support history for a computer reseller. When the Problem custom field matches a
field, the formula field returns a suggestion.
CASE(Problem__c,
"Memory", "Suggest new memory cards", "Hard Drive failure", "Suggest new hard drive with
tape backup",
"")

Sample Commission Calculations Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Commission Amounts for Opportunities Classic and Lightning
Experience
The following is a simple formula where commission is based on a flat 2% of the opportunity
Amount. Available in: All Editions

IF(ISPICKVAL(StageName, "Closed Won"),

ROUND(Amount *0.02, 2), 0)

This example calculates the commission amount for any opportunity that has a “Closed Won” stage. The value of this field will be the
amount times 0.02 for any closed/won opportunity. Open or lost opportunities will have a zero commission value.

Commission Deal Size

This formula calculates a commission rate based on deal size, returning a 9% commission rate for deals over 100,000 and an 8% commission
rate for smaller deals.
IF(Amount > 100000, 0.09, 0.08 )

Commission Greater Than or Equal To

This formula assigns the YES value with a commission greater than or equal to one million. Note, this is a text formula field that uses a
custom currency field called Commission.
IF(Commission__c >=
1000000, "YES", "NO")

Commission Maximum
This formula determines what commission to log for an asset based on which is greater: the user's commission percentage of the price,
the price times the discount percent stored for the account or 100 dollars. This example assumes you have two custom percent fields
on users and assets.
MAX($User.Commission_Percent__c * Price,
Price * Account_Discount__c, 100)

473
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sample Contact Management Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Contact's Account Discount Percent Classic and Lightning
Experience
This percent formula displays the account's Discount Percent field on the contacts page.
Available in: All Editions

Account.Discount_Percent__c

Contact's Account Name

This formula displays the standard Account Name field on the contacts page.
Account.Name

Contact's Account Phone

This formula displays the standard Account Phone field on the contacts page.
Account.Phone

Contact's Account Rating

Use this formula to display the Account Rating field on the contacts page.
CASE(Account.Rating, "Hot", "Hot", "Warm", "Warm", "Cold", "Cold", "Not Rated")

Contact's Account Website

This formula displays the standard Account Website field on the contacts page.
Account.Website

If the account website URL is long, use the HYPERLINK function to display a label such as “Click Here” instead of the URL. For example:
IF(Account.Website="", "",
IF(
OR(LEFT(Account.Website, 7) = "http://",LEFT(Account.Website, 8) = "https://"),
HYPERLINK( Account.Website , "Click Here" ),
HYPERLINK( "https://" & Account.Website , "Click Here" )
)
)

This formula also adds the necessary "https://" before a URL if neither “http://” nor “https://” was included in the URL field.

Contact's LinkedIn™ Profile

You can configure a link that appears on your contacts' profile page that sends you to their LinkedIn profile. To do so:
1. From the object management settings for contacts, go to Buttons, Links, and Actions.

474
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

2. Click New Button or Link.

3. Enter a Label for this link, like LinkedInLink.
4. Enter this formula in the content box:
https://www.linkedin.com/search/fpsearch?type=people&keywords
={!Contact.FirstName}+{!Contact.LastName}

5. Click Save.
Remember to add this link to the Contact page layout in order for it to show up.

Contact Identification Numbering

This formula displays the first five characters of a name and the last four characters of a social security number separated by a dash. Note
that this example uses a text custom field called SSN.
TRIM(LEFT(LastName, 5)) &
"-" & TRIM(RIGHT(SSN__c, 4))

Contact Preferred Phone

This formula displays the contact’s preferred contact method in a contact related list—work phone, home phone, or mobile phone—based
on a selected option in a Preferred Phone custom picklist.
CASE(Preferred_Phone__c,
"Work", "w. " & Phone,
"Home", "h. " & HomePhone,
"Mobile", "m. " & MobilePhone,
"No Preferred Phone")

Contact Priority
This formula assesses the importance of a contact based on the account rating and the contact's title. If the account rating is Hot or
the title starts with Executive, then the priority is high (P1). If the account rating is Warm or the title starts with VP then the priority
is medium (P2), and if the account rating is Cold then the priority is low (P3).
IF(OR(ISPICKVAL(Account.Rating, "Hot"), CONTAINS(Title, "Executive")), "P1",

IF(OR(ISPICKVAL(Account.Rating, "Warm"), CONTAINS(Title, "VP")), "P2",

IF(ISPICKVAL(Account.Rating, "Cold"), "P3",

"P3")
)
)

475
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Contact Yahoo! ID
This formula displays a clickable Yahoo! Messenger icon indicating if the person is logged on to the service. Users can click the icon to
launch a Yahoo! Messenger conversation with the person. This example uses a custom text field called Yahoo Name on contacts
where you can store the contact's Yahoo! Messenger ID.
HYPERLINK("ymsgr:sendIM?" & Yahoo_Name__c,
IMAGE("https://opi.yahoo.com/online?u=" & Yahoo_Name__c &
"&m;=g&t;=0", "Yahoo"))

Dynamic Address Formatting

This formula field displays a formatted mailing address for a contact in standard format, including spaces and line breaks where appropriate
depending on the country.
CASE(ShippingCountry,
"USA",
ShippingStreet & BR() &
ShippingCity & ",
" & ShippingState & " " &
ShippingPostalCode & BR()
& ShippingCountry,
"France",
ShippingStreet & BR() &
ShippingPostalCode & " " &
ShippingCity & BR() &
ShippingCountry, "etc")

Telephone Country Code

This formula determines the telephone country code of a contact based on the Mailing Country of the mailing address.
CASE(MailingCountry,
"USA", "1",
"Canada", "1",
"France", "33",
"UK", "44",
"Australia", "61",
"Japan", "81",
"?")

Unformatted Phone Number

This formula removes the parentheses and dash characters from North American phone numbers. This is necessary for some auto-dialer
software.
IF(Country_Code__c = "1", MID( Phone ,2, 3) & MID(Phone,7,3) & MID(Phone,11,4), Phone)

476
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sample Data Categorization Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Deal Size Large and Small Classic and Lightning
Experience
This formula displays “Large Deal” for deals over one million dollars or “Small Deal” for deals under
one million dollars. Available in: All Editions

IF(Sales_Price__c > 1000000,

"Large Deal",
"Small Deal")

Deal Size Small

This formula displays Small if the price and quantity are less than one. This field is blank if the asset has a price or quantity greater
than one.
IF(AND(Price<1,Quantity<1),"Small", null)

Product Categorization
This formula checks the content of a custom text field named Product_Type and returns Parts for any product with the word
“part” in it. Otherwise, it returns Service. Note that the values are case-sensitive, so if a Product_Type field contains the text “Part” or
“PART,” this formula returns Services.
IF(CONTAINS(Product_Type__c, "part"), "Parts", "Service")

Sample Date Formulas

EDITIONS
Find the Day, Month, or Year from a Date
Use the functions DAY( date ), MONTH( date ), and YEAR( date ) to return their Available in: both Salesforce
numerical values. Replace date with a value of type Date (for example, TODAY()). Classic and Lightning
Experience
To use these functions with Date/Time values, first convert them to a date with the DATEVALUE()
function. For example, DAY( DATEVALUE( date/time )). Available in: All Editions

Find Out If a Year Is a Leap Year

This formula determines whether a year is a leap year. A year is only a leap year if it’s divisible by 400, or if it’s divisible by four but not by
100.
OR(
MOD( YEAR( date ), 400 ) = 0,
AND(
MOD( YEAR( date ), 4 ) = 0,
MOD( YEAR( date ), 100 ) != 0
)
)

477
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Find Which Quarter a Date Is In

For standard quarters, you can determine which quarter a date falls in using this formula. This formula returns the number of the quarter
that date falls in (1–4) by dividing the current month by three (the number of months in each quarter) and taking the ceiling.

CEILING( MONTH ( date ) / 3 )

The formula for shifted quarters is similar, but shifts the month of the date by the number of months between January and the first
quarter of the fiscal year. The following example shows how to find a date’s quarter if Q1 starts in February instead of January.

CEILING( ( MONTH ( date ) - 1 ) / 3)

ITo check whether a date is in the current quarter, add a check to compare the date’s year and quarter with TODAY()’s year and quarter.
AND(
CEILING( MONTH( date ) / 3 ) = CEILING( MONTH( TODAY() ) / 3 ),
YEAR( date ) = YEAR( TODAY() )
)

Find the Week of the Year a Date Is In

To find the number of a date’s week of the year, use this formula:
IF(
CEILING( ( date - DATE( YEAR( date ), 1, 1) + 1) / 7) > 52,
52,
CEILING( ( date - DATE( YEAR( date ), 1, 1) + 1) / 7)
)

To find the current week number, determine the days to date in the current year and divide that value by 7. The IF() statement ensures
that the week number the formula returns doesn’t exceed 52. So if the given date is December 31 of the given year, the formula returns
52, even though it’s more than 52 weeks after the first week of January.

Find Whether Two Dates Are in the Same Month

To determine whether two Dates fall in the same month, say for a validation rule to determine whether an opportunity Close Date is in
the current month, use this formula:
AND(
MONTH( date_1 ) == MONTH( date_2 ),
YEAR( date_1 ) == YEAR( date_2 )
)

Find the Last Day of the Month

The easiest way to find the last day of a month is to find the first day of the next month and subtract a day.
IF(
MONTH( date ) = 12,
DATE( YEAR( date ), 12, 31 ),
DATE( YEAR( date ), MONTH ( date ) + 1, 1 ) - 1
)

478
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Display the Month as a String instead of a Number

To return the month as a text string instead of a number, use:
CASE(
MONTH( date ),
1, "January",
2, "February",
3, "March",
4, "April",
5, "May",
6, "June",
7, "July",
8, "August",
9, "September",
10, "October",
11, "November",
"December"
)

If your organization uses multiple languages, you can replace the names of the month with a custom label:
CASE(
MONTH( date ),
1, $Label.Month_of_Year_1,
2, $Label.Month_of_Year_2,
3, $Label.Month_of_Year_3,
4, $Label.Month_of_Year_4,
5, $Label.Month_of_Year_5,
6, $Label.Month_of_Year_6,
7, $Label.Month_of_Year_7,
8, $Label.Month_of_Year_8,
9, $Label.Month_of_Year_9,
10, $Label.Month_of_Year_10,
11, $Label.Month_of_Year_11,
$Label.Month_of_Year_12
)

Find and Display the Day of the Week from a Date

To find the day of the week from a Date value, use a known Sunday, for example, January 7, 1900, and subtract it from the date, for
example, TODAY(), to get the difference in days. The MOD() function finds the remainder of this result when divided by 7 to give
the numerical value of the day of the week between 0 (Sunday) and 6 (Saturday). This formula finds the result and then returns the text
name of that day.
CASE(
MOD( date - DATE( 1900, 1, 7 ), 7 ),
0, "Sunday",
1, "Monday",
2, "Tuesday",
3, "Wednesday",
4, "Thursday",
5, "Friday",
"Saturday"
)

479
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

This formula only works for dates after 01/07/1900. If you work with older dates, use the same process with any Sunday before to your
earliest date, for example, 01/05/1800.
You can adjust this formula if your week starts on a different day. For example, if your week starts on Monday, you can use January 8,
1900 in your condition. The new formula looks like this:
CASE(
MOD( date - DATE( 1900, 1, 8 ), 7 ),
0, "Monday",
1, "Tuesday",
2, "Wednesday",
3, "Thursday",
4, "Friday",
5, "Saturday",
"Sunday"
)

To get the formula for the name of the month, if your organization uses multiple languages, you can replace the names of the day of
the week with a variable like $Label.Day_of_Week_1, and so on.

Find the Next Day of the Week After a Date

To find the date of the next occurrence of a particular day of the week following a given Date, get the difference in the number of days
of the week between a date and a day_of_week, a number 0–6 where 0 = Sunday and 6 = Saturday. By adding this difference to
the current date, you can find the date of the day_of_week. The IF() statement in this formula handles cases where the
day_of_week is before the day of the week of the date value (for example date is a Thursday and day_of_week is a Monday)
by adding 7 to the difference.

date + ( day_of_week - MOD( date - DATE( 1900, 1, 7 ), 7 ) )

+
IF(
MOD( date - DATE( 1900, 1, 7 ), 7 ) >= day_of_week,
7,
0
)

You can substitute either a constant or another field in for the day_of_week value based on your needs.

Find the Number of Days Between Two Dates

To find the number of days between two dates, date_1, and date_2, subtract the earlier date from the later date: date_1 —
date_2
You can alter this formula slightly if you want to determine a date that’s a certain number of days in the past. For example, to create a
formula to return true if some date field is more than 30 days before the current date and false otherwise, use a formula such as the
following:

TODAY() - 30 > date

Find the Number of Weekdays Between Two Dates

Calculating how many weekdays passed between two dates is slightly more complex than calculating total elapsed days. In this example,
weekdays are Monday through Friday. The basic strategy is to choose a reference Monday from the past and find out how many full

480
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

weeks and any additional portion of a week have passed between the reference date and your date. These values are multiplied by five
for a five-day work week, and then the difference between them is taken to calculate weekdays.

(5 * ( FLOOR( ( date_1 - DATE( 1900, 1, 8) ) / 7 ) ) + MIN( 5, MOD( date_1 - DATE( 1900,

1, 8), 7 ) ) )
-
(5 * ( FLOOR( ( date_2 - DATE( 1900, 1, 8) ) / 7 ) ) + MIN( 5, MOD( date_2 - DATE( 1900,
1, 8), 7 ) ) )

In this formula, date_1 is the more recent date and date_2 is the earlier date. If your work week runs shorter or longer than five
days, replace all fives in the formula with the length of your week.

Find the Number of Months Between Two Dates

To find the number of months between two dates, subtract the year of the earlier date from the year of the later date and multiply the
difference by 12. Next, subtract the month of the earlier date from the month of the later date, and add that difference to the value of
the first set of operations.
((YEAR(date_1) - YEAR(date_2))*12) + (MONTH(date_1) - MONTH(date_2))

Add Days, Months, and Years to a Date

If you want to add a certain number of days to a date, add that number to the date directly. For example, to add 5 days to a date, the
formula is date + 5.
If you want to add a certain number of months to a date, use this function.
ADDMONTHS()

For example, if you want to add 4 months to a date, use this formula.

ADDMONTHS(date + 4)

If the date that you provide is the last of any month, this formula returns the last day of the resulting month.
To add a certain number of years to a date, use this formula.

ADDMONTHS(date, 12*num_years)

If the date that you provide is February 29, and the resulting year isn’t a leap year, the formula returns the date as February 28. In this
scenario, if you want the resulting date as March 1, use this formula.

IF( MOD((Year (ADDMONTHS(date, 12* num_years)-1960),4)=0, ADDMONTHS(date,12*

num_years)+1,ADDMONTHS(date, 12*num_years))

Add Business Days to a Date

This formula finds three business days from a given date.
CASE(
MOD( date - DATE( 1900, 1, 7 ), 7 ),
3, date + 2 + 3,
4, date + 2 + 3,
5, date + 2 + 3,
6, date + 1 + 3,

481
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

date + 3
)

This formula finds the day of the week of the date field value. If the date is a Wednesday, Thursday, or Friday, the formula adds five
calendar days, two weekend days, three weekdays, to the date to account for the weekend. If date is a Saturday, you need four
additional calendar days. For any other day of the week Sunday Tuesday, simply add three days. You can easily modify this formula to
add more or fewer business days. The tip for getting the day of the week is useful to use to adjust this formula.

Find the Hour, Minute, or Second from a Date/Time

To get the hour, minute, and second from a Date/Time field as a numerical value, use the following formulas where TZoffset is the
difference between the user’s time zone and GMT. For hour in 24–hour format:

VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) )

For hour in 12–hour format:

IF(
OR(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) = 0,
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) = 12
),
12,
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) )
-
IF(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) < 12,
0,
12
)
)

For minutes:

VALUE( MID( TEXT( date/time - TZoffset ), 15, 2 ) )

For seconds:

VALUE( MID( TEXT( date/time - TZoffset ), 18, 2 ) )

And, to get “AM” or “PM” as a string, use:

IF(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) < 12,
"AM",
"PM"
)

To return the time as a string in “HH:MM:SS A/PM” format, use the following formula:
IF(
OR(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) = 0,
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) = 12
),
"12",

482
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

TEXT( VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) )

-
IF(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) < 12,
0,
12
)
)
)
& ":" &
MID( TEXT( date/time - TZoffset ), 15, 2 )
& ":" &
MID( TEXT( date/time - TZoffset ), 18, 2 )
& " " &
IF(
VALUE( MID( TEXT( date/time - TZoffset ), 12, 2 ) ) < 12,
"AM",
"PM"
)

When working with time in formula fields, always consider the time difference between your organization and GMT. See A Note About
Date/Time and Time Zones on page 454 for more information about the time zone offset used in this formula.

Find the Elapsed Time Between Date/Times

To find the difference between two Date values as a number, subtract one from the other like so: date_1 — date_2 to return the
difference in days.
Finding the elapsed time between two Date/Time values is slightly more complex. This formula converts the difference between two
Date/Time values, datetime_1 and datetime_2, to days, hours, and minutes.

IF(
datetime_1 - datetime_2 > 0 ,
TEXT( FLOOR( datetime_1 - datetime_2 ) ) & " days "
& TEXT( FLOOR( MOD( (datetime_1 - datetime_2 ) * 24, 24 ) ) ) & " hours "
& TEXT( ROUND( MOD( (datetime_1 - datetime_2 ) * 24 * 60, 60 ), 0 ) ) & " minutes",
""
)

Find the Number of Business Hours Between Two Date/Times

The formula to find business hours between two Date/Time values expands on the formula to find elapsed business days. It works on
the same principle of using a reference Date/Time. In this case 1/8/1900 at 16:00 GMT, or 9:00 AM PDT, and then finding your Dates’
respective distances from that reference. The formula rounds the value it finds to the nearest hour and assumes an 8–hour, 9:00 AM5:00
PM work day.
ROUND( 8 * (
( 5 * FLOOR( ( DATEVALUE( date/time_1 ) - DATE( 1900, 1, 8) ) / 7) +
MIN(5,
MOD( DATEVALUE( date/time_1 ) - DATE( 1900, 1, 8), 7) +
MIN( 1, 24 / 8 * ( MOD( date/time_1 - DATETIMEVALUE( '1900-01-08 16:00:00' ), 1 ) )
)
)

483
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

)
-
( 5 * FLOOR( ( DATEVALUE( date/time_2 ) - DATE( 1900, 1, 8) ) / 7) +
MIN( 5,
MOD( DATEVALUE( date/time_2 ) - DATE( 1996, 1, 1), 7 ) +
MIN( 1, 24 / 8 * ( MOD( date/time_2 - DATETIMEVALUE( '1900-01-08 16:00:00' ), 1) )
)
)
)
),
0 )

You can change the eights in the formula to account for a longer or shorter work day. If you live in a different time zone or your work
day doesn’t start at 9:00 AM, change the reference time to the start of your work day in GMT. See A Note About Date/Time and Time
Zones for more information.

SEE ALSO:
Using Date, Date/Time, and Time Values in Formulas
Examples of Advanced Formula Fields
Tips for Building Formulas

Sample Discounting Formulas

For details about using the functions included in these samples, see Formula and Operator Functions.
EDITIONS

Maintenance and Services Discount Available in: both Salesforce

Classic and Lightning
This formula field uses two custom currency fields: Maintenance Amount and Services
Experience
Amount. It displays “Discounted” on an opportunity if its maintenance amount and services amount
do not equal the opportunity Amount standard field value. Otherwise, it displays "Full Price." Available in: All Editions

IF(Maintenance_Amount__c + Services_Amount__c <> Amount,

"Discounted",
"Full Price")

Opportunity Discount Amount

This formula calculates the difference of the product Amount less the Discount Amount. Discount Amount is a custom currency field.
Amount -
Discount_Amount__c

Opportunity Discount Rounded

Use this formula to calculate the discounted amount of an opportunity rounded off to two digits. This example is a number formula field
on opportunities that uses a custom percent field called Discount Percent.
ROUND(Amount-Amount* Discount_Percent__c,2)

484
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Opportunity Discount with Approval

This formula adds a “Discount Approved” checkbox to an opportunity. It uses conditional logic to check the value of the approval flag
before calculating the commission.
IF(Discount_Approved__c, ROUND(Amount – Amount * DiscountPercent__c, 2), Amount)

Sample Employee Services Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Bonus Calculation Classic and Lightning
Experience
This example determines an employee's bonus amount based on the smallest of two amounts: the
employee's gross times bonus percent or an equally divided amount of the company's performance Available in: All Editions
amount among all employees. It assumes you have custom number field for Number of
Employees, a custom percent field for Bonus Percent, and currency custom fields for the
employee's Gross and company's Performance.
MIN(Gross__c * Bonus_Percent__c,
Performance__c / Number_of_Employees__c)

Employee 401K
This example formula determines which amount to provide in employee 401K matching based on a matching program of half of the
employee's contribution or $250, whichever is less. It assumes you have custom currency field for Contribution.
MIN(250, Contribution__c /2)

Hours Worked Per Week

This formula uses a custom tab to enable time tracking of hours worked per day. It uses a formula field to sum the hours per week.
MonHours__c + TuesHours__c + WedsHours__c + ThursHours__c + FriHours__c

Total Pay Amount

This formula determines total pay by calculating regular hours multiplied by a regular pay rate, plus overtime hours multiplied by an
overtime pay rate.
Total Pay =
IF(Total_Hours__c <= 40, Total_Hours__c * Hourly_Rate__c,
40 * Hourly_Rate__c +
(Total_Hours__c - 40) * Overtime_Rate__c)

485
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sample Expense Tracking Formulas

For details about using the functions included in these samples, see Formula and Operator Functions.
EDITIONS

Expense Identifier Available in: both Salesforce

Classic and Lightning
This formula displays the text Expense- followed by trip name and the expense number. This
Experience
is a text formula field that uses an expense number custom field.
Available in: All Editions

"Expense-" &
Trip_Name__c & "-" & ExpenseNum__c

Mileage Calculation
This formula calculates mileage expenses for visiting a customer site at 35 cents a mile.
Miles_Driven__c * 0.35

Sample Financial Calculations Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Compound Interest Classic and Lightning
Experience
This formula calculates the interest, you will have after T years, compounded M times per year.
Available in: All Editions

Principal__c * ( 1 + Rate__c / M ) ^ ( T * M) )

Compound Interest Continuous

This formula calculates the interest that will have accumulated after T years, if continuously compounded.
Principal__c * EXP(Rate__c * T)

Consultant Cost
This formula calculates the number of consulting days times 1200 given that this formula field is a currency data type and consulting
charges a rate of $1200 per day. Consulting Days is a custom field.
Consulting_Days__c *
1200

486
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Gross Margin
This formula provides a simple calculation of gross margin. In this formula example, Total Sales and Cost of Goods Sold
are custom currency fields.
Total_Sales__c - Cost_of_Goods_Sold__c

Gross Margin Percent

This formula calculates the gross margin based on a margin percent.
Margin_percent__c * Items_Sold__c * Price_item__c

Payment Due Indicator

This formula returns the date five days after the contract start date whenever Payment Due Date is blank. Payment Due Date is a custom
date field.
(BLANKVALUE(Payment_Due_Date__c, StartDate +5)

Payment Status
This formula determines if the payment due date is past and the payment status is “UNPAID.” If so, it returns the text “PAYMENT OVERDUE”
and if not, it leaves the field blank. This example uses a custom date field called Payment Due Date and a text custom field called
Payment Status on contracts.

IF(
AND(Payment_Due_Date__c < TODAY(),
ISPICKVAL(Payment_Status__c, "UNPAID")),
"PAYMENT OVERDUE",
null )

Sample Image Link Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Yahoo! Instant Messenger™ Image Classic and Lightning
Experience
This formula displays an image that indicates whether a contact or user is currently logged in to
Yahoo! Instant Messenger. Clicking the image launches the Yahoo! Instant Messenger window. This Available in: All Editions
formula uses a custom text field called Yahoo Name to store the contact or user’s Yahoo! ID.

IF(ISBLANK(Yahoo_Name__c),"", HYPERLINK("ymsgr:sendIM?" & Yahoo_Name__c,

IMAGE("http://opi.yahoo.com/online?u=" & Yahoo_Name__c & "&m=g&t=0", " ")))

Flags for Case Priority

This formula displays a green, yellow, or red flag image to indicate case priority.
IMAGE(
CASE( Priority,
"Low", "/img/samples/flag_green.gif",

487
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

"Medium", "/img/samples/flag_yellow.gif",
"High", "/img/samples/flag_red.gif",
"/s.gif"),
"Priority Flag")

Color Squares for Case Age

This formula displays a 30 x 30 pixel image of a red, yellow, or green, depending on the value of a Case Age custom number field.
IF( Case_Age__c > 20,
IMAGE("/img/samples/color_red.gif", "red", 30, 30),
IF( Case_Age__c > 10,
IMAGE("/img/samples/color_yellow.gif", "yellow", 30, 30),
IMAGE("/img/samples/color_green.gif", "green", 30, 30)
))

Traffic Lights for Status

This formula displays a green, yellow, or red traffic light images to indicate status, using a custom picklist field called Project Status.
Use this formula in list views and reports to create a “Status Summary” dashboard view.
IMAGE(
CASE(Project_Status__c,
"Green", "/img/samples/light_green.gif",
"Yellow", "/img/samples/light_yellow.gif",
"Red", "/img/samples/light_red.gif",
"/s.gif"),
"status color")

Stars for Ratings

This formula displays a set of one to five stars to indicate a rating or score.
IMAGE(
CASE(Rating__c,
"1", "/img/samples/stars_100.gif",
"2", "/img/samples/stars_200.gif",
"3", "/img/samples/stars_300.gif",
"4", "/img/samples/stars_400.gif",
"5", "/img/samples/stars_500.gif",
"/img/samples/stars_000.gif"),
"rating")

Consumer Reports™—Style Colored Circles for Ratings

This formula displays a colored circle to indicate a rating on a scale of one to five, where solid red is one, half red is two, black outline is
three, half black is four, and solid black is five.
IMAGE(
CASE(Rating__c,
"1", "/img/samples/rating1.gif",
"2", "/img/samples/rating2.gif",
"3", "/img/samples/rating3.gif",

488
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

"4", "/img/samples/rating4.gif",
"5", "/img/samples/rating5.gif",
"/s.gif"),
"rating")

Horizontal Bars to Indicate Scoring

This formula displays a horizontal color bar (green on a white background) of a length that is proportional to a numeric score. In this
example, the maximum length of the bar is 200 pixels.
IMAGE("/img/samples/color_green.gif", "green", 15, Industry_Score__c * 2) &
IMAGE("/s.gif", "white", 15,
200 - (Industry_Score__c * 2))

Sample Integration Link Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Application API Link Classic (not available in all
orgs) and Lightning
This formula creates a link to an application outside Salesforce, passing the parameters so that it Experience
can connect to Salesforce via the SOAP API and create the necessary event.
Available in: All Editions

HYPERLINK ("https://www.myintegration.com?sId=" & GETSESSIONID() & "?&rowID=" & Name &

"action=CreateTask","Create a Meeting Request")

Important: $Api.Session_ID and GETSESSIONID() return the same value, an identifier for the current session in the
current context. This context varies depending on where the global variable or function is evaluated. For example, if you use either
in a custom formula field, and that field is displayed on a standard page layout in Salesforce Classic, the referenced session is a
basic Salesforce session. That same field (or the underlying variable or formula result), when used in a Visualforce page, references
a Visualforce session instead.
Session contexts are based on the domain of the request. That is, the session context changes whenever you cross a hostname
boundary, such as from .salesforce.com to .vf.force.com or .lightning.force.com.
Session identifiers from different contexts, and the sessions themselves, are different. When you transition between contexts, the
old session is replaced by the new one, and the old session is no longer valid. The session ID also changes at this time.
Normally Salesforce transparently handles session hand-off between contexts, but if you’re passing the session ID around yourself,
you might need to re-access $Api.Session_ID or GETSESSIONID() from the new context to ensure a valid session ID.
Not all sessions are created equal. In particular, sessions obtained in a Lightning Experience context have reduced privileges, and
don't have API access. You can't use these session IDs to make API calls. {!$Api.Session_ID} isn’t generated for guest
users.

489
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Shipment Tracking Integration

This formula creates a link to FedEx, UPS, or DHL shipment tracking websites, depending on the value of a Shipping Method
custom picklist field. Note that the parameters shown in this example for FedEx, UPS, and DHL websites are illustrative and do not
represent the correct parameters for all situations.
CASE(Shipping_Method__c,
"Fedex",
HYPERLINK("http://www.fedex.com/Tracking?ascend_header=1&clienttype
=dotcom&cntry_code=us&language=english&tracknumbers= "& tracking_id__c,"Track"),
"UPS",
HYPERLINK("http://wwwapps.ups.com/WebTracking/processInputRequest?HTMLVersion
=5.0&sort_by=status&loc=en_US&InquiryNumber1= "& tracking_id__c & "&track.x=32&track.y=7",
"Track") ,
"DHL",
HYPERLINK("http://track.dhl-usa.com/TrackByNbr.asp?ShipmentNumber=" &
tracking_id__c,"Track"), "")

Skype™ Auto Dialer Integration

This formula creates a linkable phone number field that automatically dials the phone number via the Skype VOIP phone application. It
requires installation of the Skype application (a third-party product not provided by Salesforce) on your desktop.
HYPERLINK("callto://+" & Country_Code__c & Phone_Unformatted__c, Phone)

Sample Lead Management Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Lead Aging (for open leads) Classic and Lightning
Experience
This formula checks to see if a lead is open and if so, calculates the number of days it has been open
by subtracting the date and time created from the current date and time. The result is the number Available in: All Editions
of days open rounded to zero decimal places. If the lead is not open, this field is blank.

IF(ISPICKVAL(Status,
"Open"), ROUND(NOW()-CreatedDate, 0), null)

Lead Data Completeness

This formula calculates the percent of certain lead fields that your sales personnel enter. The formula field checks the values of two
custom number fields: Phone and Email. If the fields are empty, the formula returns the value “0.” The formula returns a value of “1”
for each field that contains a value and multiplies this total by fifty to give you the percentage of fields that contain data.
(IF(Phone = "", 0, 1) + IF(Email = "", 0, 1) ) * 50

490
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Lead Numbering
This formula returns a number value for the text value in the auto-number field Lead Number. This can be useful if you want to use
the Lead Number field in a calculation, such as round-robin or other routing purposes. Note that auto-number fields are text fields
and must be converted to a number for numeric calculations.
VALUE(Lead_Number__c)

Round-Robin Assignment of Cases or Leads

The following formula example for leads assumes you have three lead queues and you want to assign an equal number of incoming
leads to each queue. You can also assign cases using a similar formula.
MOD(VALUE(Lead_Number__c),
3)

This formula is for a custom formula field named Round_Robin_ID that assigns each lead a value of 0, 1, or 2. This formula uses a custom
auto-number field called Lead Number that assigns each lead a unique number starting with 1. The MOD function divides the lead
number by the number of lead queues available (three in this example) and returns a remainder of 0, 1, or 2. Use the value of this formula
field in your lead assignment rules to assign lead records to different queues. For example:
• Round_Robin_ID = 0 is assigned to Queue A
• Round_Robin_ID = 1 is assigned to Queue B
• Round_Robin_ID = 2 is assigned to Queue C

Sample Metric Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Temperature Conversion Classic and Lightning
Experience
This formula converts Celsius degrees to Fahrenheit.
Available in: All Editions

1.8 * degrees_celsius__c + 32

Unit of Measure Conversion

This formula converts miles to kilometers.
Miles__c * 1.60934

491
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sample Opportunity Management Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
on page 388.
Available in: both Salesforce
Expected Product Revenue Classic and Lightning
Experience
This formula calculates total revenue from multiple products, each with a different probability of
closing. Available in: All Editions

ProductA_probability__c * ProductA_revenue__c + ProductB_probability__c * ProductB_revenue__c

Maintenance Calculation
This formula calculates maintenance fees as 20% of license fees per year. Maintenance Years is a custom field on opportunities.
Amount * Maint_Years__c * 0.2

Monthly Subscription-Based Calculated Amounts

This formula calculates an opportunity amount based on a monthly subscription rate multiplied by the subscription period.
Monthly_Amount__c * Subscription_Months__c

Monthly Value
This formula divides total yearly value by 12 months.
Total_value__c / 12

Opportunity Additional Costs

This formula calculates the sum of the product Amount, maintenance amount, and services fees. Maint amount and Service
Fees are custom currency fields.

Amount + Maint_Amount__c +
Services_Amount__c

Opportunity Categorization
This formula uses conditional logic to populate an Opportunity category text field, based on the value of the Amount standard
field. Opportunities with amounts less than $1500 are “Category 1,” those between $1500 and $10000 are “Category 2,” and the rest are
“Category 3.” This example uses nested IF statements.
IF(Amount < 1500, "Category 1", IF(Amount > 10000, "Category 3", "Category 2"))

Opportunity Data Completeness

This formula takes a group of fields and calculates what percent of them are being used by your personnel. This formula field checks five
fields to see if they are blank. If so, a zero is counted for that field. A “1” is counted for any field that contains a value, and this total is

492
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

divided by five (the number of fields evaluated). This formula requires you to select the Treat blank fields as blanks option under Blank
Field Handling while the Advanced Formula subtab is showing.
(IF(ISBLANK(Maint_Amount__c), 0, 1) +
IF(ISBLANK(Services_Amount__c), 0,1) +
IF(ISBLANK(Discount_Percent__c), 0, 1) +
IF(ISBLANK(Amount), 0, 1) +
IF(ISBLANK(Timeline__c), 0, 1)) / 5

Opportunity Expected License Revenue

This formula calculates expected revenue for licenses based on probability of closing.
Expected_rev_licenses__c * Probability

Opportunity Revenue Text Display

This formula returns the expected revenue amount of an opportunity in text format without a dollar sign. For example, if the Expected
Revenue of a campaign is “$200,000,” this formula field displays “200000.”

TEXT(ExpectedRevenue)

Opportunity Total Deal Size

This formula calculates the sum of maintenance and services amounts.
Amount + Maint_Amount__c + Services_Amount__c

Opportunity Total Price Based on Units

This formula generates proposal pricing based on unit price and total volume.
Unit_price__c * Volume__c * 20

Professional Services Calculation

This formula estimates professional service fees at an average loaded rate of $1200 per day. Consulting Days is a custom field
on opportunities.
Consulting_Days__c * 1200

Stage-Based Sales Document Selection

This formula Identifies a relevant document in the Documents tab based on opportunity Stage. Use document IDs in the form of
“00l30000000j7AO.”
CASE(StageName,
"Prospecting", "Insert 1st Document ID",
"Qualification", "Insert 2nd Document ID",
"Needs Analysis", "Insert 3rd Document ID",
"Value Proposition", ...
)
)

493
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sales Coach
This formula creates a hyperlink that opens a stage-specific document stored in the Documents tab. It uses the previously defined custom
formula field that identifies a document based on opportunity Stage. See Stage-Based Sales Document Selection on page 493.
HYPERLINK("/servlet/servlet.FileDownload?file=" & Relevant_Document__c, "View Document in
New Window")

Shipping Cost by Weight

This formula calculates postal charges based on weight.
package_weight__c * cost_lb__c

Shipping Cost Percentage

This formula calculates shipping cost as a fraction of total amount.
Ship_cost__c / total_amount__c

Tiered Commission Rates

This formula calculates the 2% commission amount of an opportunity that has a probability of 100%. All other opportunities will have
a commission value of zero.
IF(Probability = 1,
ROUND(Amount * 0.02, 2),
0)

Total Contract Value from Recurring and Non-Recurring Revenue

This formula calculates both recurring and non-recurring revenue streams over the lifetime of a contract.
Non_Recurring_Revenue__c + Contract_Length_Months__c * Recurring_Revenue__c

Sample Pricing Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Total Amount Classic and Lightning
Experience
This formula calculates a total amount based on unit pricing and total units.
Available in: All Editions

Unit_price__c * Total_units__c

User Pricing
This formula calculates a price per user license.
Total_license_rev__c / Number_user_licenses__c

494
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Sample Scoring Calculations Formulas

For details about using the functions included in these samples, see Formula Operators and Functions
EDITIONS
by Context on page 388.
Available in: both Salesforce
Lead Scoring Classic and Lightning
Experience
This formula scores leads, providing a higher score for phone calls than website requests.
Available in: All Editions

CASE(LeadSource, "Phone", 2, "Web", 1, 0)

Here's a formula that scores a lead based on his or her rating:

CASE(1, IF(ISPICKVAL(Rating, "Hot"), 1, 0), 3, IF(ISPICKVAL(Rating, "Warm"), 1, 0), 2,
IF(ISPICKVAL(Rating, "Cold"), 1, 0), 1))

Customer Success Scoring

This formula uses a simple scoring algorithm to rank customers a high score for positive survey results in Salesforce.
Survey_Question_1__c * 5 + Survey_Question_2__c *2

Formulas: How Do I ... ?

EDITIONS
Common Math Calculations
• Add numbers? Available in: both Salesforce
Classic and Lightning
• Convert text into a number
Experience
• Divide numbers?
Available in: All Editions
• Multiply numbers?
Some How Do I's are not
• Round numbers?
relevant to Database.com
• Subtract numbers?

USER PERMISSIONS
Common Text Functions
• Check if a field contains specified text? To view formula field details:
• View Setup and
• Check if a picklist contains a specified value?
Configuration
• Combine first and last names?
To create, change, or delete
• Convert numbers into text? formula fields:
• Create a hyperlink field? • Customize Application

Advanced Formulas
• Calculate Commission Amounts for Opportunities?
• Set Up Round-Robin Assignment of Cases or Leads?
• Set Up Opportunity Discount Rounded?

495
Extend Salesforce with Clicks, Not Code Calculate Field Values with Formulas

Custom Summary Formulas for Reports

• Calculate the sum of all leads that have Email Opt Out and Do Not Call fields selected?
• Calculate the difference of all Amount fields and all Discounted Amount fields on opportunities?
• Calculate the average of all opportunities?
• Calculate what percent of all opportunities are closed won
• Calculate the number of active Salesforce users to the 2nd power for administration?
• Calculate the duration of all activities (minutes) times the number of records per 24 hours?
• Calculate the average percent margin on a product-by-product level across many opportunities?
• Calculate the percentage of one product compared to all products in closed opportunities?
• Calculate the change in revenue from opportunities between months?

Cross-Object Formulas
• Display a Percent field from a parent object?
• Display a text field from a parent object?
• Display a phone number field from a parent object?
• Display a picklist field from a parent object?
• Display a URL field from a parent object?

Common Formula Errors

Review common errors that can occur with formulas and how to fix them.
EDITIONS
• “#Error!” displays for a formula field whenever an error occurs while calculating the value of a
formula. To resolve the error, check your formula. Available in: both Salesforce
Classic (not available in all
– Is the formula dividing by zero? If so, check if the denominator of your expression is zero
orgs) and Lightning
and provide an alternative value. For example, the following campaign formula field is blank
Experience
if the number of opportunities is zero:
Available in: All editions

IF(NumberOfOpportunities > 0,
NumberOfWonOpportunities / NumberOfOpportunities, null)

– Is the formula calculating a value larger than the maximum value of the current type? If so, you can append L to numeric values
to make them Long so the intermediate products will be Long and no overflow occurs. For example, the following example
shows how to correctly compute the amount of milliseconds in a year by multiplying Long numeric values.
Long MillsPerYear = 365L * 24L * 60L * 60L * 1000L;
Long ExpectedValue =
31536000000L;

System.assertEquals(MillsPerYear, ExpectedValue);

– Is the formula calculating the square root of a negative number? If so, use an IF function similar to the one above to check if the
value is a positive number.

496
Extend Salesforce with Clicks, Not Code Generate Emails From Records

– Is the formula calculating the LOG of a negative number? If so, use an IF function similar to the one above to make sure that the
number is positive.
– Is the formula using the VALUE function with text that contains special characters? For examples of special characters, see Formula
Operators and Functions on page 388.
– Make sure the formula does not contain a HYPERLINK function within a text function, such as LEFT(
HYPERLINK("http://MYCOMPANY.ORG ", "MYCOMPANY ") , 5).
– Is the formula disabled or referencing a disabled formula field? Salesforce disables formula fields when they are deleted and they
remain disabled after they are restored. To enable disabled formula fields, edit and save the field. For more information on deleted
custom fields and restoring them, see Manage Deleted Custom Fields on page 275.

• “#Too Big!” displays if your formula output is over 18 digits. When this happens, check your formula for calculations that could result
in more than 18 digits. Avoid multiplying large numbers, raising a large number to a power, or dividing by a very small number.
• CASE functions return an error whenever any of the expressions return an error, regardless of which one should be returned. For
example, CASE(Field__c,"Partner", "P", "Customer", "C", LEFT(Field__c, -5)) returns an error
even if the value of the field is “Partner” or “Customer” because the last statement is illogical.
• Prevent division by zero errors by including an IF function that determines if the value of a field is zero. For example, IF(Field__c
=0,0, 25/Field__c).

Generate Emails From Records

A merge field is a field you can put in an email template, mail merge template, custom link, or
EDITIONS
formula to incorporate values from a record. For example, you can place a merge field in an email
template so that the greeting includes the recipient’s name rather than a generic “Hello!”. Available in: both Salesforce
You can use merge fields within custom formula fields, s-controls, custom links, custom buttons, Classic and Lightning
Visualforce pages, and when you create email or mail merge templates. Experience

Merge field names are determined when you create a new custom field or object. Field Name The available merge fields
is automatically populated based on what you type into Field Label. You can customize this vary according to which
field if you want, but keep in mind that the name must: Salesforce edition you have.
• Only use underscores and alphanumeric characters
• Begin with a letter and end with a letter
• Not include spaces
• Not contain two consecutive underscores

Important: Ensure that the custom field name and label are unique for that object.
• If a standard and custom field have identical names or labels, the merge field displays the custom field value.
• If two custom fields have identical names or labels, the merge fieldcan display an unexpected value.
If you create a field label called Email and a standard field labeled Email exists, the merge field is unable to distinguish
between the fields. Adding a character to the custom field name makes it unique. For example, Email2.
To find the merge field name for an object or field in Salesforce, visit the object or field’s detail page and refer to Field Name.
To incorporate merge fields, use the editor in the respective feature. Salesforce provides valid merge fields in each editor for all related
standard and custom objects. If you’re using the Connect for Office Word add-in to create mail merge templates, you’ll see a complete
list of valid merge fields to insert.

497
Extend Salesforce with Clicks, Not Code Generate Emails From Records

Merge Field Syntax

A merge field’s syntax can vary depending on where you use the field. To make sure that you use the correct syntax, select merge
fields from the dropdown list in the editor where you use the merge field.
Merge Fields for Validation Rules
Merge Fields for Formulas
Merge Fields for Cross-Object Formulas
A Cross-object formula is a formula that spans two related objects and references merge fields on those objects.
Merge Field Tips
Here are a few pointers for getting the most out of merge fields.

Merge Field Syntax

A merge field’s syntax can vary depending on where you use the field. To make sure that you use
EDITIONS
the correct syntax, select merge fields from the dropdown list in the editor where you use the merge
field. Available in: both Salesforce
Custom objects and fields are always appended with __c when referenced. The object precedes Classic and Lightning
field labels, and all spaces convert to underscores. For example, Account.CreatedDate Experience
references the Created Date standard field for the account object. The available merge fields
In standard relationships, the name of the relationship is the master object. For example, you can vary according to which
reference the account name from a contact validation rule using Account.Name. You can Salesforce edition you have.
reference the phone number of the account creator from an opportunity product formula field
using Opportunity.Account.CreatedBy.Phone. In custom relationships, the name
of the relationship is the value specified in Field Name with __r appended to it. For example, you can reference contact email
from a custom object validation rule using Contact__r.Email.

Merge Fields for Validation Rules

A merge field is a field you can put in an email template, mail merge template, custom link, or
EDITIONS
formula to incorporate values from a record.
Available in: both Salesforce
Syntax and Formatting Classic and Lightning
Experience
When you insert a merge field in a validation rule, the syntax consists of the object, a period, and
the field name. For example, $User.State corresponds with a user’s state or province. Available in: Essentials,
Contact Manager, Group,
A merge field’s syntax can vary depending on where you’re using the field. To make sure you’re Professional, Enterprise,
using the correct syntax, select merge fields from the drop-down list in the editor where you’re Performance, Unlimited,
using the merge field. The merge fields for validation rules correspond directly with the fields in Developer, and
your app. Database.com Editions
For a list of fields in an object, from the management settings for the object, go to the fields section.

Important:
• If two or more custom objects have matching names or labels, only one of the objects
appears when you select from available merge fields. Make sure that all custom objects
have unique names and labels so that you can select merge fields from any of the objects.

498
Extend Salesforce with Clicks, Not Code Generate Emails From Records

Limitations
Validation rules can’t reference merge fields for:
• Auto number fields, such as Requisition Number
• Compound fields, such as addresses, first and last names, dependent picklists, and dependent lookups

Note: Validation rules can reference merge fields individual address fields, such as Billing City.

• Campaign statistic fields, including statistics for individual campaigns and campaign hierarchies

Tips
• Some merge fields display as radio buttons but function like picklist fields when referenced in a formula.
Use the values “Read,” “Edit,” and “None” in a formula when referencing:
– $UserRole.CaseAccessForAccountOwner
– $UserRole.OpportunityAccessForAccountOwner
– CaseAccessLevel (on Territory)
– OpportunityAccessLevel (on Territory)
Use the values “Read,” “Edit,” and “All” in a formula when referencing:
– AccountAccessLevel (on Territory)

• Use the RecordType.Id merge field in your formula to apply different validations for different record types.

SEE ALSO:
Find Object Management Settings

Merge Fields for Formulas

A merge field is a field you can put in an email template, mail merge template, custom link, or
EDITIONS
formula to incorporate values from a record.
Available in: both Salesforce
Syntax and Formatting Classic (not available in all
orgs) and Lightning
Merge fields for formulas aren’t enclosed in curly braces or preceded by an exclamation point, nor Experience
are they preceded by the type of record. For example: AccountNumber. To ensure you’re using
the correct syntax, use the Insert Field button or the drop-down list in the formula editor. Available in: All editions

SEE ALSO:
Tips for Using Merge Fields in Formulas
Build a Formula Field

499
Extend Salesforce with Clicks, Not Code Generate Emails From Records

Merge Fields for Cross-Object Formulas

A Cross-object formula is a formula that spans two related objects and references merge fields on
EDITIONS
those objects.

Important: Where possible, we changed noninclusive terms to align with our company Available in: Salesforce
value of Equality. We maintained certain terms to avoid any effect on customer Classic (not available in all
orgs)
implementations.
A merge field is a field you can put in an email template, mail merge template, custom link, or Available in: All editions
formula to incorporate values from a record.
A cross-object formula can reference merge fields from a master (“parent”) object if an object is on the detail side of a master-detail
relationship. A cross-object formula also works with lookup relationships. For example, you can write a cross-object formula that references
the Account Name for a contact associated with a case. In this example, you would type Contact.Account.Name in a formula
on the Case object.

Syntax and Formatting

Merge fields for formulas aren’t enclosed in curly braces or preceded by an exclamation point. Use the relationship names of the objects,
not the labels. Although the relationship name is often the same as the object name, it is technically the field name of the relationship
field.
To reference the parent account name from Account object, the syntax is Parent.Name, not Account.Name. When referencing
a custom object, add two underscores and the letter r to its name. For example, Position__r.title__c references the Job
Title field (title__c) on a Position custom object.

Limitations
You can’t reference:
• Merge fields for objects related to activities. For example, merge fields for contacts and accounts are not available in task and event
formulas.
• The $RecordType global variable—it only resolves to the record containing the formula, not the record to which the formula
spans. Starting with the Spring ’13 release, when you create a new formula the $RecordType global variable is only available
for default value formulas.
The value of the Profile.Name merge field differs depending on the context of the cross-object formula field that references it. On
detail pages, the value is the profile name, as expected. In list views and reports, the value is the internal value of the associated profile
instead. If you use Profile.Name in a formula, use it within an OR function to ensure that the formula always returns the intended
result. For example:
IF
(OR
(LastModifiedBy.Profile.Name = "Standard User", LastModifiedBy.Profile.Name =
"PT2"),
"Standard", "Not Standard")

None of the above applies to profile names referenced by the $Profile global variable.

500
Extend Salesforce with Clicks, Not Code Build Your Own Salesforce App

Merge Field Tips

Here are a few pointers for getting the most out of merge fields.
EDITIONS
To make sure you’re using the correct syntax, select merge fields from the merge field picker.
Available in: both Salesforce
• To use a merge field as the destination of a link, insert the merge field after http://.
Classic and Lightning
• Salesforce rounds decimal values referenced in merge fields on email templates to three digits Experience
regardless of locale.
The available merge fields
• You can store the name of an account, contact, or lead in your organization’s default language
vary according to which
(the local name), in addition to the account or user’s default language (the standard name). If
Salesforce edition you have.
the local name is blank, the standard merge field name is used.
• To reference a stand-alone file, use $Resource.<resource_name>, where
<resource_name> is the name you specified when you uploaded the resource.
• If you're using the Translation Workbench to translate custom field names, users can look up merge fields in their chosen language.
• You can’t use a lookup field as a merge field in an email template. You can, however, create a hidden formula field on the page
layout that pulls the value from the lookup field. Then include the hidden field in the email template.

Build Your Own Salesforce App

An app is a collection of items that work together to serve a particular function. Salesforce apps
EDITIONS
come in two flavors: Classic and Lightning. Classic apps are created and managed in Salesforce
Classic. Lightning apps are created and managed in Lightning Experience. You can customize both Available in: Salesforce
types of app to match the way your users work. Classic (not available in all
The platform includes innovative point-and-click app-building tools that give you the power to orgs), Lightning Experience,
customize Salesforce to meet the needs of your business. You can also build your own apps to share and the Salesforce mobile
and store information that is important to you. You don’t need any programming knowledge to app
use these tools. You can find them in Salesforce Classic Setup by selecting Create, and in Lightning Available in: Contact
Experience Setup by entering App in the Quick Find box to get started. Manager, Group,
The platform also includes app building tools that require some programming knowledge. You can Professional, Enterprise,
find tools that require advanced programming knowledge in Salesforce Classic Setup by selecting Performance, Unlimited,
Develop, and in Lightning Experience Setup by entering Custom Code in the Quick Find box. and Developer Editions

Classic apps are a collection of standard and custom tabs, including:

USER PERMISSIONS
• Most standard objects, including Home, the main Chatter feed, Groups, and People
• Your org’s custom objects To view apps:
• Visualforce tabs • View Setup and
Configuration
• Lightning component tabs
To manage apps:
• Canvas apps via Visualforce tabs • Customize Application
• Web tabs
Lightning apps are a collection of items that include everything from the Classic apps list, plus
Lightning page tabs, and utilities like Sales Dialer. In Lightning apps, you can customize the app’s logo and enhance its branding by
customizing the color of the navigation bar.
You can also upgrade Classic apps to Lightning apps in Lightning Experience, but the two versions of the app must then be managed
separately in their own environments.
Salesforce provides standard apps such as Sales and Service.

501
Extend Salesforce with Clicks, Not Code Build Your Own Salesforce App

You can also build your own on-demand apps by grouping items into new custom apps. A custom app consists of a label, a description,
and an ordered list of items, which often includes tabs. You can also add custom logos and branding to your custom apps.
In Salesforce Classic, custom apps are listed in the Lightning Platform app menu, which is a dropdown list displayed at the top of every
page.

In Lightning Experience and the Salesforce mobile app, you can find your available custom apps in the App Launcher ( ). In Lightning
Experience, to see all your available Salesforce apps and items, click View All.

502
Extend Salesforce with Clicks, Not Code Build Your Own Salesforce App

When you choose an app, your screen changes to reflect the contents of that app. For example, if you switch from an app that contains
Opportunities to another app that doesn’t, the Opportunities item disappears. In addition, the app might display a different default
landing tab when selected.
Apps are associated with profiles. Profiles control which tabs you can see or hide, as well as which apps are available to you.

Lightning Apps
With apps in Lightning Experience, members of your org can work more efficiently by easily switching between apps. Users can
open apps you’ve created from the App Launcher. What’s most important to sales reps? Accounts, events, and organizations. How
about sales managers? Reports and dashboards make the top of the list. Lightning apps take things to another level past Classic
apps by letting you brand your apps with a custom color, logo, and utility bar.
Tips for Creating Apps in Lightning Experience
It’s time for the fun part: deciding how to set up Lightning apps for your users. Here are some tips for planning Lightning apps for
your org.
Create Lightning Apps
As in Salesforce Classic, you can create apps in Lightning Experience, but with even more bells and whistles. You can brand and
customize Lightning apps to help your users work more efficiently. For example, you can create a Lightning app for your finance
department that includes all important items, including tabs, for users to complete common tasks. You can customize the navigation
bar color, brand it with a logo, and make the app available in the App Launcher for the user profiles associated with the finance
department.
Customize Lightning Apps with the Lightning App Builder
When you edit a Lightning app from the App Manager in Setup, you’re brought into the Lightning App Builder to manage the app’s
settings. Update app branding, navigation, and other options, and manage the Lightning pages assigned to that app all in one place.
Add a Utility Bar to Lightning Apps
The utility bar is a specialized type of Lightning page that gives your users quick access to common productivity tools, like Notes
and Recent Items. It appears as a fixed footer that users can access to open utilities in docked panels. Some utilities support pop-out,
which lets them open in a new browser window.
Lightning App Navigation Bar Items
Most of the items that appear in the App Launcher can appear in a Lightning app navigation bar. To add items to an app’s navigation
bar, you can use the Lightning app creation wizard, which lets you choose from a list of available items.
Upgrade Classic Apps to Lightning Apps
You can upgrade a Classic app to a Lightning app in Lightning Experience, enhancing it for your Lightning Experience users with a
customized color, logo, utility bar, and more items like Lightning pages supported in the navigation bar.
Salesforce App Considerations
Keep these considerations in mind when working with apps in either Lightning Experience or Salesforce Classic.
Create Custom Apps for Salesforce Classic
Create custom apps to give your Salesforce Classic users access to everything they need all in one place.
Subtab Apps in Salesforce Classic
An app is a group of tabs that work as a unit to provide application functionality. Similarly, a subtab app is a collection of tabs that
appears on the Chatter profile page. A subtab app can include both default and custom tabs.

503
Extend Salesforce with Clicks, Not Code Lightning Apps

Lightning Apps
With apps in Lightning Experience, members of your org can work more efficiently by easily switching
EDITIONS
between apps. Users can open apps you’ve created from the App Launcher. What’s most important
to sales reps? Accounts, events, and organizations. How about sales managers? Reports and Available in: Lightning
dashboards make the top of the list. Lightning apps take things to another level past Classic apps Experience
by letting you brand your apps with a custom color, logo, and utility bar.
Available in: Contact
Lightning apps contain everything you expect from a custom app, such as custom and standard
Manager, Group,
objects, and custom tabs. But Lightning apps can also include Lightning page tabs and utilities like Professional, Enterprise,
Lightning Voice. The navigation model of Lightning apps is optimized for efficiency, with actions Performance, Unlimited,
on certain items like Opportunities in the navigation bar. You can even append navigation items and Developer Editions
to a Lightning app that you found on AppExchange and installed from a managed package.
Custom apps from Salesforce Classic automatically work in Lightning Experience and can be
upgraded to Lightning apps. Classic apps appear in the list of apps in Setup alongside your Lightning apps, and are available from the
App Launcher as long as their Show in Lightning Experience attribute is enabled.
However, the reverse isn’t true for Lightning apps. Lightning apps aren’t available in Salesforce Classic.
You can assign multiple user profiles to multiple apps. Also, you can assign as many user profiles to one app as you need to. For instance,
you have several groups involved with inside sales. Assign all the groups to your inside sales app, and they all have access to it.
To switch between apps, users can use the App Launcher. This makes it easy for users to switch contexts and still have access to the
items, objects, and pages they need most.
You can view all the apps in your org from the App Manager. In Lightning Experience Setup, enter App in the Quick Find box, then
select App Manager.

SEE ALSO:
Create Lightning Apps
Upgrade Classic Apps to Lightning Apps
Salesforce App Considerations

Tips for Creating Apps in Lightning Experience

It’s time for the fun part: deciding how to set up Lightning apps for your users. Here are some tips
EDITIONS
for planning Lightning apps for your org.
The best time to create Lightning apps is when you’re rolling out Lightning Experience. So make Available in: Lightning
creating Lightning apps a part of your rollout strategy. Check out the Trailhead module “Lightning Experience
Experience Rollout” for many great ideas to help you make a smooth transition.
Available in: Enterprise,
Talk to your users. Ask them what their priorities are. Customizing tabs in apps gives you a unique Professional, Performance,
opportunity to engage with your users. Each group of users has its own priorities. Find out which Unlimited, and Developer
objects and items represent their highest priorities. Editions
• Ask users to post feedback to a Chatter group.
• Publish polls.
• Schedule lunch sessions. Everyone likes a free lunch, and nearly everybody is happy to express their opinion.
Create a master list of objects that everyone in your org wants. Then trim down the list for each group—sales reps, sales managers,
execs, and so on. The menus for every user group share some common objects, like Home, Tasks, and Feed. Keep the high-priority items

504
Extend Salesforce with Clicks, Not Code Create Lightning Apps

for each group at the top. Put low-priority items at the bottom, or remove them altogether. Users can always go to the App Launcher
to get the items they use less often.

Create Lightning Apps

As in Salesforce Classic, you can create apps in Lightning Experience, but with even more bells and
EDITIONS
whistles. You can brand and customize Lightning apps to help your users work more efficiently.
For example, you can create a Lightning app for your finance department that includes all important Available in: Lightning
items, including tabs, for users to complete common tasks. You can customize the navigation bar Experience
color, brand it with a logo, and make the app available in the App Launcher for the user profiles
associated with the finance department. Available in: Contact
Manager, Group,
1. From the Home tab in Setup, in the Quick Find box, enter App, and then select App Manager. Professional, Enterprise,
2. To use an existing custom app as the basis for a new custom app, find the source app in the Performance, Unlimited,
list, select Clone from its action menu, and then go through the Lightning app creation wizard. and Developer Editions
This feature is only available for custom Lightning apps. It isn’t available for standard, connected,
managed, community, or classic apps. USER PERMISSIONS
3. To create an app from scratch, click New Lightning App, and walk through the New Lightning To view apps:
App wizard. • View Setup and
Here are some things you can do in the wizard. Configuration

• Give your app a name, set its primary color, and give it a logo. The app description displays To manage apps:
alongside the icon in the App Launcher. Make sure that the description is meaningful to • Customize Application
your users.
• Choose whether to override a custom theme’s brand image and navigation bar color with
the brand image and color from the app.
• Choose which type of navigation to use—standard or console.
• Choose which form factors your app is available for.
• Add a utility bar for common processes and tools, like Recent Items, Notes, Dialer, and Open CTI.
• Customize which items appear in the app’s navigation bar.

Note: If you add more than 50 default navigation items to an app, your users can’t personalize the app’s navigation bar.

When organizing the navigation bar, the item at the top of the list becomes your app’s landing page on desktop and mobile.
The order of items in the navigation bar also determines the default objects shown in the Top Results page on the search results
page. After the user interacts with the app for 15 days, Top Results reflects the user’s most frequently used objects. If the user
doesn’t have access or permissions to the app, Top Results includes the Account, Contact, Opportunity, Case, Lead, People (User),
and Group objects until the user’s most frequently used objects are determined.

• Assign the app to user profiles.

SEE ALSO:
Lightning Apps
Create and Edit a Custom Lightning Console App
Add a Utility Bar to Lightning Apps
Salesforce App Considerations

505
Extend Salesforce with Clicks, Not Code Customize Lightning Apps with the Lightning App Builder

Customize Lightning Apps with the Lightning App Builder

When you edit a Lightning app from the App Manager in Setup, you’re brought into the Lightning
EDITIONS
App Builder to manage the app’s settings. Update app branding, navigation, and other options,
and manage the Lightning pages assigned to that app all in one place. Lightning App Builder is
1. From the Home tab in Setup, enter App in the Quick Find box, then select App Manager available in: both Salesforce
Classic and Lightning
2. Click on a Lightning app’s row, and select Edit.
Experience
Here are some things you can do from the App Settings tab.
Lightning apps are available
• Change your app’s name, primary color, and logo. in: Lightning Experience
• Override the org theme with your app’s brand image and nav bar color.
Available in: Group,
• Add a utility bar for common processes and tools, like Recent Items, Notes, Dialer, and Open Professional, Enterprise,
CTI. Performance, Unlimited,
• Manage which default items appear in the app’s navigation bar. and Developer Editions
• Manage user profile assignments.
On the Navigation Items tab, you can control which objects and other items—like Visualforce USER PERMISSIONS
pages or Lightning components—are included in your app. To create a custom object by
To manage apps, and to
importing data from a spreadsheet, click Create at the top of the Available Items section.
create and save Lightning
3. Click the Pages tab in the Lightning App Builder header to see all the active Lightning pages pages in the Lightning App
Builder:
assigned to the app, create pages, and open existing pages, even ones not associated with the
• Customize Application
app.
To view apps, and to view
Tip: If you create pages for your app, when finished, don’t forget to click Activation to Lightning pages in the
make them active for your users and assign them to the app. Lightning App Builder:
• View Setup and
Configuration
SEE ALSO:
Lightning Apps
Create Lightning Apps
Lightning App Builder

506
Extend Salesforce with Clicks, Not Code Add a Utility Bar to Lightning Apps

Add a Utility Bar to Lightning Apps

The utility bar is a specialized type of Lightning page that gives your users quick access to common
EDITIONS
productivity tools, like Notes and Recent Items. It appears as a fixed footer that users can access to
open utilities in docked panels. Some utilities support pop-out, which lets them open in a new Available in: Lightning
browser window. Experience
Utilities harness the power of Lightning components. When you set up a utility bar, you select which
Available in: Contact
Lightning components to use as utilities.
Manager, Group,
Background utility items are added the same way as normal utility items, but don’t appear in the Professional, Enterprise,
utility bar. The icon appears next to background utility items on the utility item list. If you have Performance, Unlimited,
only background utility items in your utility bar, the utility bar doesn’t appear in your app. You need and Developer Editions
at least one non-background utility item in your utility bar for it to appear.
You can add or edit a utility bar at any time. USER PERMISSIONS
1. From the Home tab in Setup, enter App in the Quick Find box, then select App Manager. To view apps:
2. To edit or add a utility bar to an existing app, click Edit in the dropdown menu next to your • View Setup and
app. To create a Lightning app with a utility bar, click New Lightning App. Configuration

3. Click the Utility Items tab and add the utilities you want. To manage apps:
• Customize Application
Specify component and utility properties, like the height and width of the utility panel, and
what label and icon to display in the utility bar. Some utilities have properties that can’t be
changed.

Tip: A Lightning page region can contain up to 100 components. We recommend adding no more than 10 utilities, and that
you keep the utility labels short and sweet. You want your users to quickly find the tools and processes they need most.

Example: Here’s a utility bar with the Recent Items and Notes utilities.

When creating a utility bar for your app, keep these things in mind:
• Utility bars created using the Lightning App Wizard or in the Lightning App Builder can be assigned to only one Lightning app.
However, utility bars created using the API can be assigned to multiple Lightning apps.
• The utility bar doesn’t support Visualforce pages or components.

507
Extend Salesforce with Clicks, Not Code Add a Utility Bar to Lightning Apps

• The utility bar doesn’t fully support the Chatter Publisher and Feed components.
• The History utility works in Lightning console apps only.
• The Omni-Channel utility works in the Lightning Service Console app only.
• The default utility bar alignment matches the user’s language setting alignment. For example, English is read left to right. If you
select Default and a user’s language is set to English, the utility bar appears at the bottom of the left side of the screen. If you select
Mirrored, the utility bar appears at the bottom of the right side of the screen.

Using Pop-Out Utilities

Utilities that support pop-out can be “popped out” of the utility bar and into their own separate child windows. To pop a utility out,
click the icon. From there, you can pop the utility back into the utility bar with the icon, or close the utility. Pop-out utilities
are the Lightning equivalent to multi-monitor components in Classic.

SEE ALSO:
Customize Your Lightning Console App with Utilities
Create Lightning Apps
Lightning Web Components Dev Guide: Configure a Component for the Utility Bar
Salesforce Console Developer Guide: Using Background Utility Items
Salesforce Console Developer Guide: Using Pop-Out Utilities

Using Pop-Out Utilities

Utilities that support pop-out can be “popped out” of the utility bar and into their own separate child windows. To pop a utility out, click
the icon. From there, you can pop the utility back into the utility bar with the icon, or close the utility. Pop-out utilities are the
Lightning equivalent to multi-monitor components in Classic.

Note: Popping-out docked utility bar items isn't supported in Lightning Experience on iPad Safari.

Standard Utilities
Pop-out is supported for these standard utilities. Standard utilities are utilities that are included with Salesforce.
• Open CTI Softphone
• History
• Rich Text
• Report Chart
• Visualforce
• Flow
• List View
• Recent Items
• Chatter Feed
• Chatter Publisher
• Notes

508
Extend Salesforce with Clicks, Not Code Lightning App Navigation Bar Items

Custom Utilities
Pop-out is available for custom utilities. To enable pop-out for custom utilities, activate the Utility Bar: Enable Pop-Out for Custom
Utilities critical update. The critical update enables pop-out for all utilities in the “Custom” and “Custom – Managed” categories. Test
your custom utilities in a sandbox environment before you enable the update.

Disabling Pop-Out
If you don’t want your custom utility to be popped out, you can disable pop-out in two ways.
Disabling Pop-Out within the Component
Use the lightning:utilityItem interface in your component and set the supportsPopOut attribute to false to disable
pop-out.
<aura:component implements="lightning:utilityItem">
<aura:attribute name="supportsPopOut" type="Boolean" default="false" />
</aura:component>

Disabling pop-out within the component itself is a useful and simple way to ensure that the component can never be popped out.
Disabling Pop-Out with the Lightning Console JavaScript API
Use the disableUtilityPopOut() method and set the disabled argument to true to disable utility pop-out.
If you’re migrating from a Classic console app and using a Visualforce page for your utility, we automatically respect if
setCustomConsoleComponentPopoutable is set to false.
Disabling pop-out with the Lightning Console JavaScript API allows you to enable and disable pop-out in real time.

Lightning App Navigation Bar Items

Most of the items that appear in the App Launcher can appear in a Lightning app navigation bar.
EDITIONS
To add items to an app’s navigation bar, you can use the Lightning app creation wizard, which lets
you choose from a list of available items. Available in: Lightning
The list of available items contains only those items in your org that are eligible for Lightning app Experience
navigation bars, which includes:
Available in: Enterprise,
• Most standard objects, including Home, the main Chatter feed, Groups, and People Professional, Performance,
• Your org’s custom objects and apps Unlimited, and Developer
Editions
• Visualforce tabs
• Lightning component tabs
USER PERMISSIONS
• Lightning page tabs
• Canvas apps via Visualforce tabs To view navigation menus:
• Web tabs • View Setup and
Configuration
If the Lightning app was installed from a managed package, you can append navigation items
To create navigation menus:
below the original set of navigation items included in the Lightning app, which are locked.
• Customize Application
Note: You can’t add Connected apps like Gmail™ and Microsoft® Office 365™ to the navigation
bar. Users can continue to access them from the App Launcher.

509
Extend Salesforce with Clicks, Not Code Upgrade Classic Apps to Lightning Apps

Upgrade Classic Apps to Lightning Apps

You can upgrade a Classic app to a Lightning app in Lightning Experience, enhancing it for your
EDITIONS
Lightning Experience users with a customized color, logo, utility bar, and more items like Lightning
pages supported in the navigation bar. Available in: Lightning
Note: You can’t upgrade a Salesforce Classic console app to Lightning Experience. You can Experience
choose to display or hide the app in the Lightning Experience App Launcher, but you can’t Available in: Contact
edit the app from the App Manager page in Lightning Experience Setup. To get started in Manager, Group,
Lightning Experience, customize these Salesforce-provided Lightning console apps: Service Professional, Enterprise,
Console and Sales Console. You can also recreate your Salesforce Classic console app in Performance, Unlimited,
Lightning Experience, but using the Salesforce out-of-the-box app is faster and easier. and Developer Editions
1. From the Home tab in Setup, enter App in the Quick Find box, then select App Manager.
2. Find the Classic app that you want to upgrade in the apps list. USER PERMISSIONS

Note: A checkmark in the Visible in Lightning Experience column means that the app To view apps:
is accessible in Lightning Experience via the App Launcher and is fully functional. Even • View Setup and
though a Classic app works in Lightning Experience, it doesn’t take advantage of all the Configuration
benefits of being a Lightning app. That’s why we recommend that you upgrade it. To manage apps:
• Customize Application
3. Click , and select Upgrade.
4. Review the app properties and update them if necessary.
If you have custom Lightning Home pages assigned to profiles in your org, and the app you’re upgrading is visible in Lightning
Experience, you see a checkbox that lets you apply those Home page profile assignments to the upgraded app. Selecting the checkbox
ensures that users see the custom Home page assigned to their profile when they're working in the upgraded app, and that you
can modify those Home page assignments if you need to.

5. Click Upgrade.
Your Classic app is copied and upgraded for Lightning Experience. You now have two versions of the app: a Classic version, and a
Lightning version. After you upgrade it, the Classic app is no longer accessible in Lightning Experience via the App Launcher. You
still see the Classic app in the apps list, but with the Visible in Lightning column deselected.
The two versions of your app now must be managed separately. Future changes you make to the Classic app won’t be reflected in the
Lightning version of the app, and vice versa.

Note: You can toggle the availability of your Classic apps in Lightning Experience by selecting or deselecting Show in Lightning
Experience on the Classic app’s detail page.

SEE ALSO:
Lightning Apps
Salesforce App Considerations

510
Extend Salesforce with Clicks, Not Code Salesforce App Considerations

Salesforce App Considerations

Keep these considerations in mind when working with apps in either Lightning Experience or
EDITIONS
Salesforce Classic.
Available in: Salesforce
Classic (not available in all
General
orgs), Lightning Experience,
• You can delete custom apps, but not standard apps. Deleting a custom app removes it from and the Salesforce mobile
the apps menu and the App Launcher, but doesn’t delete any associated objects. If you created app
objects for an app, consider deleting them as well.
Available in: Contact
• Salesforce Classic console apps are custom apps. Manager, Group,
• You can’t change an app’s type—such as standard to connected or vice versa—after you create Professional, Enterprise,
it. Performance, Unlimited,
and Developer Editions
• For Salesforce Platform and Salesforce Platform One license users, the Platform standard app
is the only app listed in the Lightning Platform app menu and the Lightning Experience App
Launcher. For details about specifying a unique label for the Platform standard app in Salesforce
Classic, see Create Custom Apps for Salesforce Classic on page 512.
• To assign apps to user profiles in Professional Edition, you must have user profiles enabled for your org.

Classic Apps
Consider these requirements when choosing a custom app logo for a Classic app from the document library:
• The image must be in GIF or JPEG format and less than 20 KB.
• If the image is larger than 300 pixels wide by 55 pixels high, then it is scaled to fit.
• For the best on-screen display, we recommend that you use an image with a transparent background.
• The Externally Available checkbox must be selected on the document’s properties so that users can view the image.

Lightning Apps
• The number of Lightning Apps you can create in an org varies by edition.

Edition Lightning Apps Limit

Professional Edition 10

Enterprise Edition 25

Unlimited Edition Unlimited

• A Lightning app’s description displays in the App Launcher, so we recommend that you keep the description concise.
• Users can’t remove the items you include in the navigation bar, and they can’t personalize the navigation bar when it contains more
than 50 items. For example, if you include 32 items in an app’s navigation bar, users can add 18 more personal items.
• Consider these requirements when choosing a custom app image for apps in Lightning Experience:
– App images represent your app in both Lightning Experience and the Salesforce app.
– Choose a JPG, PNG, BMP, or GIF image that's smaller than 5 MB.

511
Extend Salesforce with Clicks, Not Code Create Custom Apps for Salesforce Classic

– For best results, upload an image that's 128 by 128 pixels. Images larger than the maximum display of 128 by 128 pixels are
automatically resized.

• Even if you haven’t selected the option to override themes in the App Manager, your app’s brand image and color always override
the Lightning Lite and Lightning Blue themes.
• If you restrict an app to one type of device, only users viewing the app on that device can access it. For example, if you assign your
app to the Phone form factor, your desktop users don’t see the app in the App Launcher. Only your Salesforce mobile app users can
see it.
• Not all objects that appear in the App Launcher can appear in an app, but it’s easy to figure out which ones can. When you start the
wizard from the Lightning Experience App Manager, you see all available items for a navigation bar.
• Navigation items in a Lightning app installed from a managed package are locked. You can’t remove or reorder them. However, you
can append other navigation items so that they’re accessible in the Lightning app.
• You can create records and access recent records and lists for certain items directly from the navigation bar. Items with next to
their name support this feature, with a few exceptions. Tasks and Notes allow you to create a record but you can't access recent
records or lists. Reports and Dashboards allow you to see recent records but you can't see recent lists or create a record.
• Some tabs, such as web tabs and Visualforce tabs, aren't highlighted when you select them on the navigation bar. For example,
when you select Contacts, the tab is highlighted (1). However, when you select a web tab, the page displays but the tab isn’t
highlighted (2).

Create Custom Apps for Salesforce Classic

Create custom apps to give your Salesforce Classic users access to everything they need all in one
EDITIONS
place.
If you're new to custom apps, we recommend using Lightning Platform quick start to create an Available in: Salesforce
app. With this tool, you can generate a basic working app in just one step. Classic (not available in all
orgs)
If you’ve already created the objects, tabs, and fields you need for your app, follow these steps. With
this option, you create an app label and logo, add items to the app, and assign the app to profiles. Available in: Contact
1. From Setup, enter Apps in the Quick Find box, then select Apps. Manager, Group,
Professional, Enterprise,
2. Click New. Performance, Unlimited,
3. If the Salesforce console is available, select whether you want to define a custom app or a and Developer Editions
Salesforce console.
4. Give the app a name and description. USER PERMISSIONS
An app name can have a maximum of 40 characters, including spaces.
To view apps:
5. Optionally, brand your app by giving it a custom logo. • View Setup and
Configuration
6. Select which items to include in the app.
To manage apps:
• Customize Application

512
Extend Salesforce with Clicks, Not Code Create Custom Apps for Salesforce Classic

7. Optionally, set the default landing tab for your new app using the Default Landing Tab dropdown menu below the list of selected
tabs.
This determines the first tab a user sees when logging into this app.

8. Choose which profiles the app will be visible to.

9. Select the Default box to set the app as that profile’s default app, meaning that new users with the profile see this app the first time
they log in.
Profiles with limits are excluded from this list.

10. Click Save.

Create Apps in Salesforce Classic with App Quick Start

App quick start is a fast way to create a basic Classic app in just one step.
App Quick Start: Next Steps for Configuring Apps in Salesforce Classic
After you've created a basic working app with app quick start in Salesforce Classic, build out the app with more objects and fields,
define its access settings, and add users to share your app with them.

SEE ALSO:
Build Your Own Salesforce App
Salesforce App Considerations

Create Apps in Salesforce Classic with App Quick Start

App quick start is a fast way to create a basic Classic app in just one step.
EDITIONS
1. From Setup, enter Apps in the Quick Find box, then select Apps, and click Quick Start.
Alternatively, from the Lightning Platform Home page, click Add App under Getting Started, Available in: Salesforce
or App Quick Start under Quick Links. Classic (not available in all
orgs)
2. Enter the information needed for your app.
Available in: Contact
Field Name Description Manager, Group,
Professional, Enterprise,
App Label The app's name that appears in the Lightning Performance, Unlimited,
Platform app menu. The label can have a and Developer Editions
maximum of 40 characters, including spaces.

Plural Label The plural name of the object. This name USER PERMISSIONS
appears on the tab.
To create apps:
Singular Label A name used to refer to the object in any user • Customize Application
interface pages.
AND
Gender If it's appropriate for your org’s default Manage Profiles and
language, specify the gender of the label. This Permission Sets
field appears if the org-wide default language
expects gender.

Starts with a vowel sound If it's appropriate for your org’s default
language, enable this option if your label
should be preceded by “an” instead of “a”.

513
Extend Salesforce with Clicks, Not Code Create Custom Apps for Salesforce Classic

3. Click Create.
4. On the You’re All Set! page, click here to add new fields to your app.
5. To see your app as it will appear to users, click Go To My App.
The app quick start:
• Generates an app label and API name (a unique name that's used to refer to the object when using the Lightning Platform API).
• Generates an object label and API name.
• Generates a tab label, and associates the tab with the object.
• Enables feed tracking for the object. Feed tracking lets people follow records of that object type and see Chatter feed updates.
• Enables access to the app and tab in your user profile. Any users who have the Modify All Data permission can also access the object.
• Generates a permission set that grants access to the new custom object.
• Assigns the permission set to the user who creates the app.

Note: If you’re in a custom app, only the tabs included in the app appear and include the Create button.

After you've created an app, you can extend it with more components, specify access settings, and add users to your org.

SEE ALSO:
App Quick Start: Next Steps for Configuring Apps in Salesforce Classic
Salesforce App Considerations

App Quick Start: Next Steps for Configuring Apps in Salesforce Classic
After you've created a basic working app with app quick start in Salesforce Classic, build out the
EDITIONS
app with more objects and fields, define its access settings, and add users to share your app with
them. Available in: Salesforce
1. Build out your app with the basic components used in apps. Classic (not available in all
orgs)
• Create objects, which are custom database tables that allow you to store information specific
to your app. Available in: Contact
• Create tabs that are associated with the objects you've created. Manager, Group,
Professional, Enterprise,
• For each object, create fields to store the information that's important to your org.
Performance, Unlimited,
• Create validation rules, which verify that the data users enter meets the standards you and Developer Editions
specify before they save a record.
For quick shortcuts to these tools, use the Lightning Platform quick access menu, which is USER PERMISSIONS
available from object list view pages and record detail pages.
To create objects, tabs,
2. Create user profiles or permission sets. These are collections of settings and permissions that fields, and validation rules:
determine what users can do in an app. • Customize Application
3. Specify the types of access that users will have to the app. To create users:
a. Make your app visible using profiles or permission sets. • Manage Internal Users

b. Make your object tabs visible. To create profiles and

permission sets:
c. Set the object permissions for the objects you created. • Manage Profiles and
Permission Sets

514
Extend Salesforce with Clicks, Not Code Subtab Apps in Salesforce Classic

4. Add users to your org. When adding users, be sure to assign them the appropriate profiles or permission sets you created so they
can access your app.

SEE ALSO:
Create Apps in Salesforce Classic with App Quick Start
Salesforce App Considerations

Subtab Apps in Salesforce Classic

An app is a group of tabs that work as a unit to provide application functionality. Similarly, a subtab
EDITIONS
app is a collection of tabs that appears on the Chatter profile page. A subtab app can include both
default and custom tabs. Available in: Salesforce
Users can see different sets of tabs on the profile page depending on their context. Subtab apps Classic (not available in all
are the various sets of tabs available on specific pages, such as users’ profile pages. orgs)

These default subtab apps determine which tabs display, depending on the user’s context. Available in: Contact
Manager, Group,
Subtab App Displayed to the user when viewing... Professional, Enterprise,
Performance, Unlimited,
Profile (Others) Another user inside their internal org and Developer Editions
Profile (Self) Their own profile inside their internal org

Profile in Communities (Others) Another user while inside a community. It’s

shown only if Communities is enabled.

Profile in Communities (Self) Their own profile inside a community. It’s shown
only if Communities is enabled.

Note: End users can’t customize the display of subtab apps. Administrators can hide tabs within subtab apps using the Tab Hidden
option in Tab Settings. Users can see tabs set to Default Off and Default On.

Manage Subtab Apps in Salesforce Classic

You can view and customize the subtab apps on users’ profile pages.
Control Subtab App Visibility in Salesforce Classic
After you configure subtab apps, you can specify which users can see specific tabs on the profile page.

515
Extend Salesforce with Clicks, Not Code Subtab Apps in Salesforce Classic

Manage Subtab Apps in Salesforce Classic

You can view and customize the subtab apps on users’ profile pages.
EDITIONS
From Setup, in the Quick Find box, enter Apps, and then select Apps to show your org’s subtab
apps. Available in: Salesforce
Classic (not available in all
You can do the following:
orgs)
• To view details for a subtab app, click the name in the Subtab Apps section. This section
displays the subtab app properties, such as which tabs are part of the app, including any tabs Available in: Contact
that aren’t yet deployed. To view details, click custom tabs in the Included Tabs list. Manager, Group,
Professional, Enterprise,
• To change the properties of a subtab app, click Edit to choose the tabs to include in the subtab Performance, Unlimited,
app, change their display order, and set the Default Landing Tab. and Developer Editions
Note: Administrators can change permission sets or profile settings to limit users’ access
to each tab. This way, administrators can make specific tabs available to some users but USER PERMISSIONS
not to others.
To view apps:
• View Setup and
SEE ALSO: Configuration
Subtab Apps in Salesforce Classic To manage apps:
Control Subtab App Visibility in Salesforce Classic • Customize Application

Control Subtab App Visibility in Salesforce Classic

After you configure subtab apps, you can specify which users can see specific tabs on the profile
EDITIONS
page.
To control the visibility of tabs within a subtab app: Available in: Salesforce
Classic (not available in all
1. From Setup, in the Quick Find box, enter Profiles, and then select Profiles.
orgs)
2. Do one of the following:
Available in: Contact
• Original profile user interface—Click Edit next to the profile you want to modify and scroll Manager, Group,
to the Tab Settings section. Professional, Enterprise,
• Enhanced profile user interface—Click the profile you want to modify and click Object Performance, Unlimited,
Settings. Click the object you want to modify and click Edit. and Developer Editions

Note: Some profiles, including Chatter External and Chatter Free users, don’t have the
permissions to view subtab apps. USER PERMISSIONS

3. Change the tab settings. To view apps:

• View Setup and
End users can’t customize the display of subtab apps. Administrators can hide tabs within subtab
Configuration
apps using the Tab Hidden option in Tab Settings. Users can see tabs set to Default Off and
Default On. To manage apps:
• Customize Application
4. (Original profile user interface only) To reset users’ tab customizations to the tab visibility settings
that you specify, select Overwrite users’ personal tab customizations.

516
Extend Salesforce with Clicks, Not Code Lightning App Builder

5. Click Save.

SEE ALSO:
Subtab Apps in Salesforce Classic
Manage Subtab Apps in Salesforce Classic

Lightning App Builder

The Lightning App Builder is a point-and-click tool that makes it easy to create custom pages for
EDITIONS
the Salesforce mobile app and Lightning Experience, giving your users what they need all in one
place. The Lightning App Builder is also a one-stop shop for configuring Lightning apps. Available in: both Salesforce
You can access the Lightning App Builder from Setup by entering Lightning App Builder Classic and Lightning
in the Quick Find box and then selecting Lightning App Builder. Experience

With the Lightning App Builder, you can build: Available in: Group,
• Single-page apps that drill down into standard pages Essentials, Professional,
• Dashboard-style apps, such as apps to track top sales prospects or key leads for the quarter Enterprise, Performance,
Unlimited, and Developer
• “Point” apps to solve a particular task, such as an expense app for users to enter expenses and Editions
monitor expenses they’ve submitted
• Custom record pages for your objects, tailored to the needs of your users
• Custom Home pages containing the components and features that your users use most
• Custom forecasts pages containing components and features that give sales leaders information about planned revenue.

517
Extend Salesforce with Clicks, Not Code Create a Custom App Page: The Big Picture

But that’s not all. When you edit a Lightning app from the App Manager in Setup, you’re brought into the Lightning App Builder to
manage the app’s settings. You can update the app’s branding, navigation, app options, and manage the Lightning pages assigned to
that app all inside the Lightning App Builder.
The Lightning App Builder supports the same browsers as Lightning Experience and isn’t supported on mobile browsers. The minimum
recommended resolution for the Lightning App Builder is 1280x1024.

SEE ALSO:
Create an App Home Page with the Lightning App Builder
Create and Configure Lightning Experience Record Pages
Supported Browsers and Devices for Lightning Experience
Lightning Aura Components Developer Guide
Lightning Web Components Developer Guide

Create a Custom App Page: The Big Picture

With just a few steps, you can create an app page that lets your Lightning Experience and Salesforce mobile app users access the most
important objects and items in your custom app. Custom app pages are built using Lightning pages.
1. Before creating your page, determine which components you want to include and the global actions your users need.
2. Create the Lightning page.
3. Add actions to your page.
4. Activate your Lightning page in the Lightning App Builder.
Activation lets you create a custom tab for your app page, set its visibility, and add it to the Salesforce “Mobile Only” app navigation
and Lightning app navigation bar all in one place.

Lightning Pages
A Lightning page is a custom layout that lets you design pages for use in the Salesforce mobile app or Lightning Experience.
Lightning pages occupy a middle ground between page layouts and Visualforce pages. Like a page layout, Lightning pages allow you
to add custom items to a page. However, these items, instead of being fields or Visualforce components, are Lightning components,
which allow more flexibility.
The structure of a Lightning page adapts for the device it’s viewed on. The template you choose when creating the page controls how
it displays on a given device. The Lightning page’s template divides the page into regions.

518
Extend Salesforce with Clicks, Not Code Lightning Pages

Lightning pages are built using Lightning components—compact, configurable, and reusable elements that you can drop into regions
of the page in the Lightning App Builder.
You can use a Lightning page to create an app page that you can add to the navigation bar of a Lightning app, which makes it appear
when that app is viewed in both Lightning Experience and the Salesforce mobile apps. An app page gives your users quick access to
the objects and items that are most important in that app.
You can also use a Lightning page to create a customized Home page for Lightning Experience, or a custom record page for Lightning
Experience and the Salesforce mobile app. And if you’ve integrated Salesforce with Microsoft® Outlook® or Gmail™, you can create a
custom Email Application pane.
If you have a console app, you can create a Lightning page with pinned regions to let your users view and work with records while
navigating between subtabs.

Lightning pages support these components:

• Standard Components—Standard components are Lightning components built by Salesforce.
• Custom Components—Custom components are Lightning components that you or someone else have created. With some
configuration, custom Lightning components can work in the Lightning App Builder.
• Third-Party Components on AppExchange—The AppExchange provides a marketplace for Lightning components. You can find
packages containing components already configured and ready to use in the Lightning App Builder.

Example: This Lightning app page in the Salesforce mobile app has a list view component, a recent items component, and one
global action.

519
Extend Salesforce with Clicks, Not Code Lightning Pages

Lightning Page Types

You can create different types of Lightning pages with the Lightning App Builder. After you set a Lightning page’s type, you can’t change
it.

App Page
App pages are supported both in the Salesforce mobile app and Lightning Experience.
Use an app page to create a home page for a third-party app that you can add directly into the Salesforce mobile app and Lightning
Experience navigation menus. Your users then have an app home page where they can quickly access the most important objects and
items.
Add global actions to an app page to enhance its functionality. Global actions allow a user to do things from your app page, such as add
call details, create and update records, send email, and create a task. When a user visits a Lightning page in the Salesforce mobile app,
the page’s actions appear in its action bar. In Lightning Experience, actions appear in the highlights panel at the top of the page.

Important: Create actions in the full Salesforce site before adding them to your app page.

App pages support only global actions. Standard Chatter actions, such as Post, File, Link, and Poll, aren’t supported.
When a user visits an app page in the Salesforce mobile app or Lightning Experience, only the actions that you specify for the page are
displayed. If you haven’t specified any actions, no actions appear.

Home Page
Create Home pages with features relevant to specific types of users, and assign the customized pages to different apps or
app-and-user-profile combinations. Custom Home pages are supported in Lightning Experience only.

Forecasts Page
Create custom forecasts pages to include all the information that sales leaders require to drive accurate forecasts that support your
unique business. The Forecasts Page type is available when Collaborative Forecasts is enabled, and is supported for desktop in Lightning
Experience only.

Record Page
With a record page, you can create a customized version of an object’s record page, tailoring it to your users’ needs. Custom record
pages are supported in Lightning Experience and the Salesforce mobile app.

Note: Actions you see on Lightning Experience record pages and the Home page are taken from object and global page layouts.
You can’t add, edit, or remove actions on these pages using the Lightning App Builder.

Email Application Pane

Create custom email application panes to let users work with Salesforce content that’s most relevant to them in Microsoft® Outlook®
and Gmail™. Custom email application panes are supported in Salesforce Classic and Lightning Experience.

SEE ALSO:
Create an App Home Page with the Lightning App Builder
Create and Configure Lightning Experience Record Pages

520
Extend Salesforce with Clicks, Not Code Lightning Pages

Lightning Page Templates

Lightning page templates are Lightning components that have been configured to serve as templates
EDITIONS
for custom Lightning pages. Page templates can support different form factors, such as desktop or
phone. When you create a Lightning page in the Lightning App Builder, you can select a page Lightning App Builder
template that matches the device you’re designing the page for. available in: both Salesforce
Home page templates are desktop-only. Standard app page templates support both desktop and Classic and Lightning
phone. Standard record page templates support both desktop and phone, except the console Experience
pinned region templates, which are desktop only. If a form factor isn’t on the options list when you Lightning Home and utility
try to assign a Lightning page, then the page template doesn’t support it. bar pages available in:
When working on a page in the Lightning App Builder, you can use the form factor switcher to Lightning Experience
preview what the page looks like on different devices that the template supports.
Lightning app and record
Custom Lightning page template components are supported for record pages, app pages, and pages available in: both the
Home pages. You can create custom page templates only in Aura. For more information, see Create Salesforce mobile app and
a Custom Lightning Page Template Component in the Lightning Aura Components Developer Lightning Experience
Guide.
Email application pane
When switching your Lightning record pages to a different template, keep these considerations in pages available in: both
mind. Salesforce Classic and
Lightning Experience
• You can’t switch to a template that supports a smaller scope of devices than the original
template. For example, if you have a page using a template that supports both desktop and
Available in: Group,
phone, you can’t switch the page to use a template that supports only phone or only desktop.
Essentials, Professional,
When you choose to switch, the list of available templates reflects this rule and shows only the Enterprise, Performance,
templates that you can switch to. Unlimited, and Developer
• If you switch to a page template that doesn’t support the form factor of a component on your Editions
page, that component is dropped from the page at run time.
• You can’t switch from a non-pinned region template to a pinned region template.

521
Extend Salesforce with Clicks, Not Code Lightning Pages

Standard Lightning Page Components

Standard components are Lightning components built by Salesforce. Several standard components
EDITIONS
are available when creating Lightning pages.

Note: The components listed here are supported across all page types, except where Lightning App Builder
otherwise indicated. This list doesn’t show all of the standard components available in the available in: both Salesforce
Classic and Lightning
Lightning App Builder, only components with special considerations. Other standard
Experience
components are available and vary based on the type of page you create and which object
the page is associated with. Lightning Home and utility
Some standard components have required properties that you must configure for the component bar pages available in:
to work on the page. When you add a component to a Lightning page in the Lightning App Builder, Lightning Experience
its required properties are marked with an asterisk. Lightning app and record
A Lightning page region can contain up to 100 components. pages available in: both the
Salesforce mobile app and
If you have a page to be used in the Salesforce mobile app, use only Lightning components that Lightning Experience
the mobile app supports.
Email application pane
pages available in: both
Accordion Salesforce Classic and
Use the Accordion component to organize your components into collapsible sections. You can put Lightning Experience
multiple components in each section and customize the section name. You can have up to 25
Available in: Group,
sections, but we recommend no more than 10.
Essentials, Professional,
The Accordion component is supported for record and Home pages. Enterprise, Performance,
Unlimited, and Developer
Note: Programmatic versions of the accordion components don’t provide the same
Editions
functionality as their App Builder counterparts. For example, lightning-accordion
and lightning:accordion components don’t currently support lazy loading.

Actions & Recommendations

Give your users a to-do list in the Actions & Recommendations component. Show a variety of steps, including screen flows, field service
mobile flows, quick actions, and recommendations from your Next Best Action strategies. When a user opens a flow, in a console app
it starts in a subtab. In a navigation app, it starts in a window. You can add this component to supported object pages in Lightning
Experience.
For more information, see Lightning Flow for Service and the Actions & Recommendations Component.

Activities
Display the timeline of the activities of the record. This component appears only if Default Activities View is set to Activity Timeline. The
component can contain Create a Record quick actions that point to the Event and Task objects. It contains Log A Call and Send Email
actions for each of your org’s accounts, contacts, contracts, leads, opportunities, and activity-enabled custom object records.

Note: On the Case object, the component only shows the timeline of the activities. Actions appear in a Chatter Publisher component.

For more information, see Activities View and Actions in Lightning Experience.

After Conversation Work (Beta)

Display a countdown after a customer conversation ends. During the After Conversation Work (ACW) countdown period, support agents
can complete closing tasks like sending follow-up emails, updating a case, or finalizing their notes. Agents can exit the countdown early

522
Extend Salesforce with Clicks, Not Code Lightning Pages

by closing the call record or let it run its course. When the time runs out, the agent is considered available to help the next customer
whether or not they’ve closed the call record.
After Conversation Work is available only for Voice Call channels. To learn more, see Configure After Conversation Work (Beta).

App Launcher
The App Launcher displays a user’s available Salesforce apps and the connected apps the administrator has configured. Users navigate
between apps using the App Launcher.
This component is supported in API version 35.0 and later.
Contact Salesforce to enable the App Launcher component for the Lightning App Builder in your organization.

Call Recording Player

Use this component to listen to audio recordings of calls. The Call Recording Player component is available only for the Voice Call object.
This component is available in the Lightning App Builder in orgs where Service Cloud Voice is turned on. To view and use this component,
users need the Contact Center Agent permission set.
Because the Call Recording Player doesn't have an alternative text-based transcript, we recommend adding the Conversation Body
component underneath the Call Recording Player to support accessibility.

Chatter
As of API version 38.0, the Feed component has been renamed Chatter in the Lightning App Builder. Use it to place a publisher and feed
combo on a record page.

Chatter Feed
Use the Chatter Feed component to place a feed anywhere on a record page. The feed gives you a way to view posts, comments, and
questions. Its attribute, Feed Type, takes one of these values.
• Bookmarked—Shows a feed of all items the current user has bookmarked
• What I Follow—Shows a feed of all items the current user has followed
• To Me—Shows a feed of all items where the current user is mentioned
No coding is required to join a feed to a publisher. The connection is made automatically with the publisher and any feed on the page.
The Chatter Feed component is available in API version 38.0 and later.

Chatter Publisher
Use the Chatter Publisher component to place a feed publisher anywhere on a record page. The publisher gives you a way to post, poll,
or ask a question in a feed. Its attribute, Type, has the default value Global. Use the value Record when you want to associate the
publisher with an object's feed. Then posts that are created with the publisher are associated with the record rather than the global
Chatter feed. Use the Chatter Publisher component with the Chatter Feed component to get a full feed experience. No coding is required
to join a publisher to a feed. The connection is made automatically with the publisher and any feed on the page. The Chatter Publisher
component is available in API version 38.0 and later.

Conversation Body
Use this component to let agents view call transcripts in Service Cloud Voice. The Conversation Body component is available only for
the Voice Call object. Transcripts are generated in real time during the call and the complete transcript is stored on the call record. As

523
Extend Salesforce with Clicks, Not Code Lightning Pages

the call progresses, the transcript is generated and displayed in the component. Configure transcription data streams in Amazon Web
Services to generate call transcripts. To view and use this component, users need the Contact Center Agent permission set.

Dynamic Actions Bar (Pilot)

With this component you can add action buttons anywhere on your Lightning record and app pages. Add, delete, and change the order
of actions in the Dynamic Actions Bar. You can also control the visibility of the component and of individual actions in the component
based on record field, permission, or user.

Note: We provide the Dynamic Actions Bar component to selected customers through a pilot program that requires agreement
to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to
change, and we can’t guarantee acceptance. Dynamic Actions Bar component isn’t generally available unless or until Salesforce
announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability
within any particular time frame or at all. Make your purchase decisions only based on generally available products and features.
To set the visibility of individual actions in the Dynamic Actions Bar component at runtime:
1. In the Dynamic Actions Bar properties pane, click an action name to open the Action dialog.
2. Under Set Action Visibility in the Action dialog, click Add Filter.
3. Select Record Field to control action visibility for a record field, or Advanced to control action visibility for a record, permission, or
user.
4. Click the Field name field, and select a field from the dropdown list (for Record Field), or select a field type and then select a field
(for Advanced).
5. Select an operator and enter a value, then click Done.
Considerations
• This component is supported only for Lightning Experience desktop on record and app pages.
• The Dynamic Actions Bar supports all standard and custom global actions.
• This component is supported as a source for Dynamic Interactions on app pages only. See Dynamic Interactions in the Lightning
App Builder on page 568.
• Email quick action and FeedItem.MobileSmartActions actions aren’t supported for the Dynamic Actions Bar.
• If no actions are supported for the current object, a message appears in the Lightning App Builder properties pane.

Dynamic Related List – Single

Use this component to add a single related list to your Lightning page and customize it directly in the Lightning App Builder instead of
the page layout editor. In the component properties, choose the list’s fields and sort order, apply filters, add actions, and give the list a
descriptive name. To see the most relevant records, set up two or more related lists with different filters on the same object.
You can convert an existing Related List – Single component to a dynamic related list. From the Related List – Single component
properties pane, click Upgrade Now. Salesforce uses your assigned page layout to populate the fields and actions in the Dynamic
Related List –Single properties pane. If you don’t see the option to upgrade, Dynamic Related List – Single isn’t supported for the object
associated with the record page or for the related list selected in the properties pane.
You can use this component in record pages only.

Note: The Dynamic Related List – Single component is available for custom objects and for Salesforce record home objects that
are enabled for LWC, but not for external objects. If you don’t see Dynamic Related List – Single in the list of standard components,
it’s not currently available for the object associated with the record page. To suggest prioritized object support for the Dynamic
Related List – Single component, go to IdeaExchange.
Considerations

524
Extend Salesforce with Clicks, Not Code Lightning Pages

• Only the Related List – Single component can be upgraded to the Dynamic Related List – Single component.
• If a related list isn’t defined on a supported object’s page layout, fields populate the Dynamic Related List – Single properties pane
in the default order defined by Salesforce. Actions don’t populate automatically.
• You can add standard actions, custom buttons, and Create a Record and Update a Record quick actions on dynamic related lists.
Quick actions are available as mass actions on the related list.

Note: The Quick Actions on Related Lists feature is a Beta Service. Customers 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.

• In the Lightning App Builder, the dynamic related list preview shows a maximum of six records. Depending on permissions, the
number of records that users see in the related list on the Lightning page doesn’t always match the number of records in the list
preview.
• Only the List and Tile related list types are available for dynamic related lists. To display more than four fields in a dynamic related
list, use the List type in a main region.
• To filter on a currency field in a dynamic related list, enter only numbers and an optional decimal point. For multiple currencies, the
filter uses the default currency, even if you enter a currency symbol. For example, your default currency is in euros but you enter the
filter Price greater than or equal $15000. The related list shows records with prices greater than or equal to €15,000.
• Dynamic related lists support most relative date filters so you can filter on Date and DateTime fields using easy-to-understand,
human-speech-inspired syntax. These relative date filters aren’t supported: n DAYS AGO, n WEEKS AGO, n MONTHS AGO, n QUARTERS
AGO, n YEARS AGO, n FISCAL QUARTERS AGO, n FISCAL YEARS AGO.
• Related list results are truncated at 2,000 records, so a filter set that returns over 2,000 records spends extra time querying records
it can’t display. To improve your list’s performance, filter it to return a maximum of 2,000 records.
• When users go to a dynamic related list from a bookmark or shared URL, if they haven’t viewed the list before, they’re redirected to
the record detail page. To see the entire list, they can click View All again.

Einstein Field Recommendations

The Einstein Field Recommendations component recommends values for picklist, checkbox, and lookup fields on cases. It’s used in
Einstein Case Classification and Einstein Case Wrap-Up, and is available only if you enabled one or both of those features. Einstein’s field
value recommendations are based on data from recently closed cases. The component has two types: Case Classification
and Case Wrap-Up.
To learn more about using this component with Einstein Case Classification, see Display Recommendations in the Service Console.
Available in API version 49.0 and later.

Einstein GPT Sales Emails

If Sales Emails and Gmail or Outlook integrations are enabled, the Einstein GPT Sales Emails component appears on the default email
application pane. The component can be added to custom email application pane layouts. To learn more about using Sales Emails in
Outlook and Gmail, see Understand How Einstein GPT Creates Sales Emails.

Einstein Next Best Action

The Einstein Next Best Action component displays suggested recommendations and actions on a record page. Use strategies to apply
your org’s business rules to display context-specific suggestions to users.
For more information, see Einstein Next Best Action Component.

525
Extend Salesforce with Clicks, Not Code Lightning Pages

Einstein Predictions
The Einstein Predictions component displays predictions and recommendations on a Lightning record page for a standard or custom
object. For more information, see Add Einstein Predictions to a Lightning Page.

Einstein Replies
The Einstein Replies component recommends stock replies that support agents can insert into chat and messaging sessions. It’s used
in Einstein Reply Recommendations, and is available only if that feature is enabled. The replies that Einstein recommends are based on
past closed chats. To learn more, see Einstein Reply Recommendations.
If Einstein Reply Recommendations is enabled, this component appears automatically on the Chat and Messaging console tabs for any
users with the View and Act on Einstein Reply Recommendations user permission.
Available in API version 49.0 and later.

Forecasts Header
The Forecasts Header component contains key page-level actions and selections for a forecasts page, such as selecting the forecast type
to show and the forecast period. We recommend that each forecasts page include a Forecasts Header component so that viewers can
select their preferences and a forecast type. Those selections allow other forecasts components on the page to work correctly. Selections
made in this component on a forecasts page determine what data shows in other forecast-related components on the page.
This component is supported for Forecasts pages.

Forecasts Opportunity List

The Forecasts Opportunity List works in conjunction with the Forecasts Header and Forecasts Summary components and shows the
opportunities that contribute to a selected forecast line in the summary.
This component is supported for Forecasts pages.

Forecasts Summary
The Forecasts Summary is the main part of any forecast page, and shows the actual forecast numbers based on the selections made in
the Forecasts Header on the page. The summary is where sales leaders can view forecasting data, make forecast adjustments, and update
quotas. Pieces contained in the summary are configurable in Forecasts Settings in Setup.
This component is supported for Forecasts pages and works best in a wide region of the page.
If Einstein Forecasting is enabled, the summary also includes AI-powered intelligence to improve forecasting accuracy and predictions.

Highlights Panel
The Highlights Panel component displays key record fields along with page-level actions. The fields that appear in the highlights panel
come from the compact layout assigned to the object. The actions in the highlights panel come from the Salesforce Mobile and Lightning
Experience Actions section of the page layout. Record highlights show up to the first 7 fields on desktop and up to the first 10 fields in
the Salesforce mobile app.
To streamline your highlights panel by not showing the second row of information and reducing the size of the first row, select the
Show as collapsed (desktop only) checkbox. To show fewer action buttons, reduce the number using the Number of Visible Action
Buttons (desktop only) attribute.

526
Extend Salesforce with Clicks, Not Code Lightning Pages

To display the highlights horizontally or vertically (desktop only), drag the Highlights Panel component into a region with the horizontal
or vertical dimensions you want. The highlights panel adjusts to fit the region’s space. For example, if you drag it into a narrow column,
the highlights display vertically. If you drag it to a full-page width column, the highlights display horizontally.

Event Insights
The Event Insights component shows Salesforce IoT data about your customers’ connected devices on Lightning record pages alongside
your CRM data.
Salesforce IoT must be enabled, and you need an active orchestration to set up the Event Insights component. You can put up to five
IoT orchestration variables in your Event Insights component. In the Lightning App Builder, you specify the parent record, the orchestration
to pull the variables from, and the variables to show. You set the component visibility by filtering on record type.
Each device (instance) can have up to 1 MB of data. Event message and device allocations follow your normal Salesforce IoT allocations.
This component is supported in API version 44.0 and later.

List View
The List View component points to a list view and displays the first few records from that view. It supports all public and shared list views
that are associated with standard and custom objects, except:
• Activity
• ContentVersion (Files)
• Recently Viewed
• User
• UserProfile
In addition to the Recently Viewed list view, some standard objects include another list view with a similar name that shows the same
records. The name of this view includes the name of the object, for example, Recently Viewed Accounts. The List View component
supports these list views.
Considerations
• By default, a List View component displays the first three records in the list, but you can set it to show a maximum of 30.
• You can’t give a List View component a custom name. The component’s name is derived from the name of the list view filter you
select when you configure the component.
• In the Lightning App Builder, the Object dropdown list for this component displays only those objects that have list views associated
with them.
• Adding too many List View components can cause page performance issues. Use them sparingly.

Order Product Summaries by Recipient

Use the Order Product Summaries by Recipient component to display order product details on an Order Summary record page. This
component is available in Salesforce Order Management.
The Order Product Summaries by Recipient component displays information about the order delivery group summaries associated with
the order summary, including the order product summaries associated with them.
The displayed order product summary fields are defined by the Order Product Summaries related list on the OrderDeliveryGroup object
page layout. To modify the columns in this component on the order summary details page, edit the related list on the Order Delivery
Group page layout, not the Order Summary page layout.
You can create a custom filter to control which order delivery group summary records are displayed.

527
Extend Salesforce with Clicks, Not Code Lightning Pages

Order Summary Totals

Use the Order Summary Totals component to display order financial totals on an Order Summary record page. This component is available
in Salesforce Order Management.
You can customize the panel title and which values to display.

Phone
Use this component to give agents easy access to the Service Cloud Voice softphone call controls so they can mute, hold, and end call.
This component is displayed when an agent accepts a call and is hidden when the call ends. The Phone component is available for the
Account, Case, Contact, and Voice Call objects, and for custom objects. To view and use this component, users need the Contact Center
Agent permission set.

Quip Document
Use the Quip Document component to embed Quip documents directly in records. Set up any Quip document as a template so that
your users can quickly create documents on Salesforce records.
When you set up the Quip Document component in Lightning App Builder, you can choose different modes.
• Allow different documents on each record. Let users attach different documents to different records, or create and embed new
documents from scratch. Admins can programmatically attach preselected documents to different records.
• Use the same document for every record. Choose an existing document to embed in each record associated with a given object.
• Use a template to create new documents for each record. Specify a template where users can create and embed documents on a
per-record basis. You can use any Quip document as a template. You can set up the template to add record data to documents.
• Use different templates for different records. Specify different templates for different records on the same object. This option requires
you to programmatically pre-populate the component field with the URLs of different templates rather than manually choosing a
single template URL.

Rebate Types Panel

The Rebate Types Panel component allows you to select and apply eligible rebate types and incentives to a mapped object. This
component is supported in API version 52.0 and later.

Note: To view and use this component, users need the Rebate Management license.

Rebate Types Tab

The Rebate Types component is used in combination with the Rebate Types Panel component to view and modify the benefit tiers
associated with the applied rebate types and incentives. This component is supported in API version 52.0 and later.

Note: To view and use this component, users need the Rebate Management license.

Recent Items
The Recent Items component displays a list of the most recently used items. The default is three, but you can set it to show a maximum
of 30. In the Lightning App Builder, you can specify which objects’ records appear in the recent items list.
The Recent Items component supports these objects, based on the specified properties:
• All custom objects.
• All standard objects for which both of these conditions are true:

528
Extend Salesforce with Clicks, Not Code Lightning Pages

– A compact layout is defined for the object.

– The object is tracked in the most recently used objects list.

Note: The object isn’t supported for this component when it meets both of these criteria but isn’t in the list of available objects
when you configure the component. Although they appear in the available objects list, the Task, Report, KnowledgeArticle,
and Article objects aren’t supported for this component.
If an object is tracked in the most recently used objects list, one or both of the LastViewedDate or LastReferencedDate
fields are present.

Record Detail
The Record Detail component displays fields and sections from the page layout associated with the object. When users view the Lightning
record page, they see different fields and sections based on their profile and page layout assignments.
You can’t add, remove, or move the fields and sections when you’re viewing the component in the Lightning App Builder. You can only
make field and section changes on the page layout.

Related List – Single

Use the Related List – Single component to include a single related list for a record in your Lightning page. You can show a related list
for the record associated with your page, or you can show information for the parent record. Make sure that the page layout for your
users includes the related list that you want to use. If using a parent record, update the parent record’s page layout. Using a parent record
is optional.
To customize how the list appears, update the list type. The Basic List type displays only the first four fields of a related list. With the
Enhanced List type, you can show up to 10 fields and show or hide actions, and users can resize and sort columns, perform mass actions,
and wrap text. The action bar always appear on enhanced related lists that are in a narrow sidebar region on the record page.
This component is supported in API version 39.0 and later. You can use it in record pages only.

Related List Quick Links

The Related List Quick Links component displays a set of links. Users can hover over the links to see all the related list columns without
opening the View All page. Header actions, mass actions, row actions, and text wrapping are all available on the hover pane.
The component displays two rows of related list links in large or medium page regions, and six rows in small regions. Users can view the
remaining related list links by clicking Show All, which expands the component. When a user hovers over a related list quick link, it
displays the first 10 items in the related list.
The content of this component is based on the set of related lists on the object's page layout plus the user’s preferences. Users can
customize the order of the quick links. They can also exclude the ones they don't want in their personal settings. To exclude, in the Quick
Find box, enter Customize My Pages, then select Customize My Pages, and then click the object.
The Open Activities and Activity History related lists aren't supported for this component. You can use this component in record pages
only.

Related Lists
Use the Related Lists component to include all related lists for a record in your Lightning page. Make sure that the page layout for your
users includes the related lists that you want to use.
To customize how the lists appear, update the list type. The Basic List type displays only the first four fields of a related list. With the
Enhanced List type, you can show up to 10 fields and show or hide actions, and users can resize and sort columns, perform mass actions,
and wrap text. The action bar always appears on enhanced related lists that are in a narrow sidebar region on the record page.

529
Extend Salesforce with Clicks, Not Code Lightning Pages

You can use this component in record pages only.

Related Record
Use the Related Record component to display the details of a related record, including the details of a parent record, in your Lightning
page. This component provides your users with built-in record creation, inline edit, and the ability to unlink a record and link a new one.
This functionality is possible because the component uses actions.
This component is supported in API version 39.0 and later. You can use it only in record pages.
Keep these considerations in mind when using the Related Record component.
• To use the component, an object must have an associated quick action to update the records. Some lookup fields have default
actions. If no actions are available for your lookup, follow the links in the Lightning App Builder property editor to create the actions.
• To change the displayed fields for the Related Record component, configure different lookup fields, and customize the associated
action in Setup. If you don’t see the action or can’t modify it, create one. Also, ensure that the lookup field to the related object is
included on the page layout of the main object. Otherwise the component can’t be refreshed.
• To let users look up two levels of record relationships, specify the first-level lookup and then the second-level lookup. You must
specify a first-level lookup before you can add a second-level lookup.
• To let users look up polymorphic fields, select a polymorphic lookup field type on the first-level lookup or on the second-level lookup.
• To use the Parent Case, Asset, and Case Source lookup fields on cases, change the field-level security to visible instead of hidden.
Otherwise, your users see an error.
• Users without Read access to the value of a lookup field see an error.
• Person account records that display in contact Related Record components are read-only.
• Cases are linked to default accounts that can’t be removed (unlinked) from the component unless the contact is also removed at
the same time.
• The Related Record component typically uses quick action metadata to determine which fields to show. However, if the user viewing
the component has read-only access to the related record, a compact layout is used to render the fields instead. As a result, a read-only
user sees a smaller set of fields.

Report Chart
Use the Report Chart component to include a chart from a report in your Lightning page. If you leave the component’s Label field blank,
the component’s label is derived from the report’s label.
The chart refreshes if its report data is more than one day old. In the component properties, you can choose to display a refresh button
to enable users to refresh the chart. Saving the report’s definitions also updates the chart data in the component.
Setting a filter on the report chart data is supported only for record pages. If you set a filter option, the Report Chart component displays
only that filtered data to users.
This component is supported in API version 32.0 and later. It doesn’t work with reports in the My Personal Custom Reports folder. Report
Chart components that refer to reports in the Unfiled Public Reports folder aren’t deployable when you include them in a package.

Rich Text
Use the Rich Text component to add text and simple HTML markup to your Lightning page.

Note: JavaScript, CSS, iframes, and other advanced markup aren’t supported. To use advanced HTML elements in a component,
we recommend using a Visualforce page component or a custom Lightning component.
The Rich Text component uses Quill as its text editor. Keep these considerations in mind when using the text editor.

530
Extend Salesforce with Clicks, Not Code Lightning Pages

• Quill wraps each line of text with <p> </p> tags. The tags can increase the number of characters in the rich text API value when
you save the text. If you get a max length warning, break up the text into two Rich Text components.
• In Quill, the default color for text is gray in the editor, but the text renders black in the output.
• Selecting text using keyboard shortcuts, such as with Cmd+A, and then typing something new resets the formatting of the existing
text.
You can include up to 4,000 characters in the Rich Text component. This component is supported in API version 32.0 and later.

Salesforce Surveys
The Salesforce Surveys component adds an active survey to your Lightning page, so you can collect data from your users while they
work on Salesforce records. This component is supported in API version 42.0 and later.

Note: To create surveys and add them to Lightning pages, you must enable Salesforce Surveys in your org.

Send Email Later – Pending List

The Send Email Later – Pending List component shows the list of scheduled emails. From this list, your users can see pending emails,
cancel an email, edit its scheduled time, or edit its content.

CRM Analytics Dashboard

The CRM Analytics Dashboard component surfaces an entire dashboard right where people work. The dashboard is fully functional and
interactive. Users can refresh them, apply filters, and click chart segments to drill into filtered reports.
Dashboards need space to display charts and tables. If an embedded dashboard is squished into too small a space, then a collapsed
version displays instead of the full dashboard. Users can click View Dashboard to open a collapsed dashboard.
Available in API version 41.0 and later. The Dashboard component isn’t available on record pages. Private dashboards aren’t available.

CRM Analytics Collection

The CRM Analytics Collection component enables you to insert and display collections of curated dashboards and lenses to your Lightning
pages. The component intuitively displays collections in a concise panel so users can view relevant insights in the place where they
work.
Available in API version 54.0 and later. Users must have access to the selected collection used within the component.

Tabs
Use the Tabs component to add tabs to a region of your Lightning page. Choose from a set of standard tabs or create custom tabs to
enhance record and Home pages for your Lightning Experience users. The Tabs component is supported only for Lightning Experience
record and Home pages.
You can place up to 100 tabs in a Tabs component. This component is supported in API version 36.0 and later.

Twitter
Social Accounts and Contacts must be enabled for your organization before you can add the Twitter component to a Lightning page.

Visualforce Page
Use the Visualforce Page component to include a Visualforce page in your Lightning page.

531
Extend Salesforce with Clicks, Not Code Lightning Pages

If you leave the component’s Label field blank, the label is taken from the Visualforce page that you assign to it.
If you leave the Height field blank, the Visualforce page’s height defaults to 300 pixels when it displays in the Salesforce mobile app.
This component is supported in API version 32.0 and later.
To appear in the Salesforce mobile app or Lightning Experience, the Visualforce page must have the Available for Salesforce mobile apps
and Lightning pages option selected. This option is available for pages that are set to API version 27.0 and later.

Voice Status
Use the Voice Status component to include tests in your Lightning page that help service agents check whether their workspaces are
ready for Service Cloud Voice. When agents click Run Test from the Voice Status component, their browser and microphone statuses
are verified. Additionally, agents using Service Cloud Voice with Amazon Connect run the Amazon Connect Endpoint Test Utility to verify
their connection. If verification fails, messages instruct agents how to debug their Voice setup to connect successfully. This component
is supported in API version 57.0 and later.

Wave Dashboard
Use the Wave Dashboard component to include CRM Analytics dashboards in your Lightning page. Contact Salesforce to enable the
Wave Dashboard component for the Lightning App Builder.
Select the dashboard to display from the dropdown list. If you leave the Height field blank, the dashboard’s height defaults to 300 pixels
when it displays in your Lightning page.
You can control the visibility of the dashboard’s title and specify whether the dashboard appears when an error occurs. With the Open
Links in New Windows attribute, you can specify where links from the dashboard to other assets are opened. With the Filter attribute,
you can use JSON to filter dataset fields at run time.
For more information, see Embed CRM Analytics Dashboards in Lightning Pages.

SEE ALSO:
Custom Lightning Page Components

532
Extend Salesforce with Clicks, Not Code Lightning Pages

Custom Lightning Page Components

The Lightning App Builder supports custom Lightning components.
EDITIONS
Custom components in your org that are configured for use in the Lightning App Builder appear
in the Lightning Components pane. Lightning App Builder
available in: both Salesforce
Classic and Lightning
Experience

Lightning Home and utility

bar pages available in:
Lightning Experience

Lightning app and record

pages available in: both the
Salesforce mobile app and
Lightning Experience

Email application pane

pages available in: both
Salesforce Classic and
Lightning Experience

Available in: Group,

Essentials, Professional,
Enterprise, Performance,
Unlimited, and Developer
Editions

If you have a page to be used in the Salesforce mobile app, use only Lightning components that the mobile app supports.
Your custom Lightning components don’t automatically work on Lightning pages or in the Lightning App Builder. To make a custom
component usable in both, configure the component and its component bundle so that they’re compatible with the Lightning App
Builder and Lightning pages.
For Aura components, see the Lightning Aura Components Developer Guide. For Lightning web components, see the Lightning Web
Components Developer Guide.

Note: Custom components that serve as containers, such as custom Tabs or Accordion components, aren’t supported in Lightning
App Builder. They display on the canvas, but you can’t interact with them or put any components inside them.
You can configure custom components to support different devices. For instance, you have a record page whose template supports
both phone and desktop, and you activate the page for both. Then you add a phone-only component to the page. When the page is
viewed on a phone, users see the component. When the page is viewed on a desktop, the phone-only component doesn’t appear.

533
Extend Salesforce with Clicks, Not Code Lightning Pages

Note: Pull to refresh doesn’t work for custom Lightning web components in the Salesforce mobile app.

SEE ALSO:
Standard Lightning Page Components
My Domain

Dynamic Lightning Pages

Control when a component appears on a Lightning page by adding filter conditions and logic to
EDITIONS
its properties in the Lightning App Builder. For example, you can construct a filter that causes a rich
text component on an opportunity page to display when the opportunity’s amount is greater than Lightning App Builder
or equal to $1 million. available in: Salesforce
Component visibility properties appear when you select a component on a record, app, or Home Classic and Lightning
page in the Lightning App Builder. This behavior applies to standard components, custom Experience
components, and components from AppExchange. No need to do anything to your custom Lightning pages available in:
components. The Lightning App Builder handles all of it. Lightning Experience and the
On record pages, you can choose record fields or advanced fields, such as fields from related objects Salesforce mobile app
or from a global object like User. Field values in component visibility filters can’t span more than
five fields. For example, Available in: Group
Record.Account.Owner.Manager.Manager.Manager.LastName has six spans, Essentials, Professional,
and therefore isn’t supported. Enterprise, Performance,
Unlimited, and Developer
Editions

App and Home pages aren’t associated with an object, so the filters you can use are limited to other contexts, such as User, User Permission,
or Device. But that doesn’t mean that they’re less powerful.
If you don’t define a filter, the component displays on the Lightning page as usual. When you define one or more filters and set the filter
logic for a component, the component is hidden until the filter logic criteria are met.

In the Lightning App Builder, components that have at least one filter assigned are indicated with an icon ( ).

534
Extend Salesforce with Clicks, Not Code Lightning Pages

Visibility Rules on Dynamic Forms Fields and Field Sections

You can make your Lightning record pages even more dynamic by setting visibility filters on Field and Field Section components. For
example, you can have a field or set of fields hidden until a person with a certain profile, permission, or viewing on a certain device visits
the page.
Be careful when setting up visibility rules on multiple components in the same region. If your rules cause all the components in a region
to be invisible at run time, the region is empty.
If a field set to Required in the Lightning App Builder, it’s hidden by a visibility rule at run time, users can save the record even if that field
isn't populated.
Visibility rules on fields are respected in the edit, clone, inline edit, and new record screens. Component visibility rules on field sections
behave differently than they do on fields. Visibility rules on fields are assessed dynamically. Changes a user makes while editing a record
can make fields appear and disappear as visibility rules are evaluated. Visibility rules on field sections aren’t dynamic and don’t react to
what a user does while editing. Field section visibility rules are evaluated only after the record is saved.

Note: Field and Field Section components are supported on desktop only. Therefore, the visibility rules you set on them are
respected only in the desktop view, not on mobile.

Component Visibility Based on Form Factor

With a filter using the Device context, you can set a component to display exclusively when its page is viewed in a specific experience,
such as a phone or a desktop.

Custom Lightning components can also be set to support different form factors. For Lightning web components, see “Configure Your
Component for Different Form Factors.” For Aura components, see “Aura Component Bundle Design Resources.”

Supported Objects, Fields, Field Types, and Operators

Two objects aren’t supported for component visibility filters: ProcessInstanceStep and ProcessInstanceWorkItem.
On record pages, component visibility filters rely on the data captured in fields associated with the page’s object. Not all fields, field
types, and operators are supported.
These field types are supported:
• String type fields: Autonumber, Currency, Email, Number, Percent, Phone, Text, Text Area, URL
• ID
• Checkbox (boolean)
• Geolocation

535
Extend Salesforce with Clicks, Not Code Lightning Pages

• Picklist
• Formula fields that resolve to one of these preceding types
• Roll-up summary fields that resolve to one of these preceding types
These operators are supported:
• CONTAINS
• = and == (Equal)
• <> or != (Not Equal)
• > (Greater Than)
• >= (Greater Than or Equal)
• < (Less Than)
• <= (Less Than or Equal)

SEE ALSO:
Formula Operators and Functions by Context
Standard Lightning Page Components
Dynamic Forms and Mobile

Lightning Page Visibility Rule Considerations

Keep these considerations in mind when working with visibility rules on Lightning page components
EDITIONS
in the Lightning App Builder.
Lightning App Builder
General available in: Salesforce
Classic and Lightning
• If a visibility filter assigns a component to “Device equals desktop,” the component appears on Experience
a page when viewed in Lightning Experience on a desktop and when viewed in a browser on
an iPad. Lightning pages available in:
Lightning Experience and the
• The Salesforce mobile app on an iPad uses the phone form factor. Salesforce viewed in a browser
Salesforce mobile app
on an iPad uses the desktop form factor. These form factors affect components on record pages
differently. Available in: Group
– If the visibility filter is “Device not equal to desktop” or “Device equals phone,” the component Essentials, Professional,
appears on record pages in the Salesforce mobile app on a phone and an iPad. It doesn’t Enterprise, Performance,
appear on pages viewed in a browser on an iPad. Unlimited, and Developer
Editions
– If the visibility filter is “Device not equal to phone,” the component appears on record pages
in Lightning Experience on a desktop and on pages viewed in a browser on an iPad. It
doesn’t appear in the Salesforce mobile app on a phone or an iPad.

• Lookup fields that you want to use as a filter for a visibility rule must always have a value.
• If a user doesn’t have access to a field used as part of a component visibility filter’s criteria, the criteria evaluates to false.

Visibility Rules and Dynamic Forms

• Field and Field Section components are supported on desktop only. Therefore, visibility rules you set on them are respected only in
the desktop view, not on mobile.
• If a field is hidden on a page due to a visibility rule, and a user edits the value of the field, its new or changed value isn’t saved.

536
Extend Salesforce with Clicks, Not Code Lightning Pages

• Dependent picklist fields don’t respect visibility rules. Even if they have visibility rules assigned to them, dependent picklist fields still
appear in the View All Dependencies list.
• Component visibility rules on field sections behave differently than they do on fields. Visibility rules on fields are assessed dynamically.
Changes a user makes while editing a record can make fields appear and disappear as visibility rules are evaluated. Visibility rules on
field sections aren’t dynamic and don’t react to what a user does while editing. Field section visibility rules are evaluated only after
the record is saved.
• If you hide a field with a visibility rule, users don’t lose access to the field’s data. Values in hidden fields remain intact and are visible
outside of the Dynamic Forms-based page in places like reports, dashboards, and list views. Hidden fields are for user convenience,
not field-level security.

Build Localized Component Labels and Attribute Values on Lightning Pages with
Custom Labels
When you specify labels or attributes in the Lightning App Builder such as for components or custom
EDITIONS
tabs, you can use the {!$Label.customLabelName} expression to help define the label
or attribute’s value. Lightning App Builder
On a Lightning page, custom Tabs component labels and other component attribute values aren’t available in: both Salesforce
localized when they’re entered as plain text in the Lightning App Builder. For example, if you have Classic and Lightning
an org whose default language is English, and you have a Tabs component with three custom tabs Experience
that you entered as Cars, Trucks, and Planes, the non-English users in your org see those tab label Lightning Home pages
values as Cars, Trucks, and Planes when they view the page. The tab label values aren’t translated available in: Lightning
into your users’ languages. Experience
But configuring custom label values in the Lightning App Builder using the
Lightning app and record
{!$Label.customLabelName} expression lets users see labels in their chosen language pages available in: both the
if you created a translation for that label in their language. Salesforce mobile app and
The {!$Label.customLabelName} expression works with any custom labels that you Lightning Experience
create in Setup using the custom label feature. The text that you define in the Value field for your
custom label displays as the label value when the component renders on a Lightning page. And, Available in: Group
if you create a translated value for the label, users using that language in your org see the translated Essentials, Professional,
Enterprise, Performance,
value.
Unlimited, and Developer
Expressions are supported only in String type fields in component labels and attributes on app, Editions
Home, and record pages. You can’t use an expression in page-level properties.
1. Create a translated custom label in Setup.
USER PERMISSIONS
For more information, see Translate Custom Labels.
To create and save Lightning
2. Navigate to the Lightning App Builder. From Setup, in the Quick Find box, enter App
pages in the Lightning App
Builder, then select Lightning App Builder. Builder:
3. Open an app, record, or Home Lightning page. • Customize Application
4. Select the component whose label or property you want to replace with your translated custom To view Lightning pages in
label. the Lightning App Builder:
• View Setup and
5. Enter {!$Label.customLabelName} in the label or attribute field, replacing Configuration
“customLabelName” with the name of your custom label.
Label and property fields that support using this expression have an info bubble that says so.

6. Save your changes.

Users in your org whose language is set to the language of your translated label see the label or attribute in its translated value.

537
Extend Salesforce with Clicks, Not Code Lightning Pages

Example: Your org’s default language is English, but you want the custom Planes tab on your Lightning page to show a translated
custom label for your German users. Here’s how to do it.
1. Create a custom label in Setup with the name Planes_Label, and enter the Value as Planes. That’s what your English
users see.
2. From the Translations related list on the custom label detail page, create a translation for the label with the language set to
German and the Translation Text value as Flugzeuge.
3. Save the translation.
4. In the Lightning App Builder, open your page and click the Tabs component on the canvas.
5. In the properties pane, click the Planes tab, and in the Custom Label field, replace the Planes plain text with
{!$Label.Planes_Label}.

6. Click Done and save your page.

When viewing the page, your English users see the tab as Planes, and your German users see the tab as Flugzeuge.

Note: When a field in a component contains an expression, Salesforce can’t validate the value it resolves to. If the expression
resolves to a value that’s invalid for the field, sometimes the component doesn’t work as expected. We recommend that you test
the page in the translated languages before you make the page with the expression available to users.

538
Extend Salesforce with Clicks, Not Code Create an App Home Page with the Lightning App Builder

Create an App Home Page with the Lightning App Builder

Create a home page for an app that you can add directly into Lightning apps and the Salesforce
EDITIONS
mobile app. Your users can then easily access the objects and items that are most important in that
app. Lightning App Builder
1. From Setup, enter App Builder in the Quick Find box, then select Lightning App Builder. available in: both Salesforce
Classic and Lightning
2. Click New.
Experience
3. Select App Page and then click Next.
Lightning app pages
4. Give your app page a label, and then click Next. available in: both the
The label can be up to 80 characters. Salesforce mobile app and
Lightning Experience
5. Select a page template and click Done.
6. Drag the components that you want onto the page. Available in: Group,
Essentials, Professional,
Drag components up and down to rearrange them. You can also click a component’s top or
Enterprise, Performance,
bottom border to create an insertion point ( ) for the next component. Unlimited, and Developer
7. Click each component on the page to configure its properties. Editions

8. Click in the empty area of the canvas or on the Page link in the breadcrumb to configure the
page properties. USER PERMISSIONS
The Description field is limited to 255 characters. The API Name field is limited to 80 characters,
but if you have a namespaced org, we recommend using fewer than 65 characters. When you To create and save Lightning
pages in the Lightning App
create a Lightning page, the API name is derived from the first 40 characters of the label that
Builder:
you give the page.
• Customize Application
9. Optionally add global actions to your page. To view Lightning pages in
the Lightning App Builder:
a. In the page properties, click Select.
• View Setup and
b. Add, remove, or reorder the actions for your page. Configuration
Actions you select appear on the page’s action bar and in the highlights panel at the top
of the page in Lightning Experience. An app page is the only type of Lightning page that
you can add actions to in this way. Other Lightning pages derive their actions from the object and global page layouts.

c. Click OK.

10. Click Save when you’re done editing your page.

To give your users access to the app page, you must activate it.

SEE ALSO:
Activate Your Lightning App Page
Lightning App Builder

539
Extend Salesforce with Clicks, Not Code Create a Mobile App Page with the Lightning App Builder

Create a Mobile App Page with the Lightning App Builder

Create a mobile home page for the Salesforce mobile app. Your users can see this page right when
EDITIONS
they log in.

Note: These steps are similar to Create an App Home Page with the Lightning App Builder. Lightning App Builder
That’s because when you create an app page or record page, it can be made available on available in: both Salesforce
Classic and Lightning
both Lightning Experience and the Salesforce mobile app. The following steps focus on
Experience
creating an app page for the mobile app only.
1. From Setup, enter App Builder in the Quick Find box, then select Lightning App Builder. Lightning app pages
available in: both the
2. Click New. Salesforce mobile app and
3. Select App Page and then click Next. Lightning Experience
4. Give your app page a label, and then click Next.
Available in: Group,
The label can be up to 80 characters. Essentials Professional,
Enterprise, Performance,
5. Select the first template (Header and Left Sidebar) and click Done.
Unlimited, and Developer
If this is a mobile-only page, it doesn't matter which template you pick. If you plan to share this Editions
page between mobile and desktop users, choose the template most appropriate for desktop
use. On mobile devices, the page responsively collapses into a single column.
USER PERMISSIONS
6. Make sure you’re viewing the template preview using the Phone form factor. The regions on
the template are displayed in a one column layout. To create and save Lightning
pages in the Lightning App
Builder:
• Customize Application
To view Lightning pages in
the Lightning App Builder:
• View Setup and
Configuration

540
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

7. Drag the components that you want onto the page.

Drag components up and down to rearrange them. You can also click a component’s top or bottom border to create an insertion
point ( ) for the next component.
To increase mobile adoption, we recommend making available the top features that your users use most frequently. For example,
the Recent Items can take them back into the records that they were working with. Also, the List View standard components can
be set to their open tasks to improve productivity in the mobile app.
Remember that screen space and bandwidth are precious on mobile, so try to limit each page to 4 or 5 components at most. If you
overload the page with features, it can be slow and harder to use.
See Preview Mobile App Pages in Lightning App Builder on page 541.

8. Click each component on the page to configure its properties.

9. Click in the empty area of the canvas or on the Page link in the breadcrumb to configure the page properties.
The Description field is limited to 255 characters. The API Name field is limited to 80 characters, but if you have a namespaced org,
we recommend using fewer than 65 characters. When you create a Lightning page, the API name is derived from the first 40 characters
of the label that you give the page.

10. Optionally add global actions to your page.

Global actions help your users perform tasks easily from the app page, like log a call, create a new case or event etc.
a. In the page properties, click Select.
b. Add, remove, or reorder the actions for your page.
Actions you select appear on the page’s action bar and in the highlights panel at the top of the page in Lightning Experience.
An app page is the only type of Lightning page that you can add actions to in this way. Other Lightning pages derive their actions
from the object and global page layouts.

c. Click OK.

11. Click Save when you’re done editing your page.

To give your users access to the mobile app page, you must activate it. You can limit the page to mobile users during the page activation
process. After activation, you can add this to any Lightning App in the App Manager for your users to personalize. If your Lightning App
is available on both desktop and mobile, you can use the same page across both. Or create a Lightning App specifically for your mobile
users, and add it to the navigation there.

Preview Mobile App Pages in Lightning App Builder

For a consistent experience across devices, use the Lightning App builder to preview your record
EDITIONS
and app pages.
The Salesforce mobile web experience is no longer available after Summer ’20. To customize and Available in: Lightning
preview your apps and pages for Lightning Experience or the mobile app, use the App Builder. You Experience
can also specify certain components as mobile- or desktop-only.
Available in: Group
If you need more than a preview, run the Lightning apps and components in the Salesforce mobile
Essentials, Professional,
app. Testing in the mobile app helps validate that users have the best experience on mobile. Enterprise, Performance,
When you build a mobile app page, the steps include: Unlimited, and Developer
Editions
• Build a new app page with the App Builder on page 540
• Activate the page and add the page to your mobile navigation
• Create a Lightning app in the App Manager for your users to personalize

541
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

Watch a Demo (9 minutes)

The following sections discuss best practices on building a mobile app page using the App Builder.

Display Mobile-Friendly Components

When you create a Lightning app page or record page via the App Builder, the template you choose controls how it displays across
devices.

Here are several ideas on including standard components on page 522 for mobile users. The list can vary depending on your user’s role.
• The Report Chart component displays helpful data, such as your top deals, based on a filter.
• The List View component can display your events, such as today’s agenda.
• The Task List component can display your open tasks, overdue tasks, or another list based on a filter.
• The Recent Items component lets you get back to the records you are working with recently.
• The Launchpad component lets you add a grid of navigation items, such as your contacts or a custom Visualforce page, which users
can access with one tap.
If standard components don’t meet your requirements, create custom components on page 533.

Customize Actions for the Mobile Page

If you’re creating an app page, you can also customize the actions available for the page. On the Page link, click Select under the Actions
label.

542
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

Here are several popular actions for mobile users that make them more productive. Again, the list can vary depending on your user’s
role.
• Log a call
• New case
• New event
• New task
For more information, see Salesforce Mobile App Action Bar.

Activate the Page for Mobile Users

When you activate the page, you have the option to add the page to both Lightning Experience and mobile app. You can add the page
to any mobile-enabled Lightning app. Adding your app page to Lightning Experience makes it available to users viewing the app on
desktop and in the Salesforce mobile app.

Enable Users to Personalize Tabs for the Mobile App

If you haven't already, enable your Lightning apps for mobile in the App Manager so your users can access the same navigation on all
devices. Or create a Lightning app if you want separate navigation items on mobile.
To customize your mobile experience, personalize the app on desktop with your favorite tabs, and then use them on the mobile app.
This guideline is optional but highly recommended to optimize your users’ mobile experience. For this use case, choose the Desktop
and phone form factors.

543
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

Add navigation items, including the app page you created and several basic tabs like Chatter and Groups. Keep the app lightweight
since users can personalize their own tabs using this app.

Add the profiles who need mobile access to this app. For example, the mobile app is ideal for your sales and marketing users who need
access to the mobile app on the go. Both profiles can then use the mobile app to personalize the tabs they need for their role.
If you have multiple Lightning apps available to different users profiles, the profiles also get access to the mobile app.

Personalize Tabs for the Mobile App

In Lightning Experience on desktop, users access the Lightning app you created. Go to a list view and open it in a new tab. This adds
the list view to the mobile navigation and enable users to be productive in the mobile app.

544
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

After adding tabs, users can edit the mobile navigation items, edit item names, and reorder the items.

545
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

When users log in to the mobile app, the App Launcher lets them switch to the customized Lightning app. For more information, see
Customize the Salesforce Mobile App.

The actions you added are displayed on the home page screen with the components you added to the template in the App Builder.

546
Extend Salesforce with Clicks, Not Code Preview Mobile App Pages in Lightning App Builder

547
Extend Salesforce with Clicks, Not Code Activate Lightning Experience Home Pages

Activate Lightning Experience Home Pages

Is your custom home page ready for your users? Use the Activation function inside the Lightning
EDITIONS
App Builder to get the page out to them. You have three activation options. You can make your
custom home page the default home page for all users, assign it to specific Lightning apps, or assign Lightning App Builder
it to app-and-profile combinations. Assigning the page to a Lightning app or app-and-profile available in: both Salesforce
combination gives your users access to a home page customized for the context they’re working Classic and Lightning
in. Experience
1. Create a home page or open an existing one in the Lightning App Builder. Lightning Home and utility
2. If you opened a home page that is ready for your users and doesn’t need editing, click Activation. bar pages available in:
Lightning Experience
3. If you created a page or opened a page that needs adjustment, make the necessary changes,
click Save, and then click Activate. Lightning app and record
You have a few options for activating a home page. pages available in: both the
Salesforce mobile app and
• Make the page the org default.
Lightning Experience
• Make the page the default home page for specific Lightning apps.
Email application pane
• Assign the page to a combination of Lightning apps and profiles.
pages available in: both
4. On the activation screen, click the tab for the option you’ve chosen, and follow the steps to Salesforce Classic and
activate the page. Lightning Experience

Tip: You can also assign home pages from Setup. Enter Home in the Quick Find box, Available in: Group,
and then select Home. Essentials, Professional,
Enterprise, Performance,
• Classic apps can be viewed in Lightning Experience, but you can’t display different
Unlimited, and Developer
home pages assigned for specific apps and profiles. Upgrade Classic apps to Lightning
Editions
apps from the App Manager to make home page assignments.
• If you no longer want a page to be an app or org default, redo the activation process
for the page, and select the option to remove it as the default. USER PERMISSIONS
• If you activate a page and then return to make changes, you don’t have to activate
To create and save Lightning
it again. Clicking Save after you make your edits pushes the changes to your users.
pages in the Lightning App
Builder:
• Customize Application
To view Lightning pages in
the Lightning App Builder:
• View Setup and
Configuration

548
Extend Salesforce with Clicks, Not Code Activate Your Lightning App Page

Activate Your Lightning App Page

To make your custom app page available to users, you must activate it. You can also rename the
EDITIONS
Lightning page tab, adjust its visibility, and set its position in the navigation list. The Lightning App
Builder’s activation feature makes this process easy. Lightning App Builder
1. To open your app page, from Setup, enter Lightning App Builder in the Quick Find available in: both Salesforce
box, select Lightning App Builder, and then click Edit next to the page. Classic and Lightning
Experience
2. In the Lightning App Builder, click Activation.
3. Update the activation properties, if desired. Lightning Home and utility
bar pages available in:
You can: Lightning Experience
• Change the page’s custom tab label. By default, the label that you give the Lightning page
Lightning app and record
is used as the label for its custom tab.
pages available in: both the
• Change the custom tab’s icon. The icon that you choose here is used as the icon for the Salesforce mobile app and
page in the mobile app and in Lightning Experience. Lightning Experience
• Adjust the app page custom tab’s visibility. Email application pane
Note: If you select System Administrators only, the tab is set to Default On pages available in: both
for System Administrators. For all other users, it’s set to Default Off and doesn’t Salesforce Classic and
Lightning Experience
show up in the navigation of the apps it has been assigned to, but users can see the
tab in the App Launcher in Lightning Experience and on the All Tabs page in Salesforce
Available in: Group,
Classic.
Essentials, Professional,
If you select Active for all users, the tab is set to Default On for all users. It Enterprise, Performance,
appears in the visible tabs for its associated app, in the App Launcher in Lightning Unlimited, and Developer
Experience, and on the All Tabs page in Salesforce Classic. Editions

4. Add the page to one or more Lightning apps. USER PERMISSIONS

Adding your app page to Lightning Experience makes it available to users viewing the app on
desktop and in the Salesforce mobile app. To create and save Lightning
pages in the Lightning App
5. Set the page’s position in the Salesforce “Mobile Only” app navigation. Builder:
The first item that you put in the mobile navigation list becomes your users’ landing page. • Customize Application
To view Lightning pages in
6. Click Activate. the Lightning App Builder:
Your Lightning page is now ready for your mobile and Lightning Experience users! • View Setup and
Configuration
To enable your users to personalize the app with their favorite tabs, create a new Lightning App in
the App Manager. They can then use the tabs in the Salesforce mobile app.

Tip: You can give your app page a custom icon image by editing the style of the page’s custom tab in Setup.

SEE ALSO:
Create Lightning Page Tabs
Tab Settings

549
Extend Salesforce with Clicks, Not Code Create and Configure Lightning Experience Record Pages

Create and Configure Lightning Experience Record Pages

Use the Lightning App Builder to add, remove, or reorder components on a record page to give
EDITIONS
users a customized view for each object’s records.
1. Create a record page for Lightning Experience in one of these ways. Lightning App Builder
available in: both Salesforce
a. From the Setup menu on a record page, select Edit Page.
Classic and Lightning
Experience

Lightning Home and utility

bar pages available in:
Lightning Experience

Lightning app and record

pages available in: both the
Salesforce mobile app and
Lightning Experience

Email application pane

pages available in: both
Salesforce Classic and
Lightning Experience

Available in: Group,

Essentials, Professional,
When you select Edit Page for the first time, Salesforce makes a copy of the standard page.
Enterprise, Performance,
This copy is what you edit in the Lightning App Builder. If a customized page exists and is
Unlimited, and Developer
active, selecting Edit Page opens that page to edit.
Editions
b. Create a page from the Lightning App Builder list page in Setup. Enter App Builder
in the Quick Find box, then select Lightning App Builder, click New, and step through
USER PERMISSIONS
the page creation wizard.
To create an empty page, select a page template. To create a page prepopulated with To create and save Lightning
standard components, clone the system default page. pages in the Lightning App
Builder:
c. Clone an existing custom Lightning page from its detail page or from the Lightning page • Customize Application
list in Setup.
To view Lightning pages in
d. Click New Page from the Pages list inside the Lightning App Builder. the Lightning App Builder:
• View Setup and
2. In the Lightning App Builder, add, edit, or remove components to change the page’s layout. Configuration
Reorder components by dragging them around the canvas.
3. In the page properties, give your customized page a unique, descriptive label.
To get to the page properties, click Page from the breadcrumb at the top of the properties pane.

4. Save your page.

550
Extend Salesforce with Clicks, Not Code Add and Customize Tabs on Lightning Pages Using the
Lightning App Builder

Hang on, you’re not done yet! To make your customized record page available to your Lightning Experience and mobile users, you
must activate it. You can activate the page from the Save dialog when you save it for the first time or later using the Activation
button.

SEE ALSO:
Add and Customize Tabs on Lightning Pages Using the Lightning App Builder
Lightning App Builder Considerations
Lightning App Builder Limits and Limitations

Add and Customize Tabs on Lightning Pages Using the Lightning App
Builder
With the Lightning App Builder, you can create, update, delete, and change the order of tabs and
EDITIONS
tab sets on record, app, and Home pages in Lightning Experience. Configure the tabs that your
users see, name them whatever you like, and add components to each tab. Lightning App Builder
1. Open a Home, app, or record page for Lightning Experience in one of these ways. available in: both Salesforce
Classic and Lightning
a. From the Setup menu, select Edit Page.
Experience

Lightning Home and utility

bar pages available in:
Lightning Experience

Lightning app and record

pages available in: both the
Salesforce mobile app and
Lightning Experience

Email application pane

pages available in: both
Salesforce Classic and
Lightning Experience

Available in: Group,

Essentials, Professional,
Enterprise, Performance,
When you select Edit Page for the first time, Salesforce makes a copy of the standard page.
Unlimited, and Developer
This copy is what you edit in the Lightning App Builder. If a customized page exists and is
Editions
active, selecting Edit Page opens that page to edit.

b. Open a page from the Lightning App Builder list page. From Setup, in the Quick Find box,
USER PERMISSIONS
enter App Builder, and then select Lightning App Builder.
To create and save Lightning
2. Add a Tabs component to the page.
pages in the Lightning App
A default set of tabs is added. Builder:
3. To add a tab, click Add Tab in the Tabs component properties. • Customize Application
4. Customize a tab by clicking it in the properties pane. You can select a different standard label, To view Lightning pages in
or click Custom and enter the tab name you want. the Lightning App Builder:
• View Setup and
Configuration

551
Extend Salesforce with Clicks, Not Code Add and Customize Tabs on Lightning Pages Using the
Lightning App Builder

Note: Custom tab labels in the Tabs component—including those custom tab labels installed from packages—aren’t
translated. For example, if you create a custom Goals tab in English, then view the page as a user whose language is set to
French, the tab still displays as Goals. However, you can use the {!$Label.customLabelName} expression in a
component label or attribute to represent a custom label that you create in Setup using the custom label feature. For more
information, see Build Localized Component Labels and Attribute Values on Lightning Pages with Custom Labels on page 537.

5. To add your first component to a tab, select the tab on the canvas, and then drop the component directly below it.

6. Reorder tabs in the Tabs properties pane by dragging them into position. You can’t drag and drop individual tabs on the canvas.

SEE ALSO:
Create and Configure Lightning Experience Record Pages
Lightning App Builder Considerations
Personalize the Navigation Bar in Lightning Experience

552
Extend Salesforce with Clicks, Not Code Activate Lightning Experience Record Pages

Activate Lightning Experience Record Pages

Is your custom record page ready for your users? Use the Activation function inside the Lightning
EDITIONS
App Builder to get the page out to them. You can make your custom record page the default record
page for all users, assign it to specific Lightning apps, or assign it to record types and profiles. Lightning App Builder
Assigning the page to a Lightning app, record type, or profile gives your users access to a record available in: both Salesforce
page customized for the context they’re working in. Classic and Lightning
1. Create a record page or open an existing one in the Lightning App Builder. Experience

2. If you opened a record page that is ready for your users and doesn’t need editing, click Lightning Home and utility
Activation. bar pages available in:
Lightning Experience
3. If you created a page or opened a page that needs adjustment, make the necessary changes,
click Save, and then click Activate. Lightning app and record
You have a few options for activating a record page. pages available in: both the
Salesforce mobile app and
• Make the page the org default for the object.
Lightning Experience
After you activate the Lightning page as the org default, the page is selected as the Lightning
Experience override for the View action in the Override Properties panel. Email application pane
pages available in: both
• Make the page the default object record page for specific Lightning apps. Salesforce Classic and
If you activate the Lightning record page for specific Lightning apps only, the page takes Lightning Experience
precedence over the Lightning Experience Override setting for the View action on the object
Available in: Group,
in those apps.
Essentials, Professional,
• Assign the page to a combination of Lightning apps, record types, and profiles. Enterprise, Performance,
Unlimited, and Developer
• Assign the page to a form factor, such as a desktop or phone.
Editions
4. On the activation screen, click the tab for the option you’ve chosen, and follow the steps to
activate the page.
USER PERMISSIONS

SEE ALSO: To create and save Lightning

pages in the Lightning App
Create and Configure Lightning Experience Record Pages
Builder:
Lightning App Builder Considerations • Customize Application
To view Lightning pages in
the Lightning App Builder:
• View Setup and
Configuration

553
Extend Salesforce with Clicks, Not Code Create Dynamic Actions in Lightning App Builder

Create Dynamic Actions in Lightning App Builder

With dynamic actions, you can add flexibility and control to actions on your record pages. Assign
EDITIONS
dynamic actions in the Lightning App Builder instead of in the page layout editor, and then apply
filters to control when and where actions are visible to users. Available in: Lightning
You can create dynamic actions for custom objects on mobile and desktop and for standard objects Experience
on desktop.
Available in: Group,
Note: The Groups object doesn’t respect dynamic actions assigned in the Lightning App Essentials, Professional,
Builder. You can add or update actions on groups from the Groups Layout page in Setup. Enterprise, Performance,
Unlimited, and Developer
1. From Setup, in the Quick Find box, enter App Builder, and then select Lightning App editions
Builder.
2. Edit an existing record page, or click New to create one.
USER PERMISSIONS
3. Add or select the Highlights Panel component on the object’s record page.
To create actions:
4. In the Highlights Panel properties pane, click Upgrade Now to enable Dynamic Actions, and
• Customize Application
either step through the migration assistant to migrate existing actions or start with new actions.
When you enable Dynamic Actions, it applies only to the record page that you’re currently
working on in Lightning App Builder. Users then see the dynamic actions configured for that page in Lightning App Builder. Users
don’t see actions configured in the object’s page layout.

5. If you’re creating dynamic actions for a custom object’s record page on mobile, go to the page Properties pane, and select Enable
page-level dynamic actions for the Salesforce mobile app.
By default, if you configure Dynamic Actions for a custom object’s record page, you get the same actions for mobile. If your desktop
page has multiple Highlights Panel components and you add one or more dynamic actions to each of them, the dynamic actions
are consolidated into one action bar for that record page on mobile.
If you want to use a different set of actions for mobile, or if you’re adding dynamic actions to a mobile-only Lightning page, select
this option.

6. In the Properties pane, click Add Action, and then choose an action from the Actions window.

Note: If you migrated actions from a page layout, you can modify them in the Actions window.

7. To add visibility rules based on the record field, device type, or other filters, click Add Filter.
An eye icon next to an action’s name indicates that visibility rules are applied.

8. To save your changes, click Done.

554
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Break Up Your Record Details with Dynamic Forms

The more fields that there are on your page layout, the more that the Record Detail component
EDITIONS
becomes a monolithic block of fields that you can’t customize. With Dynamic Forms, you can migrate
the fields and sections from your page layout as individual components into the Lightning App Available in: Lightning
Builder. Then you can configure them the same way as the other components on the page so that Experience
your users get only the fields and sections that they want.
Available in: Group,
Note: Want to build forms on the Salesforce Platform, but aren't sure whether Dynamic
Professional, Enterprise,
Forms or screen flows in Flow Builder would be your best option? Check out Building Forms
Performance, Unlimited,
for an in-depth assessment of both.
and Developer Editions
Dynamic Forms provides:
• An instant upgrade from page layouts: Place fields and sections wherever you want.
• Dynamic layouts: Use visibility rules to show and hide fields and sections.
• Simpler layout management:
– Manage the fields and sections on your pages in the Lightning App Builder without touching the page layout editor.
– Reduce the number of page layouts and record types you need with component visibility rules.
– Get a single assignment model for the Lightning page instead of the dual model of assigning a Lightning page and a page
layout.

You can start using Dynamic Forms in two ways.

• Create a Lightning page from scratch, then drag Field and Field Section components onto it.
• Open an existing record page and migrate its record details using the migration wizard.
Dynamic Forms doesn’t only affect how your users see fields on a record page. It also affects what they see when they click to edit, create,
or clone a record. On Dynamic Forms-based pages, the fields that users see when creating, editing, or cloning come from the fields on
the page, not from the page layout.

555
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Note: Dynamic Forms is supported on custom objects, accounts (including person accounts), cases, contacts, leads, and
opportunities.

Migrate a Record Page to Dynamic Forms

With Dynamic Forms, you can migrate the fields and sections from your existing record pages as individual components in the
Lightning App Builder. Then you can configure them the same way as the other components on the page, so that your users get
only the fields and sections that they want. Dynamic Forms is supported on custom objects, accounts (including person accounts),
cases, contacts, leads, and opportunities. If you have save options on your account, case, or lead record pages, they are migrated.
Required and Read-Only Fields in Dynamic Forms
Universally required fields retain their status when you’re working with them on a Dynamic Forms-based Lightning page. But you
can make other fields required or read-only just for the page that you’re working on.
Record Page Save Options in Lightning App Builder
With save options, you can define object-specific checkboxes that can be configured as part of a Dynamic Forms-enabled record
save. Save options are available when editing an account or when creating, editing, or cloning a case or lead. Optionally, you can
set the checkboxes to be selected by default.
Dynamic Forms and Mobile
The Dynamic Forms Field Section component and the Field components that go inside it are desktop-only. But your mobile users
are still covered. The Record Detail - Mobile component gives your mobile users a way to see the record details on a Dynamic
Forms-enabled page.
Dynamic Forms on Mobile (Beta)
With Dynamic Forms on Mobile (beta), your mobile users can have the same customized experience that your desktop users have.
Dynamic Forms on Mobile (beta) is supported on: Accounts, Cases, Contacts, Leads, Opportunities, and custom objects.
Dynamic Forms on Mobile (Beta) Considerations
Keep these considerations in mind when working with Dynamic Forms on Mobile (beta).
Dynamic Forms Tips and Considerations
Keep these tips and considerations in mind when working with Dynamic Forms.
Dynamic Forms Limitations
Keep these limitations in mind when working with Dynamic Forms.
Dynamic Forms Known Issues
Keep these known issues in mind when working with Dynamic Forms.

556
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Migrate a Record Page to Dynamic Forms

With Dynamic Forms, you can migrate the fields and sections from your existing record pages as
EDITIONS
individual components in the Lightning App Builder. Then you can configure them the same way
as the other components on the page, so that your users get only the fields and sections that they Available in: Lightning
want. Dynamic Forms is supported on custom objects, accounts (including person accounts), cases, Experience
contacts, leads, and opportunities. If you have save options on your account, case, or lead record
pages, they are migrated. Available in: Group,
1. Open a Dynamic Forms-supported object record page for Lightning Experience in one of these Professional, Enterprise,
ways. Performance, Unlimited,
and Developer Editions
a. From the Setup menu on a record page, select Edit Page.

USER PERMISSIONS

To create and save Lightning

pages in the Lightning App
Builder:
• Customize Application
To view Lightning pages in
the Lightning App Builder:
• View Setup and
Configuration

When you select Edit Page for the first time, Salesforce makes a copy of the standard page. You edit this copy in the Lightning
App Builder. If a customized page exists and is active, selecting Edit Page opens that page to edit.

b. From the Object Manager in Setup, open a Dynamic Forms-supported object, then select Lightning Record Pages.
c. Open a record page for a Dynamic Forms-supported object from the Lightning App Builder list page in Setup. To find it, enter
App Builder in the Quick Find box, and then select Lightning App Builder.

2. Click the Record Detail component.

3. In the component detail pane, click Upgrade Now to start the Dynamic Forms migration wizard.

557
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

4. Walk through the wizard and select the page layout that has the fields that you want to migrate to the page.
Why choose a page layout when the Fields tab has all the fields that you need? The upgrade wizard takes the fields, sections, and
save options from the page layout that you choose and automatically adds them to your page. As long as a field is inside a Field
Section component, you can put it anywhere on the page, even inside tabs.

During migration, the Record Detail component is removed from the page and is replaced with fields and sections that you can configure
and place anywhere you like.

If your record page supports the phone form factor, a Record Detail - Mobile component is added to your page as part of the migration.
This component is unique to Dynamic Forms. It shows the standard record detail fields and sections to your users when they view the
page on a mobile device.

558
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

If you have opted in to Dynamic Forms on Mobile (Beta), the Record Detail - Mobile component isn’t added to pages you migrate to
Dynamic Forms. The Dynamic Forms content is visible on mobile without the need of the Record Detail - Mobile component

SEE ALSO:
Dynamic Forms and Mobile
Break Up Your Record Details with Dynamic Forms

Required and Read-Only Fields in Dynamic Forms

Universally required fields retain their status when you’re working with them on a Dynamic
EDITIONS
Forms-based Lightning page. But you can make other fields required or read-only just for the page
that you’re working on. Available in: Lightning
A field set to Required in the field definition in the Object Manager is a universally required field. Experience
Its Required value isn’t editable in the field’s properties in the Lightning App Builder property panel.
Also, the read-only status of some standard fields—such as Created By, Last Modified By, Owner, Available in: Group,
and Record Type—can’t be changed in the Lightning App Builder property panel. Professional, Enterprise,
Performance, Unlimited,
Fields marked as Required or Read-Only on a page layout retain that state when migrated into a and Developer Editions
Dynamic Forms-based page.
You can find all universally required fields for your page in the Universally Required Fields section
of the Fields palette. Fields that you make required at the page layout level or in the Lightning App Builder property panel don’t appear
in the Universally Required Fields section of the palette.
If you set a field on a Lightning page to Required or Read-Only in the Lightning App Builder property panel, the behavior applies only
to the field on that page, not to all instances of the field.
If a field set to Required in the Lightning App Builder, it’s hidden by a visibility rule at run time, users can save the record even if that field
isn't populated.
Be sure to include universally required fields on your Lightning pages that are used for creating or editing records. They aren’t added
automatically. If required fields are missing from the page, and the missing required fields don't have values, users can’t save a record
after editing, creating, or cloning it.
Don’t hide universally required fields with visibility filters. Users can’t save a record if values are missing in any universally required field,
even if they’re hidden by a visibility rule.

SEE ALSO:
Break Up Your Record Details with Dynamic Forms
Require Field Input to Ensure Data Quality
Considerations for Universally Required Fields

559
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Record Page Save Options in Lightning App Builder

With save options, you can define object-specific checkboxes that can be configured as part of a
EDITIONS
Dynamic Forms-enabled record save. Save options are available when editing an account or when
creating, editing, or cloning a case or lead. Optionally, you can set the checkboxes to be selected Available in: Lightning
by default. Experience
To use save options, some setup is required.
Available in: Group,
• Set up account save options like the Evaluate this account against territory rules on save Professional, Enterprise,
option for layout-based pages. Performance, Unlimited,
• Set up case save options like the Case Assignment and Email Notification options for and Developer Editions
layout-based pages.
• Set up lead save options like the Lead Assignment option for layout-based pages.
When a field section is added to an account, case, or lead record page in the Lightning App Builder, Salesforce shows the save options
checkboxes.

Choose whether to show the assignment rule checkbox and, if so, whether the checkbox is selected by default.

560
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

SEE ALSO:
Trailhead Territory Management Basics
Salesforce Help Set Up Assignment Rules

Dynamic Forms and Mobile

The Dynamic Forms Field Section component and the Field components that go inside it are
EDITIONS
desktop-only. But your mobile users are still covered. The Record Detail - Mobile component gives
your mobile users a way to see the record details on a Dynamic Forms-enabled page. Available in: Lightning
Note: These steps will soon be obsolete. Have you heard? To give your mobile users the Experience
same experience that your desktop users have, from Salesforce Mobile App Setup, enable
Available in: Group,
Dynamic Forms on Mobile (Beta).
Professional, Enterprise,
When you migrate a record page that supports both desktop and phone to Dynamic Forms, a Performance, Unlimited,
Record Detail - Mobile component is added to the page for you. and Developer Editions
But when you create a fresh page using a template that supports both desktop and phone, after
adding the fields and field sections, you must add the Record Detail - Mobile component to the
page yourself.
The Record Detail - Mobile component wraps fields from the Record Detail component into a mobile-only container. So, on pages that
support both desktop and phone, your desktop users see the Field Section components, and your mobile users see the Record Detail -
Mobile component.

561
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Example: Here’s what a page that you create in desktop mode in the Lightning App Builder looks like when viewed on a phone.
The Field Section components just below the Highlights Panel on desktop are dropped on mobile, and the Record Detail - Mobile
component takes over to deliver the sections and fields.

The Record Detail - Mobile component displays with an “Unsupported form factor” message when viewed on a page in the
Lightning App Builder in Desktop preview mode.

SEE ALSO:
Migrate a Record Page to Dynamic Forms
Break Up Your Record Details with Dynamic Forms

Dynamic Forms on Mobile (Beta)

With Dynamic Forms on Mobile (beta), your mobile users can have the same customized experience
EDITIONS
that your desktop users have. Dynamic Forms on Mobile (beta) is supported on: Accounts, Cases,
Contacts, Leads, Opportunities, and custom objects. Available in: Lightning
Note: This feature is a Beta Service. Customer may opt to try such Beta Service in its sole Experience
discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided
Available in: Group,
at Agreements and Terms.
Professional, Enterprise,
From Salesforce Mobile App Setup, enable Dynamic Forms on Mobile (Beta). Performance, Unlimited,
and Developer Editions

562
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

If you enable Dynamic Forms on Mobile (beta) and your dynamic-forms-enabled record page includes a Record Detail - Mobile component,
your users see only the Record Detail - Mobile component from their mobile device. So that your users can view Dynamic Forms on
Mobile content on pages that you upgrade to Dynamic Forms, remove the Record Detail - Mobile component from the page.
If you haven’t migrated your record page to Dynamic Forms, see Migrate a Record Page to Dynamic Forms.
Dynamic Forms on Mobile (beta) works on iOS and Android phones and tablets on all currently supported devices that run the Salesforce
Mobile App. See Requirements for the Salesforce Mobile App .

SEE ALSO:
Dynamic Forms on Mobile (Beta) Considerations
Break Up Your Record Details with Dynamic Forms

Dynamic Forms on Mobile (Beta) Considerations

Keep these considerations in mind when working with Dynamic Forms on Mobile (beta).
EDITIONS
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 Available in: Lightning
at Agreements and Terms. Experience

• Dynamic Forms on Mobile (beta) is supported on: Accounts, Cases, Contacts, Leads, Available in: Group,
Opportunities, and custom objects. Professional, Enterprise,
• Record-home offline priming isn’t supported. If you’re using AURA-based priming, you can’t Performance, Unlimited,
pre-prime (pre-download) your most recently used records. and Developer Editions
• Offline draft edits to record pages aren’t supported on pages with Dynamic Forms on Mobile
enabled.

Note: If you disable Dynamic Forms on Mobile (beta) you can use offline editing and priming again.

• Dynamic actions are supported on custom objects. Actions on standard objects come from the record details on the page layout,
not from the Dynamic Forms fields on the page.

SEE ALSO:
Dynamic Forms on Mobile (Beta)
Break Up Your Record Details with Dynamic Forms

563
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Dynamic Forms Tips and Considerations

Keep these tips and considerations in mind when working with Dynamic Forms.
EDITIONS

General Considerations Available in: Lightning

Experience
• When you switch page templates on a page that uses Dynamic Forms, the list of available
templates contains only the templates that are supported for your Dynamic Forms-enabled Available in: Group,
page. Professional, Enterprise,
• The Owner and Record Type fields get special handling in Dynamic Forms. They’re set to Performance, Unlimited,
Read-Only, and that state isn’t editable in the properties pane. and Developer Editions
• You can add more than one instance of the same field to a Lightning page, but all instances of
that field on the page show the same data.
• Programmatic versions of the accordion components don’t provide the same functionality as their App Builder counterparts. For
example, lightning-accordion and lightning:accordion components don’t currently support lazy loading.
• Expanding or collapsing a field section while designing a page has no effect on whether a section is expanded or collapsed for users
during runtime.
• When you clone a record based on a Dynamic Forms-enabled page that has visibility rules, all the fields referenced in the visibility
rules are added to the cloned record, regardless of whether those fields are on the page.
• When you save a new custom object record with an empty object name, the API populates the custom object name field with the
record ID. Make sure that the Name field is on the page and is marked as required.

General Tips
• We recommend not having both a Record Detail component and field sections on the same page. If you do, users can have issues
with the page, including:
– Multiple, overlapping save and cancel bars when both are on the page and both in inline edit.
– Visibility rules on Field and Field Section components not working properly.
– When users create, edit, or clone a record, the fields they see come from the Field Sections on the page, not from the Record
Detail.
– Field sections are top-down-left-right tab order only, while Record Detail is left-right-top-down tab order, which can cause
confusion. As a result, fields inside a Field Section sometimes don’t line up horizontally, while Record Detail fields do.

Mobile Tips
• Don’t place Field Section components on mobile-only Lightning pages. Field Section components are desktop-only and don’t appear
when the page is viewed on a phone.
• You can use one Lightning page for both desktop and phone. Add the Record Detail - Mobile component to the same page with
your Field Section components. Your desktop users see the Field Section components, and your mobile users see the Record Detail
- Mobile component.

564
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Note: Dynamic Forms on Mobile (beta) gives your mobile users the same experience that your desktop users have. To avoid these
mobile considerations, from Salesforce Mobile App Setup, enable Dynamic Forms on Mobile (Beta).

SEE ALSO:
Dynamic Forms Limitations
Dynamic Forms Known Issues
Break Up Your Record Details with Dynamic Forms

Dynamic Forms Limitations

Keep these limitations in mind when working with Dynamic Forms.
EDITIONS

General Available in: Lightning

Experience
• Dynamic Forms is supported on record pages for custom objects, accounts (including person
accounts), contacts, opportunities, cases, and leads only. Available in: Group,
• Dynamic Forms doesn’t work in Internet Explorer 11. Users with IE 11 who try to view a page Professional, Enterprise,
that uses Dynamic Forms get a page error. Performance, Unlimited,
and Developer Editions
• Dynamic Forms doesn’t work on pages based on pinned region templates and custom templates.
• Blank spaces aren’t supported.
• You can add up to 100 fields per column in a Field Section component.
• If you convert a section from two columns to one, the new single column can only hold 100 fields. If you had more than 100 fields
total between the two columns, when you switch to a single column, the first 100 fields are moved into the single column, and the
rest of the fields are dropped. If you change your mind after switching to single column, you can revert the change by immediately
clicking the undo button ( ).
• Users can expand or collapse field sections only while in view or inline edit mode, not in the full edit, create, or clone windows. If
you expand or collapse a field section and then refresh your browser, including pulling to refresh, the expanded or collapsed state
doesn’t persist.
• If you have Opportunity Products enabled and have the Prompt users to add products to opportunities setting enabled, when you
create an opportunity from either an opportunity-related list or from opportunity home, the create window uses record details from
the page layout.
• The Clone with Related action for opportunities uses record details from the page layout even if the opportunity page you launch
the action from uses Dynamic Forms.
• When viewing an external or non-UI API-supported object record that has a related list for a child object that supports Dynamic
Forms, if you create a record for that child object from the parent record related list, the create window uses record details from the
child object page layout.
• When configuring key fields in a path, the fields in the Available Fields list come from the record details on the object’s page layout,
even if the page the path resides on uses Dynamic Forms.
• The Lightning App Builder Record Detail to Dynamic Forms migration tool doesn’t migrate all possible layout save options. For
example, when saving a layout, if Default is checked but Show on edit page is unchecked, then this option isn’t migrated. Manually
set this value after migration.

565
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Migration
• Only fields, sections containing fields, and layout save options are included when migrating a page to Dynamic Forms. Other elements
on the page layout, such as custom links and blank spaces, aren't included.
• You can add up to 100 fields per column in a Field Section component. And you can add up to 100 sections per region. As a result,
if you use the migration tool to import fields and sections from a page layout that has more than those limits, then we migrate up
to the first 100 sections in each region and the first 100 fields in each column. The rest of the fields are dropped, even if they’re
required fields. You can manually add the dropped items later. If you change your mind after you make the switch, you can click the
undo button ( ) to roll back the changes.
• The Lightning App Builder Record Detail to Dynamic Forms migration tool doesn’t migrate all possible layout save options. For
example, when saving a layout, if Default is checked but Show on edit page is unchecked, then this option isn’t migrated. Manually
set this value after migration.

SEE ALSO:
Knowledge Article: Extended Support for Accessing Lightning Experience Using Microsoft Internet Explorer 11
Dynamic Forms Tips and Considerations
Dynamic Forms Known Issues
Break Up Your Record Details with Dynamic Forms

Dynamic Forms Known Issues

Keep these known issues in mind when working with Dynamic Forms.
EDITIONS
• Density settings for field sections aren’t respected in Lightning App Builder preview. Lightning
App Builder preview always shows the Comfy setting for field sections. Proper density settings Available in: Lightning
are applied during runtime. Experience
• If you click View All Dependencies from the Path component, the dependencies that you see
Available in: Group,
come from the record details on the page layout, not from the Dynamic Forms fields on the
Professional, Enterprise,
page.
Performance, Unlimited,
• If you create a record from a lookup, the fields on the window that appears come from the and Developer Editions
record details, not from the Dynamic Forms fields on the page.
• The CurrencyISOCode field doesn’t appear as required (with the asterisk) at runtime, although
it still behaves as required.
• When you hover over fields in the palette, the data types shown are inaccurate.
• On a Dynamic Forms-based page, multiple instances of the same lookup field that look up to an object that’s not supported in the
UI API result in a page error. See the User Interface API Developer Guide for the list of supported objects.
• Fields in two-column Field Section components don’t horizontally align correctly.
• For a non-UI API supported object that has a Forms-enabled object as a related list, if you click New from the related list, the parent
lookup field doesn't appear in the New dialog. But you can save the new record.
• A record’s printable view is based on the fields from its default page layout, not the fields on the Dynamic Forms-based page.
• Dynamic Forms field components aren’t supported inside the Macro Builder. When a Dynamic Forms-enabled record page is opened
inside of the Macro Builder, the field components don’t appear.
• Universally required fields that are only required for either Person Account or Business Account appear in the Universally Required
Fields section of the Fields panel regardless of which record type you're building the page for. For example, if you're creating a page
for the business account record type, you see both person account and business account required fields in the Universally Required

566
Extend Salesforce with Clicks, Not Code Break Up Your Record Details with Dynamic Forms

Fields section. When you save the business account page, you get a warning if the person account required field isn't present on
the page, even though the person account field isn't needed for the business account page.
• The Einstein Account Tier field is missing from the Record Detail component on custom account record pages in the Lightning App
Builder and when the account record page renders for users. If you migrate a custom account record page to Dynamic Forms, the
Einstein Account Tier field appears in the available fields list and on the record page in Lightning App Builder, but doesn't appear
when the page renders for users.
• You can define a Lightning page that supports multiple accounts, like a Business Account and a Person Account. You can’t designate
different save option values for the Business Account or Person Account flow on that Lightning page.
• When you create an object from a related list in the context of a person account using Dynamic Forms, the PersonContactId field is
not prepopulated in the new record.
• If you edit a field inline and don’t save, then use a quick action to edit and save, your inline edits aren’t saved when your quick action
edit is.
• If you move a record to a different status in Kanban view, and the status change triggers a field validation error, it opens the edit
window, but doesn’t show the error.

Visibility Rule Known Issues with Dynamic Forms

• Visibility rules based on parent object fields don’t work correctly.
• When you clone a record based on a Dynamic Forms-enabled page that has visibility rules, all the fields referenced in the visibility
rules are added to the cloned record, regardless of whether those fields are on the page. The field value used in the rule evaluation
and the field’s saved value on the cloned record can vary, depending on the cloning user’s access to the field used in the visibility
rule.
– If the user has read and write access to the field used in the visibility rule, and the field has a value, the source record's original
value is used in the rule evaluation and saved to the cloned record.
– If the user has read and write access to the field used in the visibility rule, and the field has no value, the source record's blank
value is used in the rule evaluation, but the cloned record saves with the field’s default value.
– If the user has only read access to the field used in the visibility rule, the source record's original value is used in the rule evaluation,
but the cloned record saves with the field’s default value.
– If the user doesn’t have read or write access to the field used in the visibility rule, the source value is treated as blank, and the
cloned record saves with the field’s default value.

SEE ALSO:
Dynamic Forms Tips and Considerations
Dynamic Forms Limitations
Break Up Your Record Details with Dynamic Forms

567
Extend Salesforce with Clicks, Not Code Dynamic Interactions in the Lightning App Builder

Dynamic Interactions in the Lightning App Builder

Dynamic Interactions is part of our continuing drive to make Lightning pages more dynamic and
EDITIONS
interactive. With Dynamic Interactions, an event occurring in one component on a Lightning page,
such as the user clicking an item in a list view, can update other components on the page. Dynamic Available in: Lightning
Interactions lets admins create applications with components that communicate and transform Experience
based on user interactions, all in the Lightning App Builder UI. It unlocks capabilities that previously
were reserved only for developers. Available in: Group,
To get the most out of Dynamic Interactions, admins and developers work together. Professional, Enterprise,
Performance, Unlimited,
Developers write custom components that power the Dynamic Interactions. The developer defines and Developer Editions
the events that the component supports and then exposes the events in the Lightning App Builder
UI. Then, in the Lightning App Builder, an admin configures the event by setting up the interactions
between the components.
Dynamic Interactions has four major building blocks.
• Event—Anything that can trigger an interaction, such as a mouse click, a button press, or a change in a field’s value.
• Interaction—An activity that happens between the source and the target.
• Source—The item triggering the event. Currently, only custom Lightning web components and the Dynamic Actions Bar component
(Pilot) on page 524 are supported as sources.
• Target—The item that’s the target of the interaction. Any component on a Lightning page can be a target.
An event occurring in one component (the source) can trigger changes in one or more other components on the page (the targets). A
single source can have multiple targets.

Note: Dynamic Interactions is supported only on app pages, and interactions are limited to activity between components.

Example: Kai (they/them) and Rina (she/her) are an admin and developer team. Kai wants to give their on-the-go users an easy
way to check the location of various accounts so that they can plan efficient site visits using a simple app page.
Kai enlists Rina’s help to make this happen. As a developer, Rina knows that she can wire up events between components using
code. But she wants to give Kai the power to configure the event interactions in the way that they need to without having to come
back to her every time a change is necessary.
Rina creates a custom source component for Kai, plus two other components to act as event targets. After installing the new
components in their org, Kai has an app page with three custom components: Account List, Account Detail, and Account Location
(a map).

568
Extend Salesforce with Clicks, Not Code Dynamic Interactions in the Lightning App Builder

The source component is the Account List on the left. It has an Item Selected event enabled, which Rina exposed to the Lightning
App Builder UI using new Dynamic Interactions code. After Kai finishes configuring the event interactions, when a user clicks a list
item in the Account List component, the event fires. The Account Detail component updates to show that account’s details. At
the same time, the Account Location component pinpoints that account’s location on a map. Every new click or tap on an account
in the list results in updating the content in the other two components.

SEE ALSO:
Lightning Web Components Dev Guide: Configure a Component for Dynamic Interactions in the Lightning App Builder
Lightning Web Components Dev Guide: XML Configuration File Elements

569
Extend Salesforce with Clicks, Not Code Dynamic Interactions in the Lightning App Builder

Configure Interactions in the Lightning App Builder

After you have a custom source component with exposed events in your org, you can assign event
EDITIONS
targets and configure the event interactions in the Lightning App Builder.
1. From Setup, in the Quick Find box, enter App Builder, then select Lightning App Builder. Available in: Lightning
Experience
2. Edit an existing app page, or click New to create one.
3. In the Lightning App Builder, add a custom source component to your page. Available in: Group,
If you don’t have target components on your page, add those too. Professional, Enterprise,
Performance, Unlimited,
4. Click the source component on the canvas. and Developer Editions
5. In the properties pane, click the Interactions tab.
6. Under the desired event, click Add Interaction. USER PERMISSIONS
The properties pane changes to show you the interaction details.
To create and save Lightning
7. Select an interaction. pages in the Lightning App
Currently, the only interaction available is Update Properties. Builder:
• Customize Application
8. Select the target component for the interaction. To view Lightning pages in
Components are listed with their region location to help you select the correct component the Lightning App Builder:
when you work on pages with components spread across multiple regions. • View Setup and
Configuration

9. Configure the target component properties.

When you select a target component, its properties appear in the Interaction Details pane. There you define the value that you want
each target property to have when the interaction happens. If you leave a target property blank, its value remains unchanged when
the event triggers.
To use an expression to define a target property value dynamically, click .
Checkbox properties have a No change option. If you’ve changed the value of a checkbox property, use this option to reset it back
to its original value, and to indicate that you want its value to remain unchanged when the event triggers.

10. Save the page.

SEE ALSO:
Dynamic Interactions in the Lightning App Builder
Dynamic Interactions Considerations

570
Extend Salesforce with Clicks, Not Code Dynamic Interactions in the Lightning App Builder

Expressions in Dynamic Interactions Target Properties

An expression is a small chunk of code that can be evaluated to a value. It can be as literal and
EDITIONS
simple as 1+1 or a more complex combination of variables, operators, and functions. One expression
is supported for Dynamic Interactions in the Lightning App Builder: Available in: Lightning
{!Event.eventPropertyName}. You can use this expression when setting target Experience
component property values in the Lightning App Builder UI and in Metadata API. The value of the
eventPropertyName part of the expression varies based on which properties the developer Available in: Group,
makes available for the event in the source component. Professional, Enterprise,
Performance, Unlimited,
Note: If you see the button on a target property, you can set its value with an expression. and Developer Editions
With an expression, you can pass a value, such as a record ID or an API name, to the target item.
Then when the event fires, the target item can use that value. Using an expression to define a
property value makes the event interaction dynamic. We can illustrate this with an example of an app page with custom Account List
and Account Location components. Here, an admin is configuring an interaction between the Account List source component and the
Account Location target component.

The goal for the interaction in this example is that when a user clicks an account in the list, the Account Location component updates
to show the selected account’s location as a point on a map. But the Account Location component needs to know the record ID of the
selected account to do that. Passing the record ID into the Account Location component tells the component which record to look at
to pull the address information. In this case, the developer made the recId property available as part of the event, so the target value
can be set to the active list item’s record ID using the {!Event.recId} expression.

571
Extend Salesforce with Clicks, Not Code Dynamic Interactions in the Lightning App Builder

Why not enter a 15- or 18-digit record ID into the field? If you do, any item clicked in the Account List always resolves to that one record
ID, which isn’t dynamic and is incorrect.
If the developer makes more than one target property available, you can set the property to be passed in by starting to type the expression
in the field. After the period, you can use autocomplete to select which property to use in the expression. But don’t forget to add the
ending bracket } after you make your selection.

Note: Expression autocomplete doesn’t work when:

• Using expressions in the rich text editor
• Typing an expression in a text field without first clicking the expression button ( )

SEE ALSO:
Configure Interactions in the Lightning App Builder
Dynamic Interactions Limits and Limitations
Dynamic Interactions in the Lightning App Builder

Dynamic Interactions Considerations

Keep these considerations in mind when working with Dynamic Interactions.
EDITIONS
• Informational components within target components are ignored when the target component’s
properties are shown in the Event property editor. Available in: Lightning
• If you switch page templates for a page that contains Dynamic Interactions, the available Experience
template list shows only templates that support Dynamic Interactions.
Available in: Group,
• Aura components re-render when an interaction targeting them is triggered. Professional, Enterprise,
• Autocomplete doesn’t work when entering an expression in the rich text editor. Performance, Unlimited,
and Developer Editions

572
Extend Salesforce with Clicks, Not Code Guidance for App Builder

• After a component’s event metadata is used on a Lightning page or released as part of a managed package, certain breaking changes
aren’t allowed, such as removing the event, renaming a property, or changing a property type.

Dynamic Interactions Limits and Limitations

Keep these considerations in mind when working with Dynamic Interactions in the Lightning App
EDITIONS
Builder.
• Dynamic Interactions is supported only on app pages. Available in: Lightning
• Only LWC custom components can be source components, but any component present on Experience
the page (Aura or LWC) can be a target.
Available in: Group,
• Dynamic Interactions isn’t supported on pages based on custom page templates. Professional, Enterprise,
• Only String and Rich Text type properties can use expressions to define their values. Performance, Unlimited,
• The “required” property restriction isn’t respected when defining a new value for a target and Developer Editions
property in Dynamic Interactions, regardless of its type or whether it’s defined with an expression.
• Event is the only context supported for expressions in interactions.
• You can use expressions only for properties of type String, Integer, and Boolean.
• You can’t set a target property value as an array or list of values, such as a multi-select picklist.
• You can set a target property value of a String attribute to empty using Metadata API but not in the Lightning App Builder UI.
• Dynamic Interactions doesn’t work in the Mobile Only app in the Salesforce mobile app or in the legacy tablet mobile experience.
• When a dependent property is autopopulated with a value based on a selection you made or a value you entered in another property,
the autopopulated value isn’t saved unless you “touch” the dependent property field by clicking into it or tabbing to it.

Guidance for App Builder

Get suggestions for improving your Lightning pages just when you need them. Guidance for App
EDITIONS
Builder gives you feedback for enhancing your Lightning pages right in the design phase.
Tips are available for categories such as performance, usability, and structural issues. Some issues Available in: Lightning
that the tips cover are also captured in the Salesforce Optimizer report. For example, if two Experience
components on a page are identical, you see a duplicate components tip. When you fix the issue,
the tip disappears. Available in: Group,
Essentials, Professional,
Enterprise, Performance,
Unlimited, and Developer
Editions

573
Extend Salesforce with Clicks, Not Code Guidance for App Builder

If tips are available for your page, you see an indicator icon on the Help menu.
To hide tips while designing your page, go to the Help menu and select Mute Tips. You can reopen the tips prompt by selecting View
Tips.

SEE ALSO:
Lightning App Builder Considerations
Salesforce Help: Improve Your Implementation with Salesforce Optimizer

574
Extend Salesforce with Clicks, Not Code Lightning Page Performance

Lightning Page Performance

Several factors can negatively affect your Lightning page’s performance at runtime. For example,
EDITIONS
your users can run into page performance issues if they aren’t using the latest version of a Salesforce
recommended browser to view the page. Some factors you can control, and others you can’t. Here Lightning App Builder
are some ways you can improve performance while configuring your page in the Lightning App available in: both Salesforce
Builder. Classic and Lightning
Consider the number, type, and placement of components on the page. These design-related issues Experience
can cause a page to load slowly: Lightning Home and utility
• Too many components visible on page load bar pages available in:
• Too many heavy-impact related lists visible, especially those lists with multiple-object Lightning Experience
relationships Lightning app and record
• Too many fields in your Record Detail component pages available in: both the
Salesforce mobile app and
• Having the News or Twitter component visible
Lightning Experience
If your page falls into one or more of these categories, we recommend that you move some
components into a non-default tab or Accordion component section, unless you’re designing the Email application pane
page for blind or low-vision users. For the heavy-impact related lists, we recommend that you move pages available in: both
Salesforce Classic and
the related lists lower on their respective page layouts so that they aren’t part of the initial page
Lightning Experience
load.
If your Record Detail component has many fields, we recommend that you reduce the fields on Available in: Group,
your page layout to fewer than 60. Alternatively, move the Record Detail component into a Essentials, Professional,
non-default tab or Accordion section so that it’s not part of the initial page load. Enterprise, Performance,
Unlimited, and Developer
For pages that are viewed on a phone, we recommend a maximum of eight visible components
Editions
per page. If a page has more than eight, put some in a tab or Accordion section or hide them for
mobile with a visibility filter.
You can see how your pages are performing in the Lightning Usage App from the App Launcher.
It shows you the most used pages in your org and their page load time by browser or by page.
Performance Analysis for App Builder automatically runs when you build a page. If your page performance is poor or moderate,
recommendations to improve performance appear. You can manually check a Lightning record page’s runtime performance at any time
by clicking Analyze from the Lightning App Builder toolbar. It assesses page performance based on all visible standard and custom
components on the page. Components in nondefault tabs and Accordion sections aren’t analyzed.
The User Metrics card provides 90 days of your org’s user data such as browser speeds, network latency, and number of cores. Use this
information to help you decide which Performance Analysis for App Builder recommendations to take.

Note: Salesforce measures performance in Experienced Page Time (EPT). The page load time mentioned here and in the Performance
Analysis for App Builder tool is EPT.

Considerations
• If a page has more than 5 related lists or more than 25 fields in the record detail, users can encounter performance issues when
viewing the page in the Salesforce mobile app.
• In the Performance Analysis for App Builder tool:
– Components that are restricted to the desktop form factor via a visibility rule aren’t included in the phone form factor performance
assessment.
– Analysis of page performance on a phone is available only on pages whose template supports the phone form factor.

575
Extend Salesforce with Clicks, Not Code Gain Insight About Page Performance with the Lightning
Usage App

– Components aren't the only factors influencing page load time, so the numbers in the component impact chart don't add up
to 100% of the predicted page load time.
– Analysis of pages for the desktop form factor is measured in seconds. For the phone form factor, the page is scored based on
the components that are visible when the page loads on a phone.
– User metrics are org-specific or page-specific data. Previously activated pages display metrics from visits to that page. New pages
display metrics from visits to all org pages. Metrics displayed in a sandbox can differ from metrics in production.

SEE ALSO:
Technical Requirements and Performance Best Practices
Measure Performance for Your Salesforce Org
Gain Insight About Page Performance with the Lightning Usage App
Get Lightning Experience Adoption Insights with the Lightning Usage App
Slowest Desktop Record Pages

Gain Insight About Page Performance with the Lightning Usage App
See how your Lightning pages are performing and understand the data in the Lightning Usage
EDITIONS
App. The Lightning Usage App shows you the most used pages in your org and their page load
time by browser or by page. Lightning App Builder
To open the Lightning Usage App, from the App Launcher, select Lightning Usage App. available in: both Salesforce
Classic and Lightning
Experience
Page Names in the Lightning Usage App
Lightning Home and utility
In the Lightning Usage App, under Page, the tables list Lightning pages by page name. Use this bar pages available in:
glossary to understand some of the page names for page types in your org. Lightning Experience

Note: Salesforce groups similar page types for the same object together in the Lightning Lightning app and record
Usage App. For example, the Opportunity object has two Lightning record pages. Results for pages available in: both the
both pages are grouped as Opportunity Record in the Lightning Usage tables. Salesforce mobile app and
Lightning Experience
Name Example Page Name Page Type Email application pane
Record Account Record An object’s record home page. pages available in: both
Salesforce Classic and
Record List Account Record List An object list view in a standard Lightning Experience
app or a Lightning Console
Available in: Group,
App.
Essentials, Professional,
Record List can also refer to a Enterprise, Performance,
Task list on the Task home Unlimited, and Developer
page. Editions

Related List Account Related List An expanded related list page

for an object. To view the
expanded related list, users
click View All from the related
list on a record page.

576
Extend Salesforce with Clicks, Not Code Gain Insight About Page Performance with the Lightning
Usage App

Name Example Page Name Page Type

Search Account Search Search results for a specific object.

one:recordActionWrapper Account one:recordActionWrapper The window that appears when users select
an action for an object.

Page Performance for Lightning Console Apps

Salesforce measures page performance using Experienced Page Time (EPT). EPT is a metric that calculates how long it takes for a page
to load into a state that a user can meaningfully interact with. In the Lightning Usage App, performance for Lightning pages in Salesforce
Console apps can differ from Lightning pages in standard apps.
Salesforce Console apps let you open multiple records at a time, with related records opened in subtabs under the original record. If a
user opens record tabs in a Salesforce Console app, the page reloads more quickly each time the user navigates back to an open tab. As
a result, the average EPT for that page appears to be lower in the Lightning Usage App. If a page loads in less than 150 milliseconds, it’s
filtered out of the page performance results in the Lightning Usage App.

Considerations for Lightning Usage App Tables

Keep these considerations in mind when viewing tables in the Lightning Usage App.
• Monthly tables show results for the last complete month rather than the last 30 days. For example, if you view a monthly report on
May 20, you see results from April 1 through April 30. On June 1, you can see results from May.
• Daily results in the Lightning Usage App are sometimes outdated by several days. Each day, the Lightning Usage App runs jobs on
usage data from the previous day. Results from that day appear in the Lightning Usage Apps tables only after the jobs complete.

577
Extend Salesforce with Clicks, Not Code Slowest Desktop Record Pages

Slowest Desktop Record Pages

Use the Slowest Desktop Record Pages table in the Lightning Usage App to see which desktop
EDITIONS
record pages could use some tweaking to run faster. It lists the desktop record pages with a median
loading time, called Experienced Page Time (EPT), of 4 seconds or longer. Lightning App Builder
The table lists the page name (1), developer name (2), and number of views (3). Click View (4) to available in: both Salesforce
open the record page in Lightning App Builder and view the Record Page Performance Analysis Classic and Lightning
results. Experience

Lightning Home and utility

bar pages available in:
Lightning Experience

Lightning app and record

pages available in: both the
Salesforce mobile app and
Lightning Experience

Email application pane

pages available in: both
Salesforce Classic and
Lightning Experience

Available in: Group,

Essentials, Professional,
Enterprise, Performance,
Unlimited, and Developer
Editions

SEE ALSO:
Technical Requirements and Performance Best Practices
Measure Performance for Your Salesforce Org
Lightning Page Performance
Gain Insight About Page Performance with the Lightning Usage App

578
Extend Salesforce with Clicks, Not Code Lightning App Builder Considerations

Lightning App Builder Considerations

Keep these considerations in mind when working with Lightning pages and Lightning apps in the
EDITIONS
Lightning App Builder.
Lightning App Builder
available in: both Salesforce
General
Classic and Lightning
• The Lightning App Builder supports the same browsers as Lightning Experience and isn’t Experience
supported on mobile browsers. The minimum recommended resolution for the Lightning App
Lightning Home and utility
Builder is 1280x1024.
bar pages available in:
• To reduce user confusion, give each tab and Accordion section a unique label. Lightning Experience
• The Lightning App Builder palette displays only the components that are available for the
Lightning app and record
devices supported by the page template. For example, you’re working on a page whose template
pages available in: both the
supports only desktop, the component palette contains components that support desktop,
Salesforce mobile app and
whether they support desktop only or both desktop and phone. Lightning Experience
• When you open a record page in the Lightning App Builder, you see only the components that
are available for the object tied to that page. For person account pages, some of the components Email application pane
pages available in: both
you see apply only to business accounts.
Salesforce Classic and
• When viewing a page in the Lightning App Builder, the form factor switcher displays only the Lightning Experience
devices that the page template supports.
• If the Lightning App Builder canvas view is switched to a form factor that a component on the Available in: Group,
page doesn’t support, that component displays as a placeholder with a warning. Essentials, Professional,
Enterprise, Performance,
• When a component is viewed on a device that the component doesn’t support, it’s dropped
Unlimited, and Developer
from the page.
Editions
• If you’re curious about a component, click it to see more information in the properties pane.
• You can create and edit a record page even if you don’t have permission to access the object
that the page is associated with. You can add, remove, delete, and reconfigure components on the page, but you don’t see any of
the content for the components that are based on that object.
• In Salesforce Classic, Lightning page tabs don’t display on the All Tabs page when you click . Lightning page tabs also don’t appear
in the Available Tabs list when you customize the tabs for your apps.
• When editing navigation items in a Lightning app, consider how many items you include. Users can’t remove the items you include
in the navigation bar, and they can’t personalize the navigation bar when it contains more than 50 items. For example, if you include
32 items in an app’s navigation bar, users can add 18 more personal items. Users can personalize the navigation to add or move
items, but users can't remove or rename the items that you add.
• Put the activity timeline component at the bottom of a layout, with no other components beneath it.
• On Lightning Experience record pages, a Record Detail component that contains more than four external lookup fields breaks the
page at runtime.

Page Templates
• The Three Regions template and the pinned region templates are designed with Lightning console apps in mind. They feature a
main region and two sidebars with fixed proportional widths. The main region is 50%, and the side region widths are each 25%.
Three-region templates require more screen width to display correctly. Three-region templates can display incorrectly on certain
devices or monitors with low resolutions.

579
Extend Salesforce with Clicks, Not Code Lightning App Builder Considerations

• When switching page templates, if a region in the template that you’re switching to has more than 25 components mapped to it,
all components after the 25th are dropped from the page. You can proceed with the template swap, but you must then manually
add the dropped components from the palette and reconfigure their properties.
• The console pinned region templates let users view and work with records while navigating subtabs in console apps. These templates
also work in apps with standard navigation. However, we recommend that you use a non-pinned region template in standard apps
because those apps don’t benefit from a pinned region. When working with pinned region templates, keep the following in mind.
– The templates are available only for record pages.
– Pinned regions don’t support theming. For example, if you use custom theming to brand your app with the color green, the
pinned region doesn’t apply the green color.

Page Activation and Assignment

• If a device isn’t on the options list when you try to assign a Lightning page as the org default, the page template doesn’t support it.
• You can see which record pages are activated for which Lightning app and which form factor in the Lightning Record Pages related
list in the Object Manager.
• If you no longer want a page to be an app or org default, redo the activation process for the page, and select the option to remove
it as the default.
• If you activate a page and then return to make changes, you don’t have to activate it again. Clicking Save after you make your edits
pushes the changes to your users.
• If you no longer want a page assigned to a particular form factor, redo the activation process, and select the option to remove it.
• If you activate a page for only one form factor, you can add support for another form factor later as long as the page’s template
supports it.
• Changes that you make to Lightning record page assignments aren’t immediately reflected in the Salesforce mobile app. To see a
newly assigned record page, close and restart the Salesforce mobile app.
• If there are no custom app-level page assignments set for the Service Console or Lightning Sales Console apps, users viewing those
apps in the Salesforce mobile app see the org default record page assigned to the object instead of the system app default record
page.
• If you assign a custom record page as the org-wide default for an object, it becomes the default page for that object across all your
Lightning apps. It also appears as the default record page for that object in Classic apps when you open them in Lightning Experience.
• Accounts and person accounts have different standard default pages to begin with. However, when you create a Lightning page
for accounts and assign it as the default for an org or an app, that page becomes the org or app default for business accounts and
person accounts. To display a custom record page for person accounts, create a custom account record page, then assign it to the
person account record type.
• An activated Lightning record page takes precedence over the Lightning Experience Override setting for the View action on the
object.

Pages and Packages

• If you package a Lightning page that references protected labels, then if a subscriber org clones that page, the protected labels cause
the components that use them on the cloned page to be invalid.

580
Extend Salesforce with Clicks, Not Code Considerations and Limitations for Flows in Lightning Pages

• A Lightning page installed from a managed package appears in the Lightning pages list with a Clone option rather than Edit or
Delete. The Edit and Delete buttons are also replaced with Clone on the installed page’s detail page.

SEE ALSO:
Create and Configure Lightning Experience Record Pages
Lightning App Builder Limits and Limitations

Considerations and Limitations for Flows in Lightning Pages

Here are some things to keep in mind when you add a flow component to a Lightning page.
EDITIONS
Lightning pages always use Lightning runtime, so also review Limitations of Lightning Runtime for
Flows. Available in: both Salesforce
Classic and Lightning
• Running Flows from a Lightning Page—When a user opens a Lightning page that has a flow
Experience
component, the flow runs when the page loads. Make sure that the flow doesn’t perform any
actions, such as create or delete records, before the first screen. Available in: Essentials,
• Input Variable Limitations—These variables aren’t supported. Professional, Enterprise,
Performance, Unlimited,
– Collection variables and Developer Editions
– Record variables
– Record collection variables

• The component supports only manually entered values for input variables.
• Text input variables accept a maximum length of 4,000 characters.
• Deployment Considerations—Change sets and the Metadata API deploy all flows as inactive, which users can’t run. If you deploy a
Lightning page (known as FlexiPage in the API) that contains a flow component, make sure to activate the flow.

581
Extend Salesforce with Clicks, Not Code Lightning App Builder Limits and Limitations

Lightning App Builder Limits and Limitations

Keep these limits and limitations in mind when working with Lightning pages and Lightning apps
EDITIONS
in the Lightning App Builder.
• In Salesforce Classic, the Default On and Default Off options for Lightning page tabs don’t work Lightning App Builder
the same way as for other custom tabs. The Lightning page menu item appears for the selected available in: both Salesforce
profiles in Salesforce for Android, Salesforce for iOS, and Salesforce mobile web whether you Classic and Lightning
choose Default On or Default Off. Select the Tab Hidden option to hide the Lightning page Experience
for the selected profiles. Lightning Home and utility
• You can place up to 100 tabs in a Tabs component. bar pages available in:
• A Lightning page region can contain up to 100 components. Lightning Experience

• Lightning component global actions aren’t supported for app pages. Lightning app and record
• Page overrides by profile aren’t supported in packaging. They are supported in change sets, pages available in: both the
but have to be added manually. Salesforce mobile app and
Lightning Experience
• Dropdown menus in the Lightning App Builder can display up to 200 items. Enter a few
characters, and all available matches are displayed as you type. Email application pane
• Although you can add the Potential Duplicates component to person account pages, the pages available in: both
Salesforce Classic and
component doesn’t display duplicate person accounts.
Lightning Experience
• Custom tab labels in the Tabs component—including those installed from packages—aren’t
translated. For example, if you create a custom Goals tab in English, then view the page as a Available in: Group,
user whose language is set to French, the tab still displays as Goals. However, you can use the Essentials, Professional,
{!$Label.customLabelName} expression in a component label or attribute to represent Enterprise, Performance,
a custom label that you create in Setup using the custom label feature. For more information, Unlimited, and Developer
see “Build Localized Component Labels and Attribute Values on Lightning Pages with Custom Editions
Labels on page 537.”

Component Visibility Rules

• A component can have up to 10 filters.
• Visibility filters aren’t supported for individual tabs inside the Tabs component.
• Some person account fields, including Email and Mobile, can’t be used in filters.

SEE ALSO:
Lightning App Builder Considerations

Manage Your Notifications with Notification Builder

Keep your users in the know with timely notifications, whether they’re at their desks or on the go. Create custom notifications to give
your users new information and reminders. Choose whether Salesforce notifications appear on desktop, mobile, Slack, or at all.

Create and Send Custom Desktop or Mobile Notifications

Create custom notifications that appear on Salesforce desktop or mobile when important events occur. Use a process in Process
Builder, Apex code, or the invocable action API to send the notification.

582
Extend Salesforce with Clicks, Not Code Create and Send Custom Desktop or Mobile Notifications

Custom Slack Notifications

Reach your users on Slack with important notifications.
Manage Notification Delivery Settings
Modify where your notifications appear and which apps deliver your notifications.
Considerations for Notification Builder
Learn about the considerations for sending and viewing notifications.

SEE ALSO:
Salesforce Mobile App Notification Types

Create and Send Custom Desktop or Mobile Notifications

Create custom notifications that appear on Salesforce desktop or mobile when important events occur. Use a process in Process Builder,
Apex code, or the invocable action API to send the notification.

Create a Desktop or Mobile Notification

Define the custom notification’s details.
Send a Desktop or Mobile Notification From a Process
Add the Send Custom Notification action to a process, then add recipients and content.
Other Ways to Send a Custom Notification
We’ve made it easy to build notifications using clicks, not code. But if your business needs are more complex, we also support flows
and programmatic solutions.

Create a Desktop or Mobile Notification

Define the custom notification’s details.
EDITIONS
1. From Setup, in the Quick Find box, enter Notification Builder, and then select
Custom Notifications. Available in: Lightning
Experience
2. Click New, and then select Salesforce Desktop or Mobile.
3. Add your Custom Notification Name and API Name, and notification channels. Available in: all editions,
except Database.com
Channel Description

Desktop Sends a notification to the desktop notification tray. USER PERMISSIONS

Mobile Sends an in-app and push notification to enabled supported apps.
To view notification types:
• View Setup and
Note: Mobile in-app notifications require the Enable in-app notifications setting. Mobile Configuration
push notifications depend on a user’s device-level and, if available, app-level push To create and edit
notification settings. Push notifications for the Salesforce mobile app require the Enable notification types:
push notifications setting. • Customize Application
Note: If you created a custom notification type with a mobile delivery channel before
Winter ’20, your notification is automatically delivered to the Salesforce mobile app. If
you create a custom notification type with a mobile delivery channel in Winter ’20 or

583
Extend Salesforce with Clicks, Not Code Create and Send Custom Desktop or Mobile Notifications

later, you must manually enable the Salesforce mobile app and any other supported apps in Notification Delivery Settings.

4. Save your notification type.

5. If you enable the mobile channel, you must enable the supported apps for your notification type.
a. From Setup, in the Quick Find box, enter Notification Builder, and then select Notification Delivery Settings.
b. Select your custom notification type, and select Edit from the dropdown menu.
c. Select the supported applications for your notification type, and save.

Send a Desktop or Mobile Notification From a Process

Add the Send Custom Notification action to a process, then add recipients and content.
EDITIONS
• Before you begin, make sure that the custom notification type that you want to call from your
process exists. If not, create the notification type on page 583. Available in: both Salesforce
• Before you can add an action to your process, you must define the process properties, configure Classic and Lightning
the process trigger, and add process criteria. If you’re new to creating processes, learn more in Experience
Process Builder help. Available in: Essentials,
After you create an action and select Send Custom Notification for the type, fill in the relevant Professional, Enterprise,
fields to add the action to your process. Performance, Unlimited,
and Developer Editions
1. Enter an easily recognizable name for this action.
The name appears on the canvas and helps you differentiate this action from others in your
USER PERMISSIONS
process. The name truncates to fit on the canvas.

2. Select a notification type. To create, edit, or view

processes:
3. Select a recipient category, and designate or find a recipient ID. • Manage Flow
• Current User — The user who initiated the record change, platform event, or process that AND
triggered the process. This option is useful for confirmation notifications, such as a successful View All Data
submission of a form.
• Find User — The user who receives the notification each time this action is executed.
• User Field from a Record — A user referenced via UserId on the record that initiated the process or on a related record.
• Find Group — All users in the group that receives the notification each time this action is executed.
• Find Queue — All users in the queue that receives the notification each time this action is executed.
• Account Field from a Record — All users on the account team for an account referenced via AccountId on the record that initiated
the process or on a related record. This option is available if you enabled account teams.
• Opportunity Field from a Record — All users on the opportunity team for an opportunity referenced via OpportunityId on the
record that initiated the process or a related record. This option is available if you enabled team selling.
• Owner Field from a Record — An owner or queue referenced via OwnerId on the record that initiated the process or a related
record. With this option, you can send a notification to all record owners, regardless of whether the owner is an individual owner
or a queue.

4. Write a helpful notification title and body using text and merge fields.

Note: The content of custom push notifications depends on the Display full content push notifications setting. If full content
push notifications aren’t enabled, only the notification title is sent.

5. Save the action.

584
Extend Salesforce with Clicks, Not Code Custom Slack Notifications

Other Ways to Send a Custom Notification

We’ve made it easy to build notifications using clicks, not code. But if your business needs are more complex, we also support flows and
programmatic solutions.

Tip: To see how to specify the target using JSON, see pageReference.

Flow Builder
Flow Core Action: Send Custom Notification
The Send Custom Notification action is available in Flow Builder. Add it to your flow, then add recipients and content.
Some tips specific to custom notifications:
• To query for the Notification Type ID directly from a flow, add the Get Record element to your flow and filter by API name. If
you’ve installed a notification type via a managed package, filter by the namespace prefix as well as the API name.
• To add recipients, define Recipient ID as a resource. Then add values to your Recipient ID collection by adding the Assignment
element to your flow.
If you’re new to creating flows, learn even more in Flow Reference.

Apex
CustomNotification
Use the CustomNotification Apex class to create, configure, and send custom notifications from Apex code, such as a
trigger.
When possible, create and send custom notifications from Apex rather than via API call. It’s less code, and more efficient.

API
CustomNotificationType
Use the CustomNotificationType object to create notification types and query for your Custom Notification Type ID. It’s
available for the following APIs:
• Metadata
• Tooling
• Lightning Platform REST and SOAP
customNotificationAction Invocable Action
Use the customNotificationAction action to send custom notifications to desktop and delivery channels.

Custom Slack Notifications

Reach your users on Slack with important notifications.
EDITIONS

Create and Send Custom Slack Notifications Available in: Lightning

Create custom notifications that appear on Slack when important events occur. Use a flow in Experience
Flow Builder or the invocable action API to send the notification. Available in: all editions,
except Database.com

585
Extend Salesforce with Clicks, Not Code Custom Slack Notifications

Merge Fields in Slack Notifications

To show record-specific information in your Slack notification, include merge fields in the notification content.
Slack Apps Supported by Notification Builder
Learn the Slack apps that can distribute your Slack notification to recipients.

Create and Send Custom Slack Notifications

Create custom notifications that appear on Slack when important events occur. Use a flow in Flow Builder or the invocable action API
to send the notification.

Create a Slack Notification

Define the custom notification’s details, select which Slack app distributes the notification, and then configure the Slack message.
Clone a Standard Notification Into a Custom Slack Notification
When you clone a Slack-enabled standard notification, you can use it as a template and then modify the content into a custom
notification that meets your specific needs.
Ways to Send a Slack Notification
Use a flow in Flow Builder to configure how your Slack notification is sent using clicks, not code. But if your business needs are more
complex, you can use the invocable action API to send your notification.

Create a Slack Notification

Define the custom notification’s details, select which Slack app distributes the notification, and then
EDITIONS
configure the Slack message.
Before you create a custom Slack notification, you must enable Salesforce for Slack Integrations and Available in: Lightning
configure the Slack app that distributes your notification on page 588. Experience
1. From Setup, in the Quick Find box, enter Notification Builder, and then select Available in: all editions,
Custom Notifications. except Database.com
2. Select New, and then select Slack.
3. Add your custom notification name and API name. Then select the object associated with the USER PERMISSIONS
notification type.
To view notification types:
4. Select the Slack app that distributes the Slack message to recipients. • View Setup and
5. Enter the title and body text of the Slack message. You can include merge fields on page 588 Configuration
in the title and body text. To create and edit
notification types:
6. Optionally, add buttons to include in the Slack message. For each button, select the button’s
• Customize Application
action, and enter its label. You can include merge fields in each button label.

Note: The button’s position in the list corresponds to where the button appears in the
Slack message. For example, the button in position 1 is placed in the left-most position
in the Slack message. To reorder a button, drag the button into a new position on the
list.

7. Save your notification.

586
Extend Salesforce with Clicks, Not Code Custom Slack Notifications

Clone a Standard Notification Into a Custom Slack Notification

When you clone a Slack-enabled standard notification, you can use it as a template and then modify
EDITIONS
the content into a custom notification that meets your specific needs.
Before you create a custom Slack notification, you must enable Salesforce for Slack Integrations and Available in: Lightning
configure the Slack app that distributes your notification on page 588. Experience

Note: As of Summer ’22, the clone option is available only for certain standard notification Available in: all editions,
types that are enabled for Slack. except Database.com

1. From Setup, in the Quick Find box, enter Notification Builder, and then select
Notification Delivery Settings. USER PERMISSIONS
2. Select the Slack-enabled standard notification type that you want to clone, and then select To view notification types:
Clone in the dropdown menu. • View Setup and
3. Add your notification name and API name. Configuration

4. Select the Slack app that distributes the Slack message to recipients. To create and edit
notification types:
5. Modify the Slack message title, body, and buttons as needed. • Customize Application
6. Save your notification.

Ways to Send a Slack Notification

Use a flow in Flow Builder to configure how your Slack notification is sent using clicks, not code. But if your business needs are more
complex, you can use the invocable action API to send your notification.

Flow Builder
Flow Core Action: Send Notification
After you create your custom Slack notification, your notification is available in Flow Builder as a Send Notification action. For example,
if you created a custom Slack notification named My Opportunity Notification, look for the My Opportunity Notification action in the
Notifications category.
Select your custom notification as an Action in the flow, then configure the recipients and record associated with your notification.
If you’re new to creating flows, learn more in Flow help.

API
sendNotification Invocable Action
Use the sendNotification invocable action to send your custom Slack notification. Each Send Notification action corresponds
to a supported notification. For example, if you created a custom Slack notification named My Opportunity Notification, you can
send this notification using the sendNotification/my_opportunity_notification action.

587
Extend Salesforce with Clicks, Not Code Custom Slack Notifications

Merge Fields in Slack Notifications

To show record-specific information in your Slack notification, include merge fields in the notification
EDITIONS
content.
Merge fields automatically include values from a record in your notification. The syntax for a merge Available in: Lightning
field is {!Record.Field}. The fields that you can reference depend on the object that you Experience
select for the notification.
Available in: all editions,
For example, you want to include the stage name of an Opportunity record in the title of your Slack except Database.com
notification. First, make sure to select Opportunity as the object for this notification. Then, in the
notification title, include the merge field {!Record.StageName}.
Merge fields are supported in the notification title, body text, and button labels. You can use merge fields to reference custom objects
and custom fields.

Note: Custom Slack notifications support only one nested level in a merge field. For example, {!Record.Field} is supported,
but {!Record.ChildRecord.Field} isn’t supported.

Example: This example notification alerts Slack users about a change in the stage of an Opportunity record.
Title: Stage update to {!Record.Name}
Body Text: The stage of {!Record.Name} is now {!Record.StageName}. The estimated amount
of this opportunity is {!Record.Amount}.
Button Action: View Record
Button Label: View {!Record.Name}

Slack Apps Supported by Notification Builder

Learn the Slack apps that can distribute your Slack notification to recipients.
EDITIONS
To send notifications to Slack, you must enable Salesforce for Slack Integrations and then configure
the Slack app that distributes your notification. Notification Builder supports these Slack apps. Available in: Lightning
Experience
• Care Coordination for Slack
• Sales Cloud for Slack Available in: all editions,
except Database.com
• Salesforce for Slack
• Service Cloud for Slack

588
Extend Salesforce with Clicks, Not Code Manage Notification Delivery Settings

Manage Notification Delivery Settings

Modify where your notifications appear and which apps deliver your notifications.
EDITIONS
For desktop and mobile notifications, choose the delivery channels or mobile delivery apps. For
Slack notifications, enable or disable Slack as a delivery channel. For custom notifications, you can Available in: Lightning
edit the delivery channels for supported Salesforce-provided apps and apps installed from a managed Experience
package. For standard notifications, you can edit the delivery channels for supported
Available in: all editions,
Salesforce-provided apps only.
except Database.com
1. From Setup, in the Quick Find box, enter Notification Builder, and then select
Notification Delivery Settings.
USER PERMISSIONS
2. Select the notification type, and select Edit from the dropdown menu.
Notification Delivery Settings shows you only the notification types available for your org. To view notification delivery
settings:
3. Select the channels or applications for your notification type, and then save. • View Setup and
Configuration
For desktop or mobile notifications, if either desktop or mobile delivery is listed but unavailable,
you can enable it from Custom Notifications in Setup. To edit notification delivery
settings:
To modify the Slack app for a Slack notification, edit the notification from Custom Notifications • Customize Application
in Setup.

Note: Mobile in-app notifications require the Enable in-app notifications setting. Mobile
push notifications depend on a user’s device-level and, if available, app-level push
notification settings. Push notifications for the Salesforce mobile app require the Enable
push notifications setting.

SEE ALSO:
Connect REST API Developer Guide: Notification Settings Resources
Metadata API Developer Guide: NotificationTypeConfig

Considerations for Notification Builder

Learn about the considerations for sending and viewing notifications.

Sending Notifications
• You can create up to 500 custom notification types.
• Each notification can have up to 10,000 users as recipients after expanding any groups, queues, or teams. However, you can add an
action to the same process within Process Builder or to the same flow in Flow Builder to have more recipients.
• An org can execute up to 10,000 notification actions per hour. When you exceed this limit, no more notifications are sent in that
hour, and all unsent notifications are lost. Notification actions resume in the next hour.
For example, your notification action processes are triggered 10,250 times between 4:00 and 4:59. Salesforce executes the first 10,000
of those actions. The remaining 250 notifications aren’t sent and are lost. Salesforce begins executing notification actions again at
5:00.

• When you send a custom notification from a process, the Target ID for the notification is the record that started the process. However,
target records that don't have their own detail page (for example, a case comment, which appears only in a Case Comment related

589
Extend Salesforce with Clicks, Not Code Considerations for Notification Builder

list) don't support direct navigation. Use Flow Builder to send the notification from a flow and specify either a different Target ID or
Target Page Reference.

Tip: To see how to specify the target using JSON, see pageReference.

• The title and body fields of custom desktop and mobile notifications support plain text only.
• The content of custom push notifications depends on the Display full content push notifications setting. If full content push notifications
aren’t enabled, only the notification title is sent.
• When you disable a delivery channel for a standard or custom notification type, you pause the delivery of a notification. However,
a notification is still created and stored whenever an existing notification type is triggered. If you enable a delivery channel for an
existing notification type, the stored notifications become visible in the notification tray for that delivery channel.
• Mobile in-app notifications require the Enable in-app notifications setting. Mobile push notifications depend on a user’s device-level
and, if available, app-level push notification settings. Push notifications for the Salesforce mobile app require the Enable push
notifications setting.
• If you created a custom notification type with a mobile delivery channel before Winter ’20, your notification is automatically delivered
to the Salesforce mobile app. If you create a custom notification type with a mobile delivery channel in Winter ’20 or later, you must
manually enable the Salesforce mobile app and any other supported apps in Notification Delivery Settings.

Viewing Notifications
• Recipients can view notifications received within the last 30 days. Older notification records are automatically deleted.
– On desktop, a user can view notifications from the last 30 days in their notification tray. The tray shows 50 notifications at a time,
ordered by the most recent notifications. The user can scroll to view older notifications within the last 30 days.
– In the Salesforce mobile app, a user can view notifications from the last 30 days in the app’s bell icon. The bell icon shows 20
notifications at a time, ordered by the most recent notifications. The user can swipe to view older notifications within the last
30 days.

• In the Salesforce mobile app:

– A push notification for an individual notification type depends on a user’s app-level Push Notification Settings. If the mobile
channel is enabled for a notification type, but a user disables push notifications for that type, the user doesn’t receive a push
notification.
– If you enable the mobile delivery channel for a notification type after you’ve disabled it, users’ Push Notification Settings for that
type default to enabled.

• A desktop notification can be delivered in real time to up to 1,000 concurrently logged-in recipients. Additional concurrently logged-in
recipients must refresh their Salesforce page to see their latest notifications. Recipients who aren't logged in see their notifications
as expected upon login.
• Your org saves your most recent 1 million custom notifications for view in notification trays. Your org can save up to 1.2 million
custom notifications, but it trims the amount to the most recent 1 million notifications when you reach the 1.2 million limit.

SEE ALSO:
Considerations for Salesforce Mobile App Notifications

590
Extend Salesforce with Clicks, Not Code Custom Domains

Custom Domains
Provide a branded experience for users who access your external-facing Salesforce content by
EDITIONS
serving your Digital Experiences or Salesforce Sites on a domain that you own, such as
https://www.example.com. Available in: both Salesforce
Classic and Lightning
Experience

Available in: Enterprise,

Performance, and
Unlimited Editions. Domains
that use the Salesforce CDN
are also available with
Marketing Cloud Account
Engagement (Pardot) in
Learn About Custom Get Ready Complete Option-Specific
Professional Edition.
Domains Determine How to Serve Your Prerequisites
Custom Domains in Salesforce Custom Domain Prerequisites for a Custom Applies to: Salesforce Sites
and LWR, Aura, and
Content Delivery Networks Custom Domain Prerequisites Domain That Uses Your HTTPS Visualforce sites
(CDNs) and Salesforce Certificate
Point Your Custom Domain to
Options to Serve a Custom Your Salesforce Org Prerequisites for the Salesforce
Domain CDN
Prerequisites for a Custom
Domain That Uses a Third-Party
Service or CDN

Set Up Your Domain Serve Your Sites on Your Maintain Your Custom
Test Your Custom Domains in Domain Domain
a Sandbox Add a Custom URL Update an Expiring Certificate
Set up a custom domain that Custom Domain Build Example for Your Custom Domain
uses: Custom Domain Management
• Your HTTPS certificate Troubleshoot Common Custom
• The Salesforce CDN Domain Issues
• A third-party service or
CDN
• A temporary non-HTTPS
domain

SEE ALSO:
Experience Cloud
Salesforce Sites

591
Extend Salesforce with Clicks, Not Code Custom Domains in Salesforce

Custom Domains in Salesforce

When you serve your Digital Experiences or Salesforce Sites on a domain that you own, your brand
EDITIONS
can shine. Learn about domains and custom URLs in Salesforce, and understand the relationship
between them. Available in: both Salesforce
Note: Custom domains that serve your sites are unrelated to the Use Custom Domain option Classic and Lightning
Experience
on the Salesforce login pages. For information about logging in with that option, see
Troubleshoot Login Issues. Available in: Enterprise,
For information about including your company’s brand in a subdomain of the URLs that Performance, and
Salesforce hosts for your org, for example, Unlimited Editions. Domains
https://mycompany.my.salesforce.com, see My Domain. that use the Salesforce CDN
are also available with
Unfamiliar with terms like DNS, CDN, and CNAME? Want to review the difference between a DNS Marketing Cloud Account
resolver and a certificate? See Custom Domain Terminology. Engagement (Pardot) in
Professional Edition.

Applies to: Salesforce Sites

Why Custom Domains and LWR, Aura, and
The primary reason to set up a custom domain is to provide a branded experience to your users. Visualforce sites
With a custom domain, your users access your external-facing Experience Cloud site or Salesforce
Site and its functionality through your branded URL. Experience Cloud sites, include Digital
Experiences built with Experience Cloud, Commerce, and Industries licenses.
Also, with the many-to-many relationship between sites and custom domains, you can serve your external-facing content to meet your
branding needs. For example, you can serve content from multiple Experience Cloud sites on one parent website, or serve multiple sites
on one domain through custom paths.
Custom domains are especially useful if you own multiple brands and want them to share content. For example, let’s say you have a
parent company with two distinct brands. Each brand has its own registered domain, and you want each of those domains to serve the
same parent website. You can use custom domains to point both brand domains to a single parent site with content from Salesforce.
Admins also benefit from custom domains. Because you can serve multiple sites on one domain, custom domains simplify the management
of your domains and your corresponding network allowlists. And even if your system-hosted site URL changes due to a My Domain
change, your custom domain remains constant, reducing the number of updates required.

Domains in Salesforce
Salesforce serves multiple domains for your org, including a login domain, such as MyDomainName.my.salesforce.com, and
site domains that can end in *.force.com, *.my.site.com, or *.my.salesforce-sites.com. You can’t edit those
Salesforce-managed domains, but you can add and manage custom domains from the Domains Setup page.
When you set up a domain in Salesforce, you specify the domain that you own, such as https://www.example.com, and select
an HTTPS option to serve that domain. For example, you can route your domain through your own HTTPS certificate, through the
Salesforce content delivery network (CDN) partner, or through a third-party CDN. Then, you point your domain to your site.

Custom URLs
Whether you use Experience Cloud sites, Salesforce Sites, or both solutions, your domains and sites can have a many-to-many relationship
through custom URLs. Each domain can serve up to 200 sites, and each site can be associated with up to 500 domains. An Experience
Cloud site counts as two sites, so if you use only Experience Cloud sites, each domain can serve 100 sites.

592
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

After you set up a custom domain for your org, you use Custom URLs to map your domain and its paths to specific sites. For each Custom
URL, you specify the domain record, the site, and the path. For example, if you have one site, you create a custom URL to point your
custom domain to that site for the root path (/).
With Custom URLs, you can also serve different sites via the same domain. For example, you own https://www.example.com,
and you have Experience Cloud sites for your online store, customer service and job postings. You can set up three custom URLs, each
with a different path: https://www.example.com/shop, https://www.example.com/help, and
https://www.example.com/apply. When users access the domain using one of those URLs, the custom path determines
which site they see.
For an example of the many-to-many relationship between sites, see Custom Domain Build Example.

SEE ALSO:
Custom Domains
Custom Domain Prerequisites
Options to Serve a Custom Domain
Add a Custom URL

Determine How to Serve Your Custom Domain

To determine the recommended HTTPS option to serve your custom domain, answer a few questions
EDITIONS
about your domain and your Salesforce configuration.
Available in: both Salesforce
Classic and Lightning
Experience

Available in: Enterprise,

Performance, and
Unlimited Editions. Domains
that use the Salesforce CDN
are also available with
Marketing Cloud Account
Engagement (Pardot) in
Professional Edition.

Applies to: Salesforce Sites

and LWR, Aura, and
Visualforce sites

593
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

1. If you don’t own a domain yet, determine the domain to use to serve your site content, including whether you require a registrable
domain. For more information, see Custom Domain Prerequisites.
2. If your domain currently serves content, to minimize the downtime for your domain, plan to set up a temporary non-HTTPS domain.
a. To move a domain to another org, set up a temporary non-HTTP domain as the first step. After the domain is configured in your
new org, use the same HTTPS option as the existing domain. For more information, see Move a Domain to Another Production
Org.
b. If your domain serves content outside of Salesforce, to determine the final option to use for your domain, go to the next step.

3. If you plan to use a registrable domain, skip to the question about whether a non-Salesforce third-party service or CDN serves your
domain.
4. If you have digital experiences, including the ones built with Experience Cloud, Commerce, and Industries licenses, we recommend
that you use the Salesforce content delivery network (CDN).
a. If your company’s policies prohibit the caching of your site content, go to the question about whether a non-Salesforce third-party
service or CDN serves your domain.

594
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

b. Otherwise, when you add your domain in Salesforce, select the HTTPS option Serve the domain with the Salesforce Content
Delivery Network (CDN). For instructions, see Serve Your Experience Cloud Site with the Salesforce Content Delivery Network
(CDN).
To learn how CDNs optimize page load times and site performance by caching your site content, see Content Delivery Networks
(CDNs) and Salesforce.
5. If a non-Salesforce third-party service or CDN serves your domain, when you add your domain in Salesforce, select the HTTPS option
Use a third-party service or CDN to serve the domain. For instructions, see Use a Third-Party Service or CDN to Serve Your Custom
Domain.
6. If your domain uses a web application firewall (WAF), when you add your domain in Salesforce, select the HTTPS option Use a
third-party service or CDN to serve the domain. For instructions, see Use a Third-Party Service or CDN to Serve Your Custom
Domain.
7. If none of the other scenarios apply, when you add your domain in Salesforce, select the HTTPS option Serve the domain with
your HTTPS certificate on Salesforce servers. For instructions, see Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers.
For more information about each of these options and the corresponding traffic flows, see Options to Serve a Custom Domain.

SEE ALSO:
Custom Domains
Options to Serve a Custom Domain
Custom Domain Prerequisites

Options to Serve a Custom Domain

Salesforce supports three HTTPS options to serve your domain. Whether you serve content for your
EDITIONS
domain via an HTTPS certificate that you own, through the Salesforce content delivery network
(CDN), or through an external service, we require that you use HTTPS. When initial configuration Available in: both Salesforce
requires that your domain is available before you enable HTTPS, Salesforce also supports a temporary Classic and Lightning
non-HTTPS option. Experience
Tip: This topic provides details on the four options to serve your custom domain. To determine Available in: Enterprise,
which is the correct option for you, see Determine How to Serve Your Custom Domain. Performance, and
Unfamiliar with terms like DNS, CDN, and CNAME? Want to review the difference between a DNS Unlimited Editions. Domains
resolver and a certificate? See Custom Domain Terminology. that use the Salesforce CDN
are also available with
Marketing Cloud Account
Serve the Domain with Your HTTPS Certificate on Salesforce Servers Engagement (Pardot) in
Professional Edition.
With this option, you upload your HTTPS certificate to Salesforce and configure your domain to use
that certificate. This option requires a certificate authority (CA)-signed certificate and that the DNS Applies to: Salesforce Sites
record for your domain point directly to your Salesforce org. and LWR, Aura, and
Visualforce sites
If the DNS record for your domain points to an external service, you can’t use this option. Common
examples of an external service include a web application firewall (WAF), a third-party host, or a
third-party content delivery network (CDN). To set up a domain that points to an external service,
choose the option to use a third-party service or CDN to serve your domain.
This diagram shows the routing of traffic when Salesforce uses your HTTPS certificate to serve your Experience Cloud site content on
your custom domain. Dotted lines ( ) represent DNS configurations, and the solid line ( ) represents user traffic flow

595
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

through HTTPS. The gray line represents traffic that originates outside Salesforce, and the blue lines represent traffic that originates in
Salesforce. In this example, the domain name is www.example.com and the 18-digit org ID is 00d000000000000013.

With your DNS provider, you point your custom domain (1) to the Salesforce internal canonical name (CNAME) record for your org (2),
which includes your org ID. In Salesforce, your certificate is stored on a secure server (3). Salesforce uses that certificate to serve the
content from your Experience Cloud site (4).
For more information on this option, including prerequisites, see Serve a Custom Domain with Your HTTPS Certificate on Salesforce
Servers.

Serve the Domain with the Salesforce Content Delivery Network (CDN)
With this option, you optimize page load times and site performance for your Experience Cloud site with our CDN. Salesforce partners
with Akamai to efficiently deliver publicly cacheable content to users on your Experience Cloud sites.
The Salesforce CDN is the recommended option for custom domains that serve Digital Experiences, including Experiences built with
Experience Cloud, Commerce, and Industries licenses.
If you use Marketing Cloud Account Engagement (Pardot) in a Professional Edition org, the Salesforce CDN is the only HTTPS option
available for your custom domains. The Salesforce CDN isn’t available for Salesforce Sites or in Professional Edition orgs without Marketing
Cloud Account Engagement.
This diagram shows the routing of traffic when Salesforce serves your custom domain with the Salesforce CDN. Dotted lines ( )
represent DNS configurations, and the solid line ( ) represents user traffic flow through HTTPS. The gray lines represent traffic
that originates outside Salesforce, and the blue line represents traffic that originates in Salesforce. In this example, the domain name is
www.example.com and the 18-digit org ID is 00d000000000000013.

596
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

With your DNS provider, you point your custom domain (1) to the Salesforce internal CNAME (2), which includes your org ID. Within
Salesforce, user traffic is routed to the Salesforce CDN partner (3), which acts as an intermediary for your Salesforce content (4).

Note: The Salesforce CDN for Digital Experiences serves only subdomains, such as www.example.com or
parts.example.com. Salesforce is unable to serve a registrable domain, such as example.com, when using the CDN for
Digital Experiences. If your site needs a registrable domain served via a CDN, host it on a CDN outside of Salesforce Experience
Cloud.
To review the benefits, limitations, and instructions for this option, see Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN).

Use a Third-Party Service or CDN to Serve the Domain

If a non-Salesforce service or host serves your custom domain, you can still serve your site content via that domain. Common examples
include a third-party CDN, a web application firewall (WAF), or a third-party hosting service that either provides or uses your HTTPS
certificate.
With this configuration option, your third-party service or CDN serves as an intermediary. In other words, traffic flows through the third
party. With this configuration option, your domain points to the third-party service.
This diagram shows the routing of traffic when a third-party service or CDN serves content from your Experience Cloud site on your
custom domain. In this example, the domain name is www.example.com, the 18-digit org ID is 00d000000000000013, and the org’s
target hostname is usa00.sfdc-xx18.salesforce.com.
The dashed line ( ) represents the configuration that points your domain to your third-party service or CDN. The dotted line
( ) represents routing through DNS, and the solid lines ( ) represent user traffic flow through HTTPS. The gray lines represent
traffic that originates outside Salesforce, and the blue lines represent traffic that originates in Salesforce.

Your custom domain (1) points to the third-party service or CDN (2). For example, you point your custom domain to the third party in
DNS. Or you set up a web application filter (WAF) as a proxy.
In Salesforce, you specify the external hostname for your domain. The Salesforce CNAME (3) uses that external hostname to point to
your non-Salesforce service or CDN (2). In the third-party service or CDN, the configuration points to your org’s target hostname (4). To
identify the domain and serve content from your site (5), Salesforce uses the value passed in the Host HTTP Header of the request from
the third-party service or CDN.
For more information on this option, including considerations and prerequisites, see Use a Third-Party Service or CDN to Serve Your
Custom Domain.

597
Extend Salesforce with Clicks, Not Code Determine How to Serve Your Custom Domain

Use a Temporary Non-HTTPS Domain

Salesforce requires that your custom domain is served via HTTPS. However, some configuration steps can require a temporary non-HTTPS
configuration. When your domain serves other content, or to move a custom domain to a new production org, you can use a temporary
domain to minimize disruption to your domain. Or when your HTTPS certificate isn’t ready to be uploaded to Salesforce, you can use a
temporary domain to start configuring your custom URLs.

Note: This option is intended as a temporary configuration only. When your custom domain is served via HTTP, users who attempt
to access your custom domain via HTTPS can see a certificate mismatch error and experience a connection timeout.
This diagram shows the routing of traffic when Salesforce serves your domain as a temporary non-HTTPS domain. Dotted lines ( )
represent DNS configurations, and the solid line ( ) represents user traffic flow through HTTP. The gray line represents traffic that
originates outside Salesforce, and the blue lines represent traffic that originates in Salesforce. In this example, the domain name is
www.example.com and the 18-digit org ID is 00d000000000000013.

To confirm ownership of your custom domain (1), with your DNS provider, you point the domain to the Salesforce internal CNAME (2),
which includes your org ID, via a CNAME or TXT record. If a CNAME record routes traffic to Salesforce, Salesforce uses an HTTP-only
endpoint that’s served on a secure server (3) to serve the content from your Experience Cloud site (4). However, the hosted certificate
(3) supports only HTTP on the custom domain instead of HTTPS. Also, the returned certificate creates a hostname-mismatch error because
that certificate doesn't support the custom domain name.
For more information, see Use a Temporary Non-HTTPS Domain to Serve Your Custom Domain.

SEE ALSO:
Custom Domains

598
Extend Salesforce with Clicks, Not Code Custom Domain Prerequisites

Custom Domain Prerequisites

Before you serve your site content with a custom domain, register a domain. To get that domain
EDITIONS
ready to serve your site content, update the Domain Name System (DNS) record to point to your
org. Review your site URLs for potential conflicts, and complete the prerequisites for your chosen Available in: both Salesforce
HTTPS option. Classic and Lightning
Experience
Determine Your Desired HTTPS Option Available in: Enterprise,
Performance, and
The HTTPS option for your domain specifies how the domain serves your site content via HTTPS. If
Unlimited Editions. Domains
you have Experience Cloud licenses, we recommend that you use the Salesforce content delivery
that use the Salesforce CDN
network (CDN). For both Experience Cloud sites and Salesforce Sites, you can serve your domain
are also available with
with your HTTPS certificate on Salesforce servers. Or you can use a non-Salesforce service or CDN Marketing Cloud Account
to host your domain. Engagement (Pardot) in
If you don’t have a domain yet, your chosen HTTPS option can affect the features that you require Professional Edition.
from your domain name registrar. For example, if you chose to serve your site via a third-party CDN,
Applies to: Salesforce Sites
you can select a company that provides domain name registration and the CDN service. For more and LWR, Aura, and
information, see Determine How to Serve Your Custom Domain. Visualforce sites

Register a Domain
If you own a domain such as www.example.com, you can use it to serve your site content.
If you don’t own a domain, choose a domain name and register it. When selecting a registrar, consider these factors.
• If you require services other than domain registration, selecting a provider that offers multiple services can reduce your cost.
• The reputation of the registrar or service provider. If you plan to bundle services, their reputation is especially important. Ensure that
your selected provider offers sufficient privacy protections.
• Salesforce doesn’t recommend registrable domains, such as example.com instead of www.example.com. If you choose to
serve your site with a registrable domain, see the important considerations in the section on Registrable Domains.
• The contract’s duration. A long-term contract can provide lower overall cost. With a shorter-term contract, if you become dissatisfied
with the service, you can transfer your domain name to another company.

Registrable Domains
A registrable domain—sometimes called a root domain or naked domain—is the domain’s public suffix, such as .com or .org, plus
the label to the left of that suffix. An example is example.com, without the www subdomain.
You can’t use the Salesforce CDN with a registrable domain. Because the Salesforce CDN is the recommended configuration for custom
domains that serve Experience Cloud sites, Salesforce doesn’t recommend registrable domains.
If you choose to serve your sites on a registrable domain, ensure that your provider supports alias records or CNAME flattening.
One of the prerequisites for a custom domain is to configure a canonical name (CNAME) record on your domain that points to your
Salesforce org. However, you can’t set a CNAME record on a registrable domain because of a DNS limitation. To bypass this limitation,
some DNS vendors implement a CNAME behavior for registrable domains that mimics the standard CNAME behavior. To serve your site
with a registrable domain, ensure that your DNS provider supports this workaround, which is often referred to as an alias record or CNAME
flattening.
If your DNS provider doesn’t support this workaround, you can’t use your registrable domain to serve your Experience Cloud sites or
Salesforce Sites.

599
Extend Salesforce with Clicks, Not Code Custom Domain Prerequisites

If you choose to serve your sites on a registrable domain, we recommend that you configure enable HSTS preloading on the domain.

Update Your Domain DNS Record to Point to Your Org

Before you add a domain in Salesforce, update the DNS record for your fully qualified domain name (FQDN) to include your 18-digit
Salesforce org ID. For more information, see Point Your Custom Domain to Your Salesforce Org.

Select the Org to Serve Your Site

Except for testing in a sandbox, a single fully qualified domain name (FQDN) is meant to exist in one org only. If you have multiple
production orgs, determine the org in which to add and maintain the domain.

Note: Although it’s technically feasible for domains with the same FQDN to exist in multiple non-sandbox orgs, that configuration
isn’t supported.

Review Your Site URLs for Potential Conflicts

If you host multiple sites on the same domain, be sure to review your site URLs for conflicts because it’s possible to configure the same
URL for pages on two different sites.
Let’s say that you host Site A and Site B on the same domain, https://www.example.com. Site A’s URL uses the custom URL
path prefix /products. Site B serves pages from the root path and has a page with the page path /products. As a result, both
Site A’s URL and Site B’s page URL are https://www.example.com/products.
In this scenario, a site visitor can access the Site B page only through a navigation menu on Site B. If a site visitor navigates to
https://example.com/products any other way, they’re directed to Site A.
If you identify a potential conflict, either rename the site path or choose a different path for serving the content on your custom domain.

Complete Additional Prerequisites Based on Your Chosen HTTPS Option

Review the prerequisites for your selected HTTPS option. See Prerequisites for a Custom Domain That Uses Your HTTPS Certificate,
Prerequisites for the Salesforce CDN, and Prerequisites for a Custom Domain That Uses Your HTTPS Certificate.

SEE ALSO:
Custom Domains

600
Extend Salesforce with Clicks, Not Code Custom Domain Prerequisites

Point Your Custom Domain to Your Salesforce Org

Before you add a domain in Salesforce, point your domain to your Salesforce org in Domain Name
EDITIONS
Service (DNS). If your custom domain uses your HTTPS Certificate or the Salesforce content delivery
network (CDN) partner, add a canonical domain name (CNAME) record for your fully qualified Available in: both Salesforce
domain (FQDN) to DNS. The CNAME record references your Salesforce org ID and your FQDN. Then, Classic and Lightning
if you plan to use the Salesforce CDN to serve your Experience Cloud site on your custom domain, Experience
add a second CNAME record that our CDN partner requires.
Available in: Enterprise,
Tip: Unfamiliar with terms like DNS, CDN, and CNAME? Want to review the difference between Performance, and
a DNS resolver and a certificate? See Custom Domain Terminology. Unlimited Editions. Domains
When you add a custom domain, Salesforce checks the domain’s DNS configuration to verify that that use the Salesforce CDN
are also available with
you own the domain. To meet this requirement, configure a CNAME record for your domain in DNS
Marketing Cloud Account
that point to your org. If you use the Salesforce content delivery network (CDN) or if Salesforce
Engagement (Pardot) in
serves your domain with your HTTPS certificate, the CNAME record is required for your permanent
Professional Edition.
custom domain configuration. If a third-party service or CDN serves your domain, the CNAME record
is required for initial setup only. Applies to: Salesforce Sites
and LWR, Aura, and
Note: If your domain serves other content via an existing A, AAAA, or CNAME record, you Visualforce sites
can’t add a CNAME record. If you update the DNS record to use the CNAME for your Salesforce
org instead, your site is disrupted. To minimize that disruption, use a TXT record in DNS to set
up a temporary non-HTTPS domain. After you complete the prerequisites and configure your USER PERMISSIONS
domain, you can update DNS with the required CNAME record. See Use a Temporary
To view a domain:
Non-HTTPS Domain to Serve Your Custom Domain.
• View Setup and
1. Get the internal Salesforce CNAME. Configuration
a. To test a custom domain in a sandbox, you create the domain in production and select the To add a domain:
sandbox as the associated org. In DNS, use the internal Salesforce CNAME for your production • Customize Application
org. OR
A canonical name (CNAME) record is an entry in the DNS record of a domain that points to a View Setup and
domain name instead of an IP address. When you add a domain in Salesforce, we verify that Configuration plus either
the domain points to your org via a CNAME record. That CNAME record has a target of your a Site.com Publisher
license or Create and Set
internal Salesforce CNAME, which includes your FQDN and your 18-digit Salesforce org ID.
Up Experiences
You can find your internal Salesforce CNAME and 18-character org ID at the top of the Domain
Setup page. To edit or delete a domain:
• Customize Application

601
Extend Salesforce with Clicks, Not Code Custom Domain Prerequisites

To get to this page, from Setup, in the Quick Find box, enter Domains, and then click Domains and click Add a Domain. The
option to add a domain is available only if at least one site exists in the org.
This internal Salesforce CNAME is in the format [YourFQDN].[Your18CharOrgId].live.siteforce.com.
Your domain’s fully qualified domain name (FQDN) is all the parts of the domain required to look up this authority by name
unambiguously using the internet’s DNS system. For example, www.example.com.
For example, to add www.example.com as a domain in a production org, if your 18-character org ID is 00d000000000000maq,
your domain’s internal Salesforce CNAME is www.example.com.00d000000000000maq.live.siteforce.com.

2. If you plan to use a registrable domain to serve your site, verify that your DNS provider supports alias records or CNAME flattening.
Then use the DNS vendor’s configuration system to point the domain to your internal Salesforce CNAME in DNS.
A registrable domain is a top-level domain, such as example.com without the www subdomain. For more information on registrable
domains, also known as root domains or naked domains, see Custom Domain Prerequisites.
Also note these limitations for registrable domains.
• If your DNS provider doesn’t support alias records or CNAME flattening, you can’t use a registrable domain to serve your sites.
• Salesforce is unable to serve a registrable domain via our content delivery network (CDN) partner, Akamai. The Salesforce CDN
only serves subdomains such as www.example.com or parts.example.com. If your site needs a registrable domain
served from a CDN, host it on a CDN outside of Salesforce.

3. If you don’t plan to use a registrable domain to serve your site, work with your DNS provider to update DNS. Add a CNAME record
for your fully qualified domain name that points to your internal Salesforce CNAME.
Here’s an example of a CNAME record for www.example.com that points to an org with ID 00d000000000000maq.
NAME TTL CLASS TYPE VALUE
--------------------------------------------------
www.example.com. 3600 IN CNAME
www.example.com.00d000000000000maq.live.siteforce.com.

602
Extend Salesforce with Clicks, Not Code Custom Domain Prerequisites

4. If you plan to use the Salesforce CDN to serve your Experience Cloud site on your custom domain, get the target value for your
domain’s _acme-challenge CNAME record.
a. In Setup, enter Domains in the Quick Find box, and then select Domains, and then add or edit a domain.
b. Select Serve the domain with the Salesforce Content Delivery Network (CDN) as the HTTPS Option.
The details for that option include the format of the _acme-challenge CNAME record.

To get the values for your domain, replace [domain] with your FQDN. The full format for the _acme-challenge name is:
_acme-challenge.[YourFQDN], and the format for the target value is
_acme-challenge.[YourFQDN].[Your18charOrgId].live.siteforce.com.

5. If you plan to use the Salesforce CDN to serve your Experience Cloud site on your custom domain, work with your DNS provider to
add your domain’s _acme-challenge CNAME record.
This CNAME record, referred to as the _acme-challenge, is for your domain’s certificate. The first CNAME record that you added is
for your domain, pointing to your internal Salesforce CNAME. Both CNAME records are required for the Salesforce CDN.

Important: If other TXT records exist in DNS for your domain’s _acme-challenge subdomain, remove them before you
provision your domain.

603
Extend Salesforce with Clicks, Not Code Test Your Custom Domains in a Sandbox

Here’s an example _acme-challenge CNAME record for www.example.com that points to an org with ID 00d000000000000maq.
NAME TTL CLASS TYPE VALUE
--------------------------------------------------
_acme-challenge.www.example.com. 3600 IN CNAME
_acme-challenge.www.example.com.00d000000000000maq.live.siteforce.com.

SEE ALSO:
Custom Domains
Custom Domain Prerequisites
Use a Temporary Non-HTTPS Domain to Serve Your Custom Domain

Test Your Custom Domains in a Sandbox

Develop and test your custom domains that serve content from your Experience Cloud sites and
EDITIONS
Salesforce Sites in a sandbox before you activate the domain in production.
Available in: both Salesforce
Considerations for Custom Domains in Sandboxes Classic and Lightning
Determine whether you can set up a custom domain in your sandbox, and review considerations Experience
for using a content delivery network (CDN) with a custom domain in a sandbox. Learn how to Available in: Enterprise,
prevent errors when you refresh, clone, or delete a sandbox associated with a custom domain. Performance, and
Set Up a Custom Domain for Testing in a Sandbox Unlimited Editions. Domains
Test a new domain before you activate it in production, or test changes to your custom domain that use the Salesforce CDN
are also available with
or to your sites. Create a custom domain in production that points to your sandbox. That domain
Marketing Cloud Account
serves the Experience Cloud sites or Salesforce Sites in your sandbox with the custom URLs in
Engagement (Pardot) in
the sandbox.
Professional Edition.
Activate a Sandbox Custom Domain in Production
Applies to: Salesforce Sites
After you test a custom domain that serves your Experience Cloud sites or Salesforce Sites in a
and LWR, Aura, and
sandbox, move any updates to your sites and the custom URLs for your domain to production.
Visualforce sites
Then activate the custom domain in production.

SEE ALSO:
Custom Domains

604
Extend Salesforce with Clicks, Not Code Test Your Custom Domains in a Sandbox

Considerations for Custom Domains in Sandboxes

Determine whether you can set up a custom domain in your sandbox, and review considerations
EDITIONS
for using a content delivery network (CDN) with a custom domain in a sandbox. Learn how to
prevent errors when you refresh, clone, or delete a sandbox associated with a custom domain. Available in: both Salesforce
Classic and Lightning
Feature Exclusions Experience

In each production environment, you can define multiple sandbox custom domains, but only one Available in: Enterprise,
custom domain associated with a sandbox org can use the Salesforce content delivery network Performance, and
(CDN). Unlimited Editions. Domains
that use the Salesforce CDN
Third-party CDNs are supported only if the CDN configuration meets the prerequisites. are also available with
Marketing Cloud Account
Engagement (Pardot) in
Sandbox Refreshes from Production
Professional Edition.
When you refresh a sandbox from its owning production Salesforce org, the custom domain remains
associated with the sandbox in a provisioned but inactive state. After you activate the refreshed Applies to: Salesforce Sites
sandbox, log in and validate the sandbox Salesforce Sites and Experience Cloud sites domains from and LWR, Aura, and
Visualforce sites
the Custom URLs Setup page.

Cloning a Sandbox
You can create a sandbox by cloning an existing sandbox rather than using your production org as the source. When you activate a
cloned sandbox, any custom domains associated with the sandbox remain associated with the inactive source sandbox. Until the custom
domain is associated with the cloned sandbox again, calls to the custom domain return an error.
To associate your custom domain with the cloned sandbox, after the cloned sandbox is activated, log in to your production org. From
the Domains Setup page, edit the custom domain, and change the associated org to an org other than your sandbox. Save your changes,
and then activate the domain. Then edit the custom domain again, and update the associated org to your sandbox. Save and activate
your domain.
After you reactivate the custom domain for your sandbox, log in to the sandbox and validate the sandbox Salesforce Sites and Experience
Cloud sites domains from the Custom URLs Setup page.

Custom Domains That Point to a Sandbox Experience Builder Site

After you refresh or clone a sandbox, republish your sandbox Experience Builder sites. Calls to a custom domain that points to an
Experience Builder site return an error until you publish the site.

Deleting a Sandbox
Before you delete a sandbox, log in to production and associate any custom domains for that sandbox with a different org. If you don’t
update the domain in production, calls to the custom domain URL return an error.

SEE ALSO:
Custom Domains
Test Your Custom Domains in a Sandbox
Create, Clone, or Refresh a Sandbox
Use a Third-Party Service or CDN to Serve Your Custom Domain

605
Extend Salesforce with Clicks, Not Code Test Your Custom Domains in a Sandbox

Set Up a Custom Domain for Testing in a Sandbox

Test a new domain before you activate it in production, or test changes to your custom domain or
EDITIONS
to your sites. Create a custom domain in production that points to your sandbox. That domain
serves the Experience Cloud sites or Salesforce Sites in your sandbox with the custom URLs in the Available in: both Salesforce
sandbox. Classic and Lightning
Experience
Note: To test a custom domain in a sandbox, create the domain in production and select
the sandbox as the associated org. You can view the domain in your sandbox, but you manage Available in: Enterprise,
sandbox custom domains in production. Performance, and
Before you start, review the considerations for this feature. Then, in your sandbox, create the Unlimited Editions. Domains
Experience Cloud sites or Salesforce Sites that you want to serve with the custom domain. that use the Salesforce CDN
are also available with
1. Determine the HTTPS option for serving your custom domain. See Determine How to Serve Marketing Cloud Account
Your Custom Domain. Engagement (Pardot) in
2. Complete the prerequisites for a custom domain, including any prerequisites for your chosen Professional Edition.
HTTPS option. Applies to: Salesforce Sites
To test a custom domain that serves content from sites in your production org, use the and LWR, Aura, and
18-character org ID for your production org when you update DNS. For more information, see Visualforce sites
Point Your Custom Domain to Your Salesforce Org.

3. In production, create the custom domain that serves site content from your sandbox. USER PERMISSIONS
a. If you have a certificate authority (CA)-signed certificate using Certificate and Key To view a domain:
Management for your domain, see Set Up a Custom Domain That Uses Your HTTPS • View Setup and
Certificate. Configuration
b. To use the Salesforce CDN partner to host an Experience Cloud site on your custom domain, To add a domain:
see Set Up a Custom Domain That Uses the Salesforce CDN. • Customize Application
In each production environment, only one sandbox custom domain at a time can use the OR
Salesforce content delivery network (CDN). To use the Salesforce CDN in a different sandbox View Setup and
custom domain, update the existing sandbox custom domain that serves an Experience Configuration plus either
Cloud site via the CDN partner. Specifically, change the HTTPS option or associated org for a Site.com Publisher
that domain so that it no longer uses the Salesforce CDN partner in a sandbox. license or Create and Set
Up Experiences
If you use Marketing Cloud Account Engagement (Pardot) in a Professional Edition org, you
must use the Salesforce CDN partner to serve your custom domain. To edit or delete a domain:
• Customize Application
c. If your domain is served by a web application firewall (WAF), an external service, or a
To add, edit, and delete
non-Salesforce service CDN, see Set Up a Custom Domain That Uses a Third-Party Service custom URLs:
or CDN. • Customize Application
d. If your domain already serves content, you can use a temporary non-HTTPS domain to OR
minimize disruption. You can also use a temporary non-HTTPS domain to configure a View Setup and
domain for which your HTTPS certificate isn’t ready. After you configure your custom domain, Configuration AND either
switch to one of the other supported HTTPS options. See Use a Temporary Non-HTTPS Create and Set Up
Domain to Serve Your Custom Domain. Experiences OR a
Site.com Publisher
e. For Associated Org, select your sandbox.
license
The custom domain serves the Experience Cloud sites or Salesforce Sites in the associated
org.

4. Save your domain.

606
Extend Salesforce with Clicks, Not Code Test Your Custom Domains in a Sandbox

After you save your new domain, Salesforce provisions the domain or gets it ready for use. The provisioning process can take 4–14
hours. When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you
receive an email.

5. To activate your domain, on the Domains Setup page in production, click Activate next to your custom domain.
Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed and the Current HTTPS Option changes to reflect the option that you
selected.

6. To serve your sites via your activated domain, log in to the sandbox and add a custom URL.
Your custom domain is ready for testing. After you complete your testing, you can activate the custom domain in production.

SEE ALSO:
Custom Domains
Test Your Custom Domains in a Sandbox
Experience Cloud
Salesforce Sites

Activate a Sandbox Custom Domain in Production

After you test a custom domain that serves your Experience Cloud sites or Salesforce Sites in a
EDITIONS
sandbox, move any updates to your sites and the custom URLs for your domain to production. Then
activate the custom domain in production. Available in: both Salesforce
Before you activate your custom domain in production, set up a custom domain for testing in Classic and Lightning
sandbox, and complete testing. Then move the Experience Cloud site and custom URLs that the Experience
sandbox custom domain serves to production. For example, move your Experience Cloud sites and
Available in: Enterprise,
the custom URLs associated with the domain via a change set. Performance, and
1. If your domain serves content from a site in your sandbox, validate that the content that the Unlimited Editions. Domains
domain serves exists in production. that use the Salesforce CDN
are also available with
Check for the Experience Cloud site or Salesforce Site, the relevant site pages and content, and
Marketing Cloud Account
the custom URLs for the domain.
Engagement (Pardot) in
2. Validate that your DNS record points to your production org. See Point Your Custom Domain Professional Edition.
to Your Salesforce Org.
Applies to: Salesforce Sites
If your custom domain points to your sandbox or another production org in DNS, point the and LWR, Aura, and
custom domain to your production org, and test in your sandbox again. Visualforce sites

3. Update the custom domain in Salesforce.

a. From Setup in production, in the Quick Find box, enter Domains, and then select Domains. USER PERMISSIONS

b. For your existing custom domain, select Edit. To view a domain:

• View Setup and
c. Update the value in the Associated Org field from your sandbox to Production, and save
Configuration
your changes.
To edit a domain:
After you save your changes, Salesforce provisions the domain or gets it ready for use. When
• Customize Application
the provisioning process is complete, you receive an email and the domain status changes to
Awaiting Activation.

4. To activate your domain, on the Domains Setup page, click Activate next to your custom domain.

607
Extend Salesforce with Clicks, Not Code Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed and the Current HTTPS Option changes to reflect your selected HTTPS
option.

SEE ALSO:
Custom Domains
Test Your Custom Domains in a Sandbox
Setting Up Salesforce Sites
Set Up and Configure Your Org for Experience Cloud Sites

Serve a Custom Domain with Your HTTPS Certificate on Salesforce Servers

Use an HTTPS certificate that you own to serve your custom domain. After you set up your domain
EDITIONS
in Salesforce, that domain can serve your Experience Cloud sites or Salesforce Sites.

Note: With this option, Salesforce hosts your domain using your HTTPS certificate. If the DNS Available in: both Salesforce
record for your domain points to an external service, you can’t use this option. Common Classic and Lightning
Experience
examples of an external service include a web application firewall (WAF), a third-party host,
or a third-party content delivery network (CDN). To set up a domain that points to an external Available in: Enterprise,
service, see Use a Third-Party Service or CDN to Serve Your Custom Domain. Performance, and
Unlimited Editions. Domains
that use the Salesforce CDN
Prerequisites for a Custom Domain That Uses Your HTTPS Certificate
are also available with
Before you serve your domain with an HTTPS certificate that you own, confirm that this HTTPS
Marketing Cloud Account
option applies to your configuration. Then update your DNS configuration, and upload your Engagement (Pardot) in
HTTPS certificate. Professional Edition.
Set Up a Custom Domain That Uses Your HTTPS Certificate
Applies to: Salesforce Sites
Upload an HTTPS certificate that you own to Salesforce servers, then serve your custom domain and LWR, Aura, and
with that certificate. After you set up your domain in Salesforce, that domain can serve your Visualforce sites
Experience Cloud sites or Salesforce Sites.

SEE ALSO:
Custom Domains
Options to Serve a Custom Domain

608
Extend Salesforce with Clicks, Not Code Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers

Prerequisites for a Custom Domain That Uses Your HTTPS Certificate

Before you serve your domain with an HTTPS certificate that you own, confirm that this HTTPS
EDITIONS
option applies to your configuration. Then update your DNS configuration, and upload your HTTPS
certificate. Available in: both Salesforce
Tip: Unfamiliar with terms like DNS, CA, and CNAME? See Custom Domain Terminology. Classic and Lightning
Experience
1. Confirm that your HTTPS certificate meets these requirements.
Available in: Enterprise,
a. A certificate authority (CA) signed the certificate, or your CA is prepared to sign your Performance, and
certificate. Unlimited Editions. Domains
that use the Salesforce CDN
b. The expiration date is a future date.
are also available with
c. The certificate matches the domain name. Optionally, use a wildcard or Subject Alternative Marketing Cloud Account
Name (SAN) certificate. Engagement (Pardot) in
For example, to add www.example.com as a domain name in Salesforce, you can use Professional Edition.
an HTTPS certificate for www.example.com. Or, if your certificate authority supports Applies to: Salesforce Sites
SAN certificates, you use a SAN certificate that includes www.example.com. To have and LWR, Aura, and
the certificate cover www.example.com, shop.example.com, and Visualforce sites
parts.example.com, you can use an HTTPS certificate for *.example.com.

2. To point your domain directly to the internal canonical name (CNAME) for your org, update DNS. For instructions, see Point Your
Custom Domain to Your Salesforce Org.
If the DNS record for your domain points to a web application firewall (WAF), you can’t use this option. If a third-party service or
content delivery network (CDN) serves your domain, you can’t use this option, even if the third party hosts your domain with your
HTTPS certificate. In those cases, see Use a Third-Party Service or CDN to Serve Your Custom Domain.

3. Upload your certificate.

a. If your CA uses intermediate certificates, see the instructions in the knowledge article, Merge a complete certificate chain for
custom HTTPS domains.
b. To upload your certificate to Salesforce, see Generate a Certificate Signed by a Certificate Authority. You can get the required CA
signature as a part of that process.
c. To import an existing certificate that is already signed, see the knowledge article, Use HTTPS certificate that exists within your
Community domain.

SEE ALSO:
Custom Domains
Set Up a Custom Domain That Uses Your HTTPS Certificate

609
Extend Salesforce with Clicks, Not Code Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers

Set Up a Custom Domain That Uses Your HTTPS Certificate

Upload an HTTPS certificate that you own to Salesforce servers, then serve your custom domain
EDITIONS
with that certificate. After you set up your domain in Salesforce, that domain can serve your
Experience Cloud sites or Salesforce Sites. Available in: both Salesforce
Unfamiliar with terms like DNS, CDN, and CNAME? Want to review the difference between a DNS Classic and Lightning
resolver and a certificate? See Custom Domain Terminology. Experience

Note: To create and activate a custom domain in a sandbox, add the domain in the production Available in: Enterprise,
org that owns the sandbox. Performance, and
Unlimited Editions. Domains
1. Complete the prerequisites for this option. that use the Salesforce CDN
With this option, Salesforce hosts your domain using your HTTPS certificate. If a third party hosts are also available with
your domain, if you use a web application firewall (WAF), or if you use a third-party content Marketing Cloud Account
delivery network (CDN), see Use a Third-Party Service or CDN to Serve Your Custom Domain Engagement (Pardot) in
instead. Professional Edition.

2. From Setup, in the Quick Find box, enter Domains, and then select Domains. Applies to: Salesforce Sites
and LWR, Aura, and
3. Click Add a Domain. Visualforce sites
4. Enter the domain name.
Salesforce validates ownership based on the fully qualified domain name (FQDN) that you enter USER PERMISSIONS
when you add a domain to your org. If you get an error message, point your custom domain
to your org, and then wait for the changes to propagate. After you update your domain’s DNS To view a domain:
record, it can take up to 20 hours for that change to take effect worldwide. • View Setup and
Configuration
5. For HTTPS Option, select Serve the domain with your HTTPS certificate on Salesforce
To add a domain:
servers.
• Customize Application
6. Click the lookup icon ( ), and then select your certificate. OR
Here’s the Domain page when you select the HTTPS option to serve the domain with your View Setup and
HTTPS certificate. Configuration plus either
a Site.com Publisher
license or Create and Set
Up Experiences

To edit or delete a domain:

• Customize Application
To add, edit, and delete
custom URLs:
• Customize Application
OR
View Setup and
Configuration AND either
Create and Set Up
Experiences OR a
Site.com Publisher
license

610
Extend Salesforce with Clicks, Not Code Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers

The top of the page includes your 18-digit org ID and the format for the canonical name (CNAME) in DNS to point your domain to
your org (1). To specify the certificate for this domain, use the certificate field (2). When you select the option to serve your domain
with your HTTPS certificate on Salesforce servers, additional guidance includes the target hostname to use for the CNAME record
for your domain in DNS (3). Replace [domain] with your domain name, such as www.example.com.

7. To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your
domain, select Allow HSTS preloading registration.
This setting adds the preload directive to the HSTS header. After you enable this setting, submit your domain at https://hstspreload.org.
For more information, see Enable HSTS Preloading on a Custom Domain.

8. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to serve the sites in your production org, select Production. Or select a sandbox where you want to test this custom
domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

9. Save your domain.

The status of your domain changes to Awaiting Custom URL. For domains with this HTTPS option, provisioning starts when you add
the first custom URL.

10. To serve your sites via your domain, add a custom URL.

611
Extend Salesforce with Clicks, Not Code Serve a Custom Domain with Your HTTPS Certificate on
Salesforce Servers

When you add the first custom URL for your domain, Salesforce provisions the domain or gets it ready to be used. The provisioning
process can take 4–14 hours. When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting
Activation and you receive an email.
Newly created custom domains use HTTP, not HTTPS, until you activate the domain.

11. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.
Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed and the Current HTTPS Option changes to Salesforce Cloud.

This diagram shows the connectivity between your custom domain and your Experience Cloud site content after you set up a custom
URL to serve your site and activate your custom domain. Dotted lines ( ) represent DNS configurations, and the solid line ( )
represents user traffic flow through HTTPS. The gray line represents traffic that originates outside Salesforce, and the blue lines represent
traffic that originates in Salesforce. In this example, the domain name is www.example.com and the 18-digit org ID is 00d000000000000013.

In DNS, a CNAME record points your custom domain (1) to the Salesforce internal CNAME record for your org (2), which includes your
org ID. In Salesforce, your certificate is stored on a secure server (3). Salesforce uses that certificate to serve the content from your
Experience Cloud site (4).

SEE ALSO:
Custom Domains
Prerequisites for a Custom Domain That Uses Your HTTPS Certificate

612
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Serve Your Experience Cloud Site with the Salesforce Content Delivery
Network (CDN)
Optimize page load times and site performance with our content delivery network. Salesforce
EDITIONS
partners with Akamai to efficiently deliver publicly cacheable content to users on your Experience
Cloud sites. Salesforce recommends the Salesforce CDN for custom domains that serve Digital Available in: both Salesforce
Experiences, including Experiences built with Experience Cloud, Commerce, and Industries licenses. Classic and Lightning
Experience
Tip: To learn what content delivery networks are, how they work, and how they can help
you improve your Experience Cloud site’s performance and scalability, watch Improve Available in: Enterprise,
Performance and Scalability with Salesforce’s Content Delivery Network. Performance, and
Unlimited Editions. Also
available with Marketing
Content Delivery Networks (CDNs) and Salesforce Cloud Account Engagement
Optimize page load times and site performance with our content delivery network. Salesforce (Pardot) in Professional
partners with Akamai to efficiently deliver publicly cacheable content to users on your Experience Edition.
Cloud sites.
Applies to: LWR, Aura, and
Considerations for the Salesforce CDN Visualforce sites
If you host public-facing, cacheable content on your Experience Cloud sites, we recommend
that you use the Salesforce content delivery network (CDN) partner because it can greatly
improve load times.
Prerequisites for the Salesforce CDN
Before you set up a custom domain that uses the Salesforce content delivery network (CDN) partner, complete these steps.
Set Up a Custom Domain That Uses the Salesforce CDN
You can set up the Salesforce content delivery network (CDN) for your custom domain in Experience Builder, Salesforce Tabs, and
Visualforce sites. Within each production environment, you can define multiple domains in a sandbox, but only one custom domain
associated with a sandbox org can use the Salesforce CDN.
Traffic Allowances for the Salesforce CDN
Each byte of traffic that’s requested, whether it’s an image or a complex report, counts toward your content delivery network’s (CDN)
usage amount. The amount of traffic allowed over a CDN depends on the license that you purchase. Understand how to monitor
your Salesforce CDN usage and what happens if you exceed the terabyte limit.
Apex Caching on the Salesforce CDN
When you cache Apex methods on the Salesforce content delivery network (CDN), you improve performance of your LWR site, and
your customers benefit from faster page load times. Only public data from Apex methods is intended to be cached, and it’s only
cached for guest users. Apex caching controls differ depending on the type of Apex methods in your site.

SEE ALSO:
Custom Domains
Options to Serve a Custom Domain

613
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Content Delivery Networks (CDNs) and Salesforce

Optimize page load times and site performance with our content delivery network. Salesforce
EDITIONS
partners with Akamai to efficiently deliver publicly cacheable content to users on your Experience
Cloud sites. Available in: both Salesforce
Classic and Lightning
What’s a CDN? Experience

A content delivery network is a geographically distributed network of servers that store cached Available in: Enterprise,
versions of web assets. To optimize page load times and site performance, a CDN efficiently delivers Performance, and
publicly cacheable content to users. CDNs are the industry standard for web applications because Unlimited Editions. Domains
they provide faster and more secure content delivery. that use the Salesforce CDN
are also available with
All the assets used to develop your Experience Cloud sites or Salesforce Sites are stored on your Marketing Cloud Account
Salesforce instance. Your instance is stored on one Salesforce server. The farther away your users Engagement (Pardot) in
are from that server, the longer it takes to get data to their computer and your site’s pages. Professional Edition.
The CDN minimizes delays in loading web page content by reducing the distance between the Applies to: Salesforce Sites
server and the user. CDNs also increase the number of requests that the server can respond to and LWR, Aura, and
because the CDN offloads a large portion of hits to your site. By reducing the distance between the Visualforce sites
server and the user and increasing content availability and redundancy, CDNs improve website
load times and site performance.

CDN Options for Salesforce

In Salesforce, you can get the benefits of a CDN in three ways.
• Use the default Experience Cloud site domain. When you enable Experience Cloud sites, Salesforce creates a system-managed
domain for your site. If enhanced domains are enabled, the hostname for that system-managed domain ends in *.my.site.com
and that domain uses the Salesforce CDN.
Government Cloud Plus orgs can opt out of the Salesforce CDN for *.my.site.com domains. To opt out, from Setup, in the
Quick Find box, enter My Domain, and then select My Domain. Then in the Routing section, deselect Use Content Delivery
Network (CDN) by default when enhanced domains are enabled for Experience Cloud sites.

• Set up a custom domain such as https://www.example.com that serves your Experience Cloud site content with the
Salesforce CDN. This option isn’t available for registrable domains. If you have Digital Experiences, including those built with Experience
Cloud, Commerce, and Industries licenses, we recommend this option to serve your custom domain. For considerations, prerequisites,
and setup instructions, see Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN).
• Set up a custom domain such as https://www.example.com that serves content from your Experience Cloud site or
Salesforce Site with a third-party CDN outside of Salesforce. A non-Salesforce CDN is the only available option to serve a registrable
domain or Salesforce Site via a CDN. See Use a Third-Party Service or CDN to Serve Your Custom Domain.

Who Can Use the Salesforce CDN for a Custom Domain

The Salesforce CDN is available for custom domains that serve Experience Cloud sites. If you use Marketing Cloud Account Engagement
(Pardot) in a Professional Edition org, you must use the Salesforce CDN for your domains.
To get the benefits of a CDN for a domain that serves content from a Salesforce Site, use a CDN outside of Salesforce. Also, Salesforce is
unable to serve a registrable domain, such as example.com, using our CDN. We only serve subdomains, such as www.example.com
or parts.example.com. To serve your site content on a registrable domain served from a CDN, host it on a CDN outside of Salesforce.

614
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

How a CDN Works

By reducing the distance between the server and the user and increasing content availability and redundancy, CDNs improve website
load times and site performance.
This diagram illustrates this effect for the Salesforce CDN for Experience Cloud sites. The principle also applies to external CDNs.

The Salesforce CDN includes an image optimization feature that makes your site pages load faster for guest users, whether they’re viewing
your site on their phone, tablet, or desktop computer. In addition, the Salesforce CDN comes with configurable availability pages. You
can display a custom Service Not Available page when your site is down or a custom Too Many Requests page when your site is in high
demand.

Learn More
Learn more about how a CDN works in this video.

Watch a video

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)
Use a Third-Party Service or CDN to Serve Your Custom Domain

615
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Considerations for the Salesforce CDN

If you host public-facing, cacheable content on your Experience Cloud sites, we recommend that
EDITIONS
you use the Salesforce content delivery network (CDN) partner because it can greatly improve load
times. Available in: both Salesforce
Unfamiliar with terms like DNS, WAF, and CNAME? Want to review the difference between a URI Classic and Lightning
and a URL? See Custom Domain Terminology. Experience

Before you enable our CDN, keep these considerations in mind. Available in: Enterprise,
Performance, and
Unlimited Editions. Also
Recommended Option available with Marketing
The Salesforce CDN is the recommended HTTPS option for custom domains that serve Digital Cloud Account Engagement
Experiences, including Experiences built with Experience Cloud, Commerce, and Industries licenses. (Pardot) in Professional
Edition.

Supported Environments Applies to: LWR, Aura, and

Visualforce sites
In each production environment, you can define multiple sandbox custom domains, but only one
custom domain associated with a sandbox org can use the Salesforce CDN.

Supported Domain Levels and Sites

When you use our CDN, Salesforce is unable to serve a registrable domain, such as example.com. The Salesforce CDN only serves
subdomains, such as www.example.com or parts.example.com. If your site needs a registrable domain served from a CDN,
host it on a CDN outside of Salesforce.
Likewise, the Salesforce CDN is available for custom domains that serve Experience Cloud site content. To use a CDN to serve content
from your Salesforce Site, use a CDN outside of Salesforce.
See Use a Third-Party Service or CDN to Serve Your Custom Domain.

Opt Out of the Salesforce CDN

Government Cloud Plus orgs can opt out of the Salesforce CDN for your system-managed *.my.site.com domain. To opt out,
from Setup, in the Quick Find box, enter My Domain, and then select My Domain. Then in the Routing section, deselect Use Content
Delivery Network (CDN) by default when enhanced domains are enabled for Experience Cloud sites.

Activation Timing
To minimize the impact to your users, activate the Salesforce CDN when your site traffic is low.

HTTP/2 Support
The Salesforce CDN supports HTTP/2 protocols. Experience Cloud sites served through our CDN support HTTP/2 for fast content delivery.
Salesforce also provides a secure HTTPS site and certificates.

URI Size Limit

Salesforce partners with Akamai to optimize content delivery. The maximum URI size limit for the Akamai platform is 8892 bytes. This
limit allows close to 9,000 characters on the URI path. If you must exceed this amount, disable the Salesforce CDN.

616
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Provisioning a Domain for Salesforce CDN

Domain provisioning is the process of setting up and configuring a domain name on the internet. In other words, when Salesforce
provisions your custom domain, we get it ready for use. Provisioning usually takes fewer than 12 hours, but it can take up to 24 hours
to complete. After provisioning, activate your Salesforce domain to create or update the domain canonical name (CNAME). Activation
across the internet can take up to 20 minutes.
Until you activate the domain, the domain uses its previous HTTPS configuration. If you add a domain to your org using Akamai, our
CDN partner, the initial configuration before activation is HTTP.

Provisioning a Domain for a Third-Party CDN

If you use your own CDN and add a domain and provision the CDN at the same time, visitors to your site can see a certificate error. The
hostname on the certificate doesn’t match the custom domain until you activate the domain. Activating the domain resolves the error
message.
Until you activate the domain, the domain uses its previous HTTPS configuration.

Switching to the Salesforce CDN

When you change the HTTPS option on an existing domain to the Salesforce CDN, the provisioning process usually takes fewer than 12
hours, but it can take up to 24 hours. After you activate the domain, visitors to your site can see errors for up to 5 minutes:
• Connection reset errors, such as “The site doesn’t load.”
• DNS error messages like “Server DNS address couldn’t be found.”
For more information, see Change the HTTPS Option for Your Custom Domain.

Caching with the Salesforce CDN

Caching on our CDN improves your site’s performance and scale. When your users access a site served by the Salesforce CDN, cached
content is served directly from CDN servers. CDN servers are distributed globally and are often closer to your users than Salesforce servers.
Because cached content is served directly from CDN servers, your users experience faster load times routinely and in times of high traffic.
CDN caching can work with browser-side caching, which also improves performance.
The Aura, LWR, and Visualforce frameworks for building Experience Cloud sites cache content on CDN slightly differently. But no matter
which framework you use to build your site, consider caching only public content on our CDN.
Aura caches mostly static content, including Salesforce CMS content, images, javascript, CSS files, font files, and more. In comparison,
Lightning Web Runtime (LWR) is built for performance and scale, and it caches more publicly available content in addition to static
resources. In LWR, Salesforce caches base documents for a site’s pages, public data returned from Salesforce API calls, and public data
from Apex methods used internally. Admins and developers can cache their Apex methods that return public data. Get details for caching
in Visualforce sites in Configure site caching.

Single Versus Shared Server Certificates

We recommend single domain certificates over shared certificates. Shared certificates often include other customer hostnames in the
subject alternative name list. The server certificate for shared certificates also changes frequently, which can cause issues for API clients
that require the exact server certificate rather than the root certificate authority. Single certificates offer better security and a single
branded experience for your site.
Shared certificates are no longer available for new sites using the Salesforce CDN. If you have an existing custom domain on a shared
certificate, you can see a shared option while configuring our CDN. To switch from a shared certificate to a single certificate, on the

617
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Domain Edit page, select the Single certificate for content delivery network (CDN). There’s no downtime when you switch from a
shared certificate to a single certificate.
Orgs that purchase Experience Cloud licenses get 10 Experience Cloud CDN single certificates and 48 terabytes (TB) of traffic per year. If
you haven’t purchased an Experience Cloud license, your org can provision 5 single certificates and get 5 TB of annual traffic. You can
contact your account executive to increase the traffic allowances. To increase the number of certificates available per org, contact
Salesforce Customer Support.

Domain CNAME Changes

Your domain must use the same CNAME that shows on the Domains Setup page. Changing your CNAME after activating the Salesforce
CDN with a shared certificate causes your domain traffic to go directly to your servers. It no longer passes through the CDN.
If you want to resume use of the Salesforce CDN after changing your CNAME, update your domain in Salesforce to the correct CNAME.
After you update, provision the domain again with the CDN option.

Note: Don’t change single certificate domains with the _acme-challenge CNAME if the single certificate is provisioning or has
finished provisioning. If you update or delete the _acme-challenge CNAME before provisioning is complete, it can delay the
provisioning process. If it’s updated after provisioning the domain, you can have issues when the certificate is due for renewal.

CDN Changes and Single Sign-On

Changing the Salesforce CDN affects SAML Single Sign-On Settings for all custom URLs in that domain. Reconfirm the SAML Single
Sign-On Settings for each HTTPS custom URL in that domain after activating a change. Login Settings are available in Experience
Workspaces > Administration > Login & Registration.

Network-Level IP Restrictions and the Salesforce CDN

The IP addresses used by the Salesforce CDN partner, Akamai, aren’t published. Therefore, if your network settings include IP allowlisting,
users can lose access to your site that uses the Salesforce CDN. For example, if your users log in via a VPN that exclusively uses IP allowlisting,
the users on that VPN can’t access your site because the site uses an Akamai IP address.
To ensure that your users can access your site on the Salesforce CDN, allowlist your site’s domain. Either add the domain (not the IP
address) to your VPN’s allowlists, or configure your network-level allowlists via another method that supports domain-based allowlists,
such as a firewall.

Data Privacy & Security

When you enable the Salesforce CDN, your domain uses our partner, Akamai, for optimized content delivery. Information sent to or
returned by the domain is stored and transmitted by Akamai. For Aura sites, cached content includes static content such as HTML pages,
javascript and CSS files, images, and font files.
For LWR sites, cached content includes static content and other publicly cacheable content. Where appropriate, Salesforce caches public
content from APIs and Apex methods in standard pages and components. Admins and developers can control caching of Apex methods
that use @wire invocation in LWC for their guest users. Only Apex methods annotated with @AuraEnabled(cacheable=true scope=’global’)
are cached. Caching public data from annotated Apex methods in managed packages is enabled by default. To disable this preference,
go to Experience Workspaces > Administration > Preferences and deselect Cache public data from Apex methods in Managed
Packages.
Akamai manages privacy and security protections for data that is shared. All communications between Akamai and Salesforce are
conducted over HTTPs.
Akamai supports IPv6. If IP restrictions are configured in Salesforce with only IPv4 addresses, users can see an error when they access
your site that ends in *.my.site.com via IPv6. To prevent that error, update your IP allowlists or restrictions to allow IPv6 source

618
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

addresses for authorized users. In particular, review and update the login IP range restrictions for the relevant profiles, including the site’s
guest user profile. For more information on setting IP restrictions for Salesforce, see Network Access, Session Settings, and Profile-based
IP restrictions.

Image Optimization
The Salesforce CDN includes an image optimization feature that makes your site’s pages load faster for guest users, whether they’re
viewing your site on their phone, tablet, or desktop computer. The image optimization setting is enabled by default for sites that use
the Salesforce CDN. To disable this preference, go to Experience Workspaces > Administration > Preferences and uncheck Optimize
cached images for guest users on all devices.

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)

Prerequisites for the Salesforce CDN

Before you set up a custom domain that uses the Salesforce content delivery network (CDN) partner,
EDITIONS
complete these steps.

Tip: To learn what content delivery networks are, how they work, and how they can help Available in: both Salesforce
Classic and Lightning
you improve your Experience Cloud site’s performance and scalability, watch Improve
Experience
Performance and Scalability with Salesforce’s Content Delivery Network.
Available in: Enterprise,
Unfamiliar with terms like DNS, CAA, and CNAME? See Custom Domain Terminology.
Performance, and
Be sure to read the Considerations for Using a CDN for Your Experience Cloud Site. Unlimited Editions. Also
available with Marketing
Cloud Account Engagement
Verify the Canonical Name (CNAME) Records for Your Domain (Pardot) in Professional
Before you can set up your custom domain with the Salesforce CDN, update DNS to include the Edition.
required canonical name (CNAME) records for your domain and the _acme-challenge subdomain.
Applies to: LWR, Aura, and
See Point Your Custom Domain to Your Org.
Visualforce sites

Manage Certificate Authority Authorization (CAA) Records

The Salesforce CDN uses Let’s Encrypt as its certificate authority. Before you set up our CDN for your domain:
• If your domain doesn’t have a current Certification Authority Authorization (CAA) record, leave it as is.
• If your domain or the subdomain has a CAA record, add letsencrypt.org to the record.
• If your company decides to set up a CAA record in the future, add letsencrypt.org to the record to avoid disruption to your
CDN.
For more information, see the Let’s Encrypt website.

Note: Let’s Encrypt requires consent from the owner of high-value domains before allowing a CAA certificate change for those
domains. The list of high-value domains isn’t publicly available. If your domain is on the list of high-value domains, contact Let’s
Encrypt to temporarily remove the block before configuring the Salesforce CDN. If your CDN request fails or it remains in a status
of provisioning for more than a day, contact Salesforce Customer Support for assistance.

619
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Use an Existing External Domain

Salesforce partners with Akamai to optimize our content delivery network. If you have an existing domain hosted outside of Salesforce,
such as www.example.com, and that domain isn’t currently registered with Akamai, moving to the Salesforce CDN is a two-step
process. First, set up a custom domain that points to Akamai as a third-party CDN. See Use a Third-Party Service or CDN to Serve Your
Custom Domain.
Then, after you activate the custom domain and your domain successfully serves content from your Experience Cloud site, change the
HTTPS option for that custom domain to the Salesforce CDN.

Use an Existing Akamai Domain

If you have a registered domain with Akamai that you intend to use for the Salesforce CDN, remove the domain from your Akamai
configuration. If the domain is active in another Akamai configuration, the provisioning process for our CDN fails.
Notify Akamai if you have a wildcard domain available in a different Akamai configuration and intend to use one of its subdomains for
your Salesforce CDN.
For example, you added *.example.com as a wildcard in your Akamai configuration, and you want to add
experiences.abccompany.com as a custom domain that uses the Salesforce CDN. Notify Akamai before you provision the
custom domain in Salesforce. Otherwise, initial provisioning fails, and your move to the CDN is delayed as Akamai contacts you to validate
the change.

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)
View and Edit Single Sign-On Settings

Set Up a Custom Domain That Uses the Salesforce CDN

USER PERMISSIONS EDITIONS

To create an Experience Cloud site: Create and Set Up Experiences AND View Available in: both Salesforce
Setup and Configuration Classic and Lightning
Experience
To customize an Experience Cloud site: Be a member of the site AND Create and Set
Up Experiences Available in: Enterprise,
Performance, and
OR Unlimited Editions. Also
Be a member of the site AND an experience available with Marketing
admin, publisher, or builder in that site Cloud Account Engagement
(Pardot) in Professional
To publish an Experience Cloud site: Edition.
Be a member of the site AND Create and Set
Up Experiences Applies to: LWR, Aura, and
OR Visualforce sites

Be a member of the site AND an experience

admin or publisher in that site

To add a domain: Customize Application

OR

620
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

View Setup and Configuration plus either a Site.com Publisher

license or Create and Set Up Experiences

To edit a domain: Customize Application

To add, edit, and delete custom URLs: Customize Application

OR
View Setup and Configuration AND either Create and Set Up
Experiences OR a Site.com Publisher license

You can set up the Salesforce content delivery network (CDN) for your custom domain in Experience Builder, Salesforce Tabs, and
Visualforce sites. Within each production environment, you can define multiple domains in a sandbox, but only one custom domain
associated with a sandbox org can use the Salesforce CDN.
Before you add a custom domain that serves your Experience Cloud site with the Salesforce CDN, review these important considerations.
• To minimize disruption for your users, provision and activate our CDN when your site traffic is low.
• To create or activate a custom domain for testing in a sandbox, log in to the production org that owns the sandbox and go to the
Domains Setup page.
• With this option, Salesforce hosts your domain with the Salesforce CDN partner, Akamai. If a third party hosts your domain or if you
use a third-party CDN or a web-application firewall (WAF), see Use a Third-Party Service or CDN to Serve Your Custom Domain.
• If you have an existing domain hosted outside of Salesforce, such as www.example.com, and that domain isn’t currently registered
with the Salesforce CDN partner, Akamai, moving to the Salesforce CDN is a two-step process. First, set up a custom domain that
points to Akamai as a third-party CDN. See Use a Third-Party Service or CDN to Serve Your Custom Domain. Then change the HTTPS
option for that custom domain to the Salesforce CDN.
• This option is unavailable for Salesforce Sites and for registrable domains, such as example.com without the www subdomain. To
serve a registrable domain or a Salesforce Site with a CDN, see Use a Third-Party Service or CDN to Serve Your Custom Domain.
Before you activate this feature, read the considerations and complete the prerequisites for the Salesforce CDN. Then complete the
custom domain prerequisites.
1. On your DNS provider’s site, verify that the two required canonical name (CNAME) records exist for your domain and the
_acme-challenge subdomain. See Point Your Custom Domain to Your Salesforce Org.
2. From Setup, in the Quick Find box, enter Domains, and then select Domains.
3. Click Add a Domain.
4. Enter the domain name.
Salesforce validates ownership based on the fully qualified domain name (FQDN) that you enter when you add a domain to your
org. If you get an error message, point your custom domain to your org, and then wait for the changes to propagate. After you
update your domain’s DNS record, it can take up to 20 hours for that change to take effect worldwide.

5. For HTTPS Option, select Serve the domain with the Salesforce Content Delivery Network (CDN).
With this option, your domain uses a single certificate, which displays only one host name. Ten branded certificates and 48 terabytes
of traffic per year are available for Experience Cloud licenses that adopt a single certificate CDN. If you need more certificates, contact
your account representative.
Here’s the Domain page when you select this HTTPS option.

621
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

The top of the page includes your 18-digit org ID and the format for the CNAME in DNS to point your domain to your org (1). When
you select the option to serve your domain with the Salesforce CDN, additional guidance includes the targets for both CNAME
records in DNS (2). Replace [domain] with your domain name, such as www.example.com.

6. To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your
domain, select Allow HSTS preloading registration.
This setting adds the preload directive to the HSTS header. After you enable this setting, submit your domain at https://hstspreload.org.
For more information, see Enable HSTS Preloading on a Custom Domain.

7. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to serve the sites in your production org, select Production. Or select a sandbox where you want to test this custom
domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

8. Save your domain.

After you save your new domain, Salesforce provisions the domain or gets it ready to be used. The Salesforce CDN provisioning
process can take 4–14 hours. When that process is complete, the domain’s status on the Domains Setup page changes from
Provisioning to Awaiting Activation and you receive an email.

622
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Newly created custom domains use HTTP, not HTTPS, until you activate the domain.

9. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.

Note: Custom domains in a sandbox are edited and activated in production.

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed, and the Current HTTPS Option changes to Content Delivery Network
(CDN) Partner of Salesforce.

10. To serve your sites via your activated domain, add a custom URL.

Note: For your domain to serve your site, at least one custom URL is required.

Changing the Salesforce CDN affects SAML Single Sign-On Settings for all custom URLs in that domain. Reconfirm the SAML Single
Sign-On Settings for each HTTPS custom URL in that domain after activating a change. Login Settings are available in Experience
Workspaces > Administration > Login & Registration.

This diagram shows the routing of traffic when Salesforce serves your custom domain with the Salesforce CDN. Dotted lines ( )
represent DNS configurations, and the solid line ( ) represents user traffic flow through HTTPS. The gray lines represent traffic
that originates outside Salesforce, and the blue line represents traffic that originates in Salesforce. In this example, the domain name is
www.example.com and the 18-digit org ID is 00d000000000000013.

With your DNS provider, you point your custom domain (1) to the Salesforce internal CNAME (2), which includes your org ID. Within
Salesforce, user traffic is routed to the Salesforce CDN partner (3), which acts as an intermediary for your Salesforce content (4).

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)
View and Edit Single Sign-On Settings

623
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Traffic Allowances for the Salesforce CDN

Each byte of traffic that’s requested, whether it’s an image or a complex report, counts toward your
EDITIONS
content delivery network’s (CDN) usage amount. The amount of traffic allowed over a CDN depends
on the license that you purchase. Understand how to monitor your Salesforce CDN usage and what Available in: both Salesforce
happens if you exceed the terabyte limit. Classic and Lightning
Within each production environment, you can define multiple domains in a sandbox, but only one Experience
custom domain associated with a sandbox org can use the Salesforce CDN.
Available in: Enterprise,
Performance, and
Traffic Allowances by License Type Unlimited Editions. Also
available with Marketing
If you have any of these items, you’re entitled to 48 terabytes of traffic per year and 10 single domain Cloud Account Engagement
certificates. (Pardot) in Professional
• Salesforce CMS, Commerce Apps, or External Apps Edition.
• A Customer Community license, a Customer Community Plus license, or a Partner Community Applies to: LWR, Aura, and
license Visualforce sites
If you require more traffic for your org, contact your account representative to purchase additional
terabytes. If you exceed the traffic allowance, a representative contacts you to discuss purchasing
more terabytes for your business needs. To request more single certificates, you can log a ticket with Salesforce Customer Support.

Note: If you exceed the traffic limit, we don’t shut down your site or move remove your domain from our CDN.

CDN Usage Reports

You can use two reports to check your Salesforce CDN usage. A CDN Usage report is part of the Experience Management Package found
in AppExchange. You can also create a custom report type with Domains as the primary object.
If you need help with managing your usage, contact Salesforce Customer Support.

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)
Create a Custom Report Type

624
Extend Salesforce with Clicks, Not Code Serve Your Experience Cloud Site with the Salesforce Content
Delivery Network (CDN)

Apex Caching on the Salesforce CDN

When you cache Apex methods on the Salesforce content delivery network (CDN), you improve
EDITIONS
performance of your LWR site, and your customers benefit from faster page load times. Only public
data from Apex methods is intended to be cached, and it’s only cached for guest users. Apex caching Available in: both Salesforce
controls differ depending on the type of Apex methods in your site. Classic and Lightning
For Apex methods that you own, enable caching by using caching annotation. Annotate your Apex Experience
methods with @AuraEnabled(cacheable=true scope=’global’). And use @wire (LWC) to invoke
Available in: Enterprise,
publicly cacheable Apex actions. To avoid caching private data, annotate only Apex methods that Performance, and
return public data. Learn more about caching annotation in our developer guides. Unlimited Editions. Also
• Wire Apex Methods to Lightning Web Components available with Marketing
Cloud Account Engagement
• AuraEnabled Annotation
(Pardot) in Professional
• Call Apex Methods Imperatively Edition.
If your site uses managed packages, caching data from Apex methods in those packages is enabled
Applies to: LWR, Aura, and
by default. To disable it, deselect Cache public data from Apex methods in Managed Packages
Visualforce sites
in Workspaces | Administration | Preferences.

Important: Only Apex methods that were annotated for caching in the managed packages get cached. If the Apex methods in
the managed packages aren’t annotated, they don’t get cached even when the preference is enabled.
Salesforce controls caching of Apex methods used on standard pages and components, and caches it where appropriate.

SEE ALSO:
Custom Domains
Serve Your Experience Cloud Site with the Salesforce Content Delivery Network (CDN)

625
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Use a Third-Party Service or CDN to Serve Your Custom Domain

Use a domain that’s hosted by a third-party service to serve your Experience Cloud sites or Salesforce
EDITIONS
Sites. These third-party services include third-party hosts, web application firewalls (WAFs), and
non-Salesforce content delivery networks (CDNs). Available in: both Salesforce
Classic and Lightning
Considerations for Custom Domains That Use a Third-Party Service or CDN Experience
Review how IP address tracking works when a third party serves your custom domain. Understand Available in: Enterprise,
what happens if you update your domain’s external configuration after you activate the domain Performance, and
in Salesforce, and clean up unnecessary Domain Name Service (DNS) records. Unlimited Editions. Domains
Prerequisites for a Custom Domain That Uses a Third-Party Service or CDN that use the Salesforce CDN
are also available with
If a non-Salesforce service or content delivery network (CDN) serves your domain, complete
Marketing Cloud Account
these steps before you add your domain in Salesforce. To confirm your domain ownership,
Engagement (Pardot) in
update your domain’s Domain Name Service (DNS) configuration. Then work with the third-party
Professional Edition.
provider to configure caching and request handling, and review reverse proxy restrictions. If
you’re using a third-party CDN, update the header in your CDN to track IP addresses. Applies to: Salesforce Sites
and LWR, Aura, and
Set Up a Custom Domain That Uses a Third-Party Service or CDN
Visualforce sites
Add a domain in Salesforce that’s hosted by a non-Salesforce service or content delivery network
(CDN). After you set up your domain in Salesforce, that domain can serve your Experience Cloud
sites or Salesforce Sites.

SEE ALSO:
Custom Domains
Options to Serve a Custom Domain

Considerations for Custom Domains That Use a Third-Party Service or CDN

Review how IP address tracking works when a third party serves your custom domain. Understand
EDITIONS
what happens if you update your domain’s external configuration after you activate the domain in
Salesforce, and clean up unnecessary Domain Name Service (DNS) records. Available in: both Salesforce
Tip: Unfamiliar with terms like DNS, WAF, and CNAME? Want to review the difference between Classic and Lightning
Experience
a DNS resolver and a certificate? See Custom Domain Terminology.
Available in: Enterprise,
Performance, and
IP Address Tracking and Restrictions
Unlimited Editions. Domains
When you use a third party to serve your domain, Salesforce uses and logs the source IP address that use the Salesforce CDN
from the TCP/IP connection to Salesforce. are also available with
Marketing Cloud Account
The True-Client-IP request header is used for location-targeting features within an Experience
Engagement (Pardot) in
Cloud site. If you use an external content delivery network (CDN) and location-based audience
Professional Edition.
targeting in Experience Cloud, set this header in your CDN. For more information, see Prerequisites
for a Custom Domain That Uses a Third-Party Service or CDN. Applies to: Salesforce Sites
and LWR, Aura, and
IP restrictions at the profile level ignore the True-Client-IP request header for custom
Visualforce sites
domains served by an external service or CDN. To restrict your guest users’ access to valid IP addresses
for your custom domain, set the profile-level IP restrictions to allow only the IP addresses for your
CDN or reverse-proxy server. For example, allow the addresses that your CDN uses to connect to
Salesforce.

626
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Other source IP address request headers, such as the X-Forwarded-For (XFF) request header, are ignored. As a result, you can't
pass the original source IP address to Salesforce for use with profile IP range restrictions, login history source IP addresses, and event log
lines.

Changes After Domain Activation

Salesforce validates that your domain points to your org when you add or view your domain in Salesforce. If you update your proxy, web
application firewall (WAF), CDN, or the third-party settings after you activate the domain, that change happens outside Salesforce. As a
result, Salesforce continues to serve the domain as if it uses HTTPS, even if the third-party configuration doesn’t have a valid HTTPS
certificate for your custom domain. In this situation, your custom domain can experience disruption.
If you suspect this cause for a disruption, view your custom domain details to validate that your domain points to your org.

DNS Records to Validate Domain Ownership

When you add your domain, Salesforce checks DNS to validate that you own the domain. To pass this verification, you add a canonical
name (CNAME) or text (TXT) record for your domain in DNS. After you configure your domain that uses a third-party service or CDN, you
can delete the TXT or CNAME record. Deleting unnecessary DNS records can improve performance. Optionally, to make it easier to switch
to another HTTPS option in the future, you can keep the CNAME record in DNS. If you choose to keep the record, check with your
third-party provider to ensure that their services are supported with that configuration.

SEE ALSO:
Custom Domains
Prerequisites for a Custom Domain That Uses a Third-Party Service or CDN
Set Up a Custom Domain That Uses a Third-Party Service or CDN
View Your Custom Domain Details

627
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Prerequisites for a Custom Domain That Uses a Third-Party Service or CDN

If a non-Salesforce service or content delivery network (CDN) serves your domain, complete these
EDITIONS
steps before you add your domain in Salesforce. To confirm your domain ownership, update your
domain’s Domain Name Service (DNS) configuration. Then work with the third-party provider to Available in: both Salesforce
configure caching and request handling, and review reverse proxy restrictions. If you’re using a Classic and Lightning
third-party CDN, update the header in your CDN to track IP addresses. Experience
Tip: Unfamiliar with terms like DNS, CNAME, and proxy server? See Custom Domain Available in: Enterprise,
Terminology. Performance, and
Unlimited Editions. Domains
that use the Salesforce CDN
Update Your Domain’s DNS configuration are also available with
When you add a custom domain, Salesforce checks DNS to verify that you own the domain. Before Marketing Cloud Account
you set up your custom domain that uses a third-party service or CDN, update DNS to include the Engagement (Pardot) in
required canonical name (CNAME) or text (TXT) record for your domain. Professional Edition.

• If your domain has an existing A, AAAA, or CNAME record, you can’t add a CNAME record. Applies to: Salesforce Sites
Instead, use a TXT record in DNS to set up a temporary non-HTTPS domain. See Use a Temporary and LWR, Aura, and
Non-HTTPS Domain to Serve Your Custom Domain. Visualforce sites
• Otherwise, add a CNAME record in DNS that points to your org’s *.live.siteforce.com
CNAME. See Point Your Custom Domain to Your Org. USER PERMISSIONS
After you configure your domain that uses a third-party service or CDN, you can delete the TXT or
To view a domain:
CNAME record. Deleting unnecessary DNS records can improve performance. Optionally, to make
• View Setup and
it easier to switch to another HTTPS option in the future, you can keep the CNAME record in DNS.
Configuration
If you choose to keep the record, check with your third-party provider to ensure that their services
are supported with that configuration.

Caching
When caching responses, your CDN must honor the Salesforce Cache-Control response header. Specifically, ensure that your CDN
follows these rules when it operates as a reverse-proxy server.
• Your CDN caches responses only when public exists in the Salesforce Cache-Control response header.
• If private, no-store, or no-cache exists in the Salesforce Cache-Control response header, the CDN doesn’t cache
that response.
• To determine the cache duration, the CDN uses s-maxage, if present in the Salesforce Cache-Control response header. If s-maxage
isn’t present, then the CDN uses max-age. The CDN never increases the cache duration, regardless of whether it’s derived from
s-maxage or max-age.

Request Configuration: Host HTTP Header

To serve your custom domain with a third-party service or CDN, configure your proxy or CDN service so that the requests sent to Salesforce
contain the originally requested Host HTTP header. In other words, ensure that your custom domain name—the domain that users
see in their original web browser request—is the Host HTTP header value in requests sent to Salesforce.

URL Paths in Requests

Ensure that your third-party service or CDN processes requests without decoding the path of the requested URLs. For example, if the
path includes %2F, Salesforce requires that the URL includes %2F, not the decoded ASCII value, /.

628
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Point Your Custom Domain to Your Org with Your Target Hostname
To point your custom domain that uses a third-party service or CDN to your org, the third-party uses a target hostname. A target hostname
is the hostname to which your proxy or CDN forwards requests to your custom domain. In other words, the target hostname is how your
third-party service or CDN delivers content from your sites in Salesforce.
To get the target hostname to provide to your third-party service or CDN, go to the Domain page in Setup. From Setup, in the Quick
Find box, enter Domains, select Domains, and then click Add Domain.

When you select Use a third-party service or CDN to serve the domain, your target hostname is included in the guidance for that
HTTPS option.

Note: Ensure that when your proxy or CDN service processes an incoming request without a cached response, the service forwards
the request to your custom domain’s target hostname using HTTPS.
If enhanced domains are enabled, forward your proxy or CDN requests to these hostnames based on your configuration.

Salesforce Edge Network Target Hostname

Yes If your org is on Hyperforce, the hostname of your instanced URL, in the format
InstanceName.sfdc-HyperforceInstanceName.salesforce.com.
• Hyperforce production org example: usa12.sfdc-ypmv18.salesforce.com
• Hyperforce sandbox example: usa20s.sfdc-lywfpd.salesforce.com

629
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Salesforce Edge Network Target Hostname

If your org isn’t on Hyperforce, your instanced URL, in the format
InstanceName.salesforce.com.
• Production org example: na87.salesforce.com
• Sandbox example: cs34.salesforce.com

No The hostname of your org’s My Domain login URL, ending in my.salesforce.com.

• Production org example: MyDomainName.my.salesforce.com
• Sandbox example:
MyDomainName--SandboxName.sandbox.my.salesforce.com

If enhanced domains aren’t enabled, forward your proxy or CDN requests to these hostnames, based on your configuration.

Experience Salesforce Target Hostname

Cloud sites Sites
Yes Yes or no Your Experience Cloud site’s force.com subdomain.
• Production org example: ExperienceCloudSitesSubdomain.force.com
• Sandbox example:
SandboxName-ExperienceCloudSitesSubdomainName.InstanceName.force.com

No Yes Your Salesforce Site’s secure.force.com subdomain or force.com subdomain.

• Production org example: SalesforceSitesSubdomain.secure.force.com
• Sandbox example:
SandboxName-SalesforceSitesSubdomain.InstanceName.force.com

No No Your org’s instanced URL, in the format InstanceName.force.com.

• Production org example: na87.force.com
• Sandbox example: cs34.force.com

As an example, let’s say that a non-Salesforce CDN serves your custom domain, www.example.com. When a web browser requests
https://www.example.com/hello/world, your CDN sends the request to Salesforce at
https://MyDomainName.my.salesforce.com/hello/world while setting the Host header to www.example.com.
Salesforce then processes the request at MyDomainName.my.salesforce.com as a request for www.example.com with
a path of /hello/world. If the Host header isn’t set to your custom domain, www.example.com, then Salesforce can’t process
the request properly.

Reverse Proxy Restrictions

A reverse proxy is a type of proxy server used to direct client requests to the server that provides the requested resource. Because reverse
proxies can increase scalability, performance, resilience, and security, large websites and CDNs often use reverse proxies as part of their
load-balancing techniques.

630
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

To ensure that traffic is routed to the correct site URL, we recommend that your third-party service or CDN’s reverse proxy server forward
the full root-relative path of your site. For example, when delivering resources from
https://MyDomainName.my.site.com/store/sales, the service or CDN’s reverse proxy server passes /store/sales,
not the relative path /sales. Otherwise, some pages and features can load resources from paths outside of a site’s prefix.
If your third-party service or CDN declines to forward the full root-relative path for all requests, we strongly recommend that you test
your custom domain for any resulting issues. During testing, identify the places where resources are incorrectly loaded. Then work with
your third-party service or CDN to update their reverse proxy server to correctly handle those requests.

Configure Your CDN to Pass the Origin IP Address

If you use an external CDN and location-based audience targeting in Experience Cloud, set the True-Client-IP HTTP header in
your external CDN. Without this header, audience targeting can return unexpected results.
If you use an external CDN and you use IP restrictions for location-based audience targeting in Experience Cloud, set the
True-Client-IP header in your external CDN. This setting helps to pass the IP address of the original client back to Salesforce.
Without this header, calls to your site and audience targeting can return unexpected results. For more information about IP address
tracking and restrictions with a custom domain, see Considerations for Custom Domains That Use a Third-Party Service or CDN.
For help with setting the True-Client-IP header, including any additional recommended settings to protect you against address
spoofing, refer to your CDN provider documentation.

SEE ALSO:
Custom Domains
Considerations for Custom Domains That Use a Third-Party Service or CDN
Set Up a Custom Domain That Uses a Third-Party Service or CDN

631
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Set Up a Custom Domain That Uses a Third-Party Service or CDN

Add a domain in Salesforce that’s hosted by a non-Salesforce service or content delivery network
EDITIONS
(CDN). After you set up your domain in Salesforce, that domain can serve your Experience Cloud
sites or Salesforce Sites. Available in: both Salesforce
Tip: Unfamiliar with terms like DNS, CNAME, and proxy server? See Custom Domain Classic and Lightning
Experience
Terminology.
Before you add a custom domain that’s hosted by a third-party service or CDN, review these Available in: Enterprise,
important considerations. Performance, and
Unlimited Editions. Domains
• With this option, a third-party service or CDN hosts your domain. To use the recommended that use the Salesforce CDN
CDN for Digital Experiences, see Serve Your Experience Cloud Site with the Salesforce Content are also available with
Delivery Network (CDN). To use an HTTPS certificate that you own to serve your custom domain Marketing Cloud Account
on Salesforce servers, see Serve a Custom Domain with Your HTTPS Certificate on Salesforce Engagement (Pardot) in
Servers. Professional Edition.
• To create or activate a custom domain for testing in a sandbox, log in to the production org Applies to: Salesforce Sites
that owns the sandbox, and then go to the Domains Setup page. and LWR, Aura, and
• To minimize disruption for your users, provision and activate your custom domain when your Visualforce sites
site traffic is low.
Before you add your domain in Salesforce, review the considerations for this option, and then USER PERMISSIONS
complete the custom domain prerequisites.
To view a domain:
1. Complete the prerequisites for this option.
• View Setup and
2. From Setup, in the Quick Find box, enter Domains, and then select Domains. Configuration
3. Click Add a Domain. To add a domain:
• Customize Application
4. Enter the domain name.
OR
Salesforce validates ownership based on the fully qualified domain name (FQDN) that you enter
when you add a domain to your org. If you get an error message, point your custom domain View Setup and
to your org, and then wait for the changes to propagate. After you update your domain’s DNS Configuration plus either
a Site.com Publisher
record, it can take up to 20 hours for that change to take effect worldwide.
license or Create and Set
5. For HTTPS Option, select Use a third-party service or CDN to serve the domain. Up Experiences

Here’s the Domain page when you select the HTTPS option to use a third-party service or CDN To edit or delete a domain:
to serve the domain. • Customize Application
To add, edit, and delete
custom URLs:
• Customize Application
OR
View Setup and
Configuration AND either
Create and Set Up
Experiences OR a
Site.com Publisher
license

632
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

6. Enter your external hostname.

If you’re hosting the domain yourself, specify the public hostname of your host. Typically, the third-party CDN service has a unique
canonical name (CNAME). Specify this hostname in the external hostname field in your domain configuration.

Warning: Double check the public hostname in the external hostname field. If the hostname is misspelled or if you don’t
control the DNS record or the service of the specified hostname, an attacker can potentially take over the live service of the
custom domain.
For example, assume that a third-party CDN serves your custom domain www.example.com and that the corresponding
external hostname is cdn.example.com. If you mistakenly enter cdn.exmple.com as the external hostname, an
attacker can register exmple.com and use that incorrect domain to serve content on your custom domain.
For steps that you can take to help prevent domain takeovers, see Maintain Your Custom Domain in Salesforce Help.

7. To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your
domain, select Allow HSTS preloading registration.
This setting adds the preload directive to the HSTS header. After you enable this setting, submit your domain at https://hstspreload.org.
For more information, see Enable HSTS Preloading on a Custom Domain.

8. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to serve the sites in your production org, select Production. Or select a sandbox where you want to test this custom
domain.

633
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

9. Save your domain.

After you save your custom domain, Salesforce provisions the domain or gets it ready to be used. The provisioning process can take
4–14 hours. During provisioning, your site can be inaccessible.
When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you receive
an email.
Newly created custom domains use HTTP, not HTTPS, until you activate the domain.

10. Delete the CNAME record that you added in DNS to verify that you own the domain.
Deleting unnecessary DNS records can improve performance. Optionally, to make it easier to switch to another HTTPS option in the
future, you can skip this step. Before you choose to keep the CNAME record, check with your third-party provider to ensure that their
services are supported with that configuration.

11. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.

Note: Custom domains for a sandbox are edited and activated in production.

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed and the Current HTTPS Option changes to Domain is served by an external
host.

12. To serve your sites via your activated domain, add a custom URL.
13. If the domain only has legacy Site.com custom URLs unrelated to Experience Cloud sites, manually publish the affected Site.com
sites via the Site.com Studio to implement the changes.
If at least one Experience Cloud site or a Salesforce Site exists on the same domain as a legacy Site.com site related to an Experience
Cloud site, the changes are automatically published on that domain. For more ways to configure custom domains, see Options to
Serve a Custom Domain.

This diagram shows the routing of traffic when a third-party service or CDN serves content from your Experience Cloud site on your
custom domain. In this example, the domain name is www.example.com, the 18-digit org ID is 00d000000000000013, and the org’s
target hostname is usa00.sfdc-xx18.salesforce.com.
The dashed line ( ) represents the configuration that points your domain to your third-party service or CDN. The dotted line
( ) represents routing through DNS, and the solid lines ( ) represent user traffic flow through HTTPS. The gray lines represent
traffic that originates outside Salesforce, and the blue lines represent traffic that originates in Salesforce.

634
Extend Salesforce with Clicks, Not Code Use a Third-Party Service or CDN to Serve Your Custom
Domain

Your custom domain (1) points to the third-party service or CDN (2). For example, you point your custom domain to the third party in
DNS, or you set up a web application filter (WAF) as a proxy.
The Salesforce CNAME (3) uses the external hostname of the domain in Salesforce to point to your non-Salesforce service or CDN (2). In
the third-party service or CDN, the configuration points to your org’s target hostname (4). To identify the domain and serve content from
your site (5), Salesforce uses the value passed in the Host HTTP Header of the request from the third-party service or CDN.

SEE ALSO:
Custom Domains
Considerations for Custom Domains That Use a Third-Party Service or CDN
Prerequisites for a Custom Domain That Uses a Third-Party Service or CDN
Maintain Your Custom Domain

635
Extend Salesforce with Clicks, Not Code Use a Temporary Non-HTTPS Domain to Serve Your Custom
Domain

Use a Temporary Non-HTTPS Domain to Serve Your Custom Domain

Salesforce requires that you serve your custom domain via HTTPS. However, some configuration
EDITIONS
steps can require a temporary non-HTTPS configuration. If your HTTPS certificate isn’t ready to be
uploaded to Salesforce, you can use a temporary domain to start configuring your custom URLs. Available in: both Salesforce
Also, when your domain serves other content, or when you want to move a custom domain to a Classic and Lightning
new production org, you can use a temporary domain to minimize disruption to your domain. Experience
Tip: Unfamiliar with terms like DNS, CNAME, and FQDN? See Custom Domain Terminology. Available in: Enterprise,
Performance, and
Before you set up a temporary non-HTTPS domain, complete the custom domain prerequisites. Unlimited Editions. Domains
The steps to point your domain to your Salesforce org are included in this topic. that use the Salesforce CDN
Note: This option is a temporary configuration. When your custom domain is served via are also available with
Marketing Cloud Account
HTTP, users who attempt to access your custom domain via HTTPS can see a certificate
Engagement (Pardot) in
mismatch error and experience a connection timeout.
Professional Edition.
1. Determine how to serve your domain with HTTPS after you complete the steps that require a
temporary non-HTTPS domain. See Determine How to Serve Your Custom Domain. Applies to: Salesforce Sites
and LWR, Aura, and
2. If your fully qualified domain name (FQDN) doesn’t have an existing an A, AAAA, or CNAME Visualforce sites
record in DNS, add a CNAME record that points to your internal Salesforce CNAME.
Work with your DNS provider to complete this step. See Point Your Custom Domain to Your
USER PERMISSIONS
Salesforce Org.
To view a domain:
3. If an A, AAAA, or CNAME record exists for your FQDN in DNS, add a TXT record in DNS for your
• View Setup and
FQDN that equals your 18-character org ID.
Configuration
Work with your DNS provider to complete this step. To add a domain:
When you add a domain in Salesforce, we verify that the DNS record for the domain points to • Customize Application
your org. Normally, to point your domain to your org, you add a canonical name (CNAME) OR
record in DNS. However, there’s a catch. Your domain’s DNS record points to your current service
View Setup and
or server, either through an A or AAAA (address) record that points to an IP address or through Configuration plus either
an existing CNAME record. A DNS record can’t contain a CNAME record and an A or AAAA a Site.com Publisher
record. Also a DNS record can’t contain two CNAME records for the same name. So you can’t license or Create and Set
add the required CNAME record to point to your internal Salesforce CNAME. And removing or Up Experiences
updating the existing pointers in DNS disrupts your website until you set up and activate the
To edit or delete a domain:
domain in your org.
• Customize Application
In these situations, the method to verify that you own the domain varies based on your current
To add, edit, and delete
configuration. custom URLs:
a. If your FQDN points to another service or server with A or AAAA records in DNS, add a TXT • Customize Application
record to your FQDN in DNS that equals your 18-character org ID. OR
View Setup and
Configuration AND either
Create and Set Up
Experiences OR a
Site.com Publisher
license

636
Extend Salesforce with Clicks, Not Code Use a Temporary Non-HTTPS Domain to Serve Your Custom
Domain

Here’s an example of a DNS TXT record for www.example.com that contains an org ID.
Name TTL CLASS TYPE VALUE
--------------------------------------------------------------------
www.example.com. 600 IN TXT "00d000000000000map"

b. If your FQDN points to another service or server with a CNAME record, add a TXT record for a parent domain.
For example, if your org ID is 00d000000000000map, to add www.example.com, add a TXT record for the parent domain
example.com in DNS.

Name TTL CLASS TYPE VALUE

--------------------------------------------------------------------
example.com. 600 IN TXT "00d000000000000map"

In this example, example.com is a registrable domain without the www subdomain. You can’t set a CNAME record on a
registrable domain because of a DNS limitation, but you can add a TXT record. This TXT record is a temporary configuration. For
more information about serving your sites with a registrable domain, see Custom Domain Prerequisites.

4. From Setup, in the Quick Find box, enter Domains, and then select Domains.
5. Click Add a Domain.
6. For Domain Name, enter the FQDN that matches the TXT record that you added in DNS.
Salesforce validates that the domain points to your org via the TXT message.
For example, if you added a TXT record in DNS for example.com a parent domain of www.example.com, enter
example.com.

7. For HTTPS Option, select Use a temporary non-HTTPS domain.

8. For Associated Org, select the org from which you want this custom domain to serve site content.

637
Extend Salesforce with Clicks, Not Code Use a Temporary Non-HTTPS Domain to Serve Your Custom
Domain

For example, to create a temporary custom domain in your production org, select Production. Or select a sandbox where you want
to test this custom domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

9. Save your domain.

After you save your new domain, Salesforce provisions the domain or gets it ready to be used. Provisioning can take up to 8 hours.
During provisioning, your site can be inaccessible and your site visitors can experience errors.
When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you receive
an email.

10. To configure your domain to serve your sites, add a custom URL.
When you add the first custom URL for your domain, Salesforce provisions the domain or gets it ready to be used. The provisioning
process can take up to 8 hours. During provisioning, your site can be inaccessible and your site visitors can experience errors.
When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you receive
an email.

11. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.

Note: Custom domains for a sandbox are edited and activated in production.

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed and the Current HTTPS Option changes to No HTTPS (Temporary).

12. If you added a parent domain, add another temporary non-HTTPS domain for your FQDN that points to another service or server
with a CNAME record.
a. On the Domains Setup page, click Add a Domain.
b. For Domain Name, enter the FQDN for your domain.
For example, if you added example.com as a temporary non-HTTPS domain so that you can add www.example.com
as a custom domain, enter www.example.com.
This domain name passes the Salesforce verification check because www.example.com is a subdomain of example.com
and example.com is an existing domain in Salesforce.

c. For HTTPS Option, select Use a temporary non-HTTPS domain.

d. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to create a temporary custom domain in your production org, select Production. Or select a sandbox where you
want to test this custom domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

e. Save your domain.

After you save your new domain, Salesforce provisions the domain or gets it ready to be used. Provisioning can take up to 8
hours. During provisioning, your site can be inaccessible and your site visitors can experience errors.
When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you receive
an email.

f. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.

638
Extend Salesforce with Clicks, Not Code Use a Temporary Non-HTTPS Domain to Serve Your Custom
Domain

Note: Custom domains for a sandbox are edited and activated in production.

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is
active, the status changes from Awaiting Activation to Completed, and the Current HTTPS Option changes to No HTTPS
(Temporary).

g. To configure your domain to serve your sites, add a custom URL.

13. Update your domain to use HTTPS.

Until you activate the domain, the configuration uses HTTP.
a. If your domain serves content from another service, see Change the HTTPS Option for Your Custom Domain.
b. To move your custom domain to a new production org, see Move a Domain to Another Production Org.

14. When your updated domain is live, remove any temporary configuration in Salesforce and in DNS.
a. Delete any temporary non-HTTPS domains that are no longer needed. See Delete a Domain.
b. In DNS, delete the TXT records that you added to set up the temporary domain. Work with your DNS provider to complete this
step.

This diagram shows the routing of traffic when Salesforce serves your domain as a temporary non-HTTPS domain. Dotted lines ( )
represent DNS configurations, and the solid line ( ) represents user traffic flow through HTTP. The gray line represents traffic that
originates outside Salesforce, and the blue lines represent traffic that originates in Salesforce. In this example, the domain name is
www.example.com and the 18-digit org ID is 00d000000000000013.

To confirm ownership of your custom domain (1), with your DNS provider, you point the domain to the Salesforce internal CNAME (2),
which includes your org ID, via a CNAME or TXT record. If a CNAME record routes traffic to Salesforce, Salesforce uses an HTTP-only
endpoint that’s served on a secure server (3) to serve the content from your Experience Cloud site (4). However, the hosted certificate
(3) supports only HTTP on the custom domain instead of HTTPS. Also, the returned certificate creates a hostname-mismatch error because
that certificate doesn't support the custom domain name.

SEE ALSO:
Custom Domains
Custom Domain Management

639
Extend Salesforce with Clicks, Not Code Add a Custom URL

Add a Custom URL

To specify the site to load when users access your custom domain, add a custom URL. Optionally,
EDITIONS
you can define additional relationships between your domains and sites by mapping paths for your
domain to your sites. Available in: both Salesforce
Before you can add a custom URL, set up your custom domain in Salesforce. Classic and Lightning
Experience
A custom URL consists of a domain, a custom path prefix, and a unique site path. For a domain to
serve an Experience Cloud site or Salesforce Site, at least one custom URL is required. Available in: Enterprise,
In the Custom URLs table, even though the domain name and path are in separate columns, the Performance, and
Unlimited Editions. Domains
URLs consist of the combination of the two.
that use the Salesforce CDN
1. From Setup, in the Quick Find box, enter Custom URLs, and then select Custom URLs. are also available with
2. Click New Custom URL. Marketing Cloud Account
Engagement (Pardot) in
3. Select a domain. Professional Edition.
a. Enter the name of the domain, or leave the field blank to get a full list of your domains.
Applies to: Salesforce Sites
b. Click the lookup icon ( ), and then to select a domain, click the name of the domain in and LWR, Aura, and
the search results. Visualforce sites

4. Select a site.
USER PERMISSIONS
a. Enter the name of the site, or leave the field blank to get a full list of your sites.
To view custom URLs:
b. Click , and then to select a site, click the name of the site in the search results. • View Setup and
Each domain can serve up to 200 sites, and each site can be associated with up to 500 domains. Configuration
An Experience Cloud site counts as two sites, so if you use only Experience Cloud sites, each To add, edit, and delete
domain can serve 100 sites. custom URLs:
• Customize Application
5. Enter a unique path. OR View Setup and
To specify the root path, such as https://www.example.com, enter a slash (/). Configuration plus either
a Site.com Publisher
The first character of the path must be a slash (/) to indicate the root. You can extend the path license or Create and Set
after the slash. For example, if you select the domain, www.example.com, and then enter Up Experiences
/products as the path, the resulting custom URL that serves your selected site is
https://www.example.com/products.
You can use the same path for more than one domain, but you can use each path only once within the same domain.
Salesforce reserves some path names, such as /home, /flash, /img, /servlet, and /sfdc. If you enter a reserved path
value, you see an error. In that case, use another relevant prefix to suit your business needs.

Note: If you host multiple sites on the same domain, review your site URLs for conflicts because it’s possible to configure the
same URL for pages on two different sites.
Let’s say that you host Site A and Site B on the same domain, www.example.com. Site A’s URL uses the custom URL path prefix
/products. Site B serves pages from the root path and has a page with the page path /products. As a result, both Site
A’s URL and Site B’s page URL are https://www.example.com/products.
In this scenario, a site visitor can access the Site B page only through a navigation menu on Site B. If a site visitor navigates to
https://example.com/products any other way, they’re directed to Site A.
If you identify a potential conflict, either rename the site path or choose a different path for serving the content on your custom
domain.

640
Extend Salesforce with Clicks, Not Code Add a Custom URL

6. To set this custom URL as the preferred URL for authenticated pages and email, select Site Primary Custom URL.
This option is available for the root path for Experience Clouds sites and Salesforce Sites, but not for legacy Site.com sites.
Each site can have only one primary custom URL. If you enable this setting on more than one URL that serves the same site, the last
custom URL saved with that setting is used for authenticated pages and email.
For Experience Cloud sites and Salesforce Sites, if you don’t select a primary URL, the first HTTPS custom URL in the site, determined
alphabetically, is used for authenticated pages and email. If no custom URL uses HTTPS, your system-managed site domain is used.
The system-managed domain format for Experience Cloud sites is MyDomainName.my.site.com in orgs with enhanced
domains and ExperienceCloudSitesSubdomain.force.com in orgs without enhanced domains. The system-managed
domain format for Salesforce Sites is MyDomainName.my.salesforce-sites.com in orgs with enhanced domains and
SalesforceSitesSubdomain.force.com in orgs without enhanced domains.

7. Save your changes.

If your domain uses your HTTPS certificate on Salesforce servers, saving the first custom URL added to the domain starts the provisioning
process for the domain. After the provisioning process is complete, the domain’s status on the Domains Setup page changes to
Awaiting Activation, and you receive an email. To activate your domain, on the Domains Setup page, click Activate next to your
custom domain name.
If your custom domain uses another HTTPS option the domain is active, the path is publicly available.

Example: In this example, we want to serve two Experience Cloud sites via our custom domain. The system-managed URL for
the site named Storefront is https://MyDomainName.my.site.com/store, and the URL for the site named Jobs is
https://MyDomainName.my.site.com/joblisting. We add the www.example.com domain in Salesforce, and
then we add two custom URLs.
To drive users to the Storefront site, we create a custom URL for the root path of the domain.
• For domain, we select our active domain, www.example.com.
• For site, we select Storefront.
• For path, we enter /.
When we save this custom URL, users who visit https://www.example.com see the content from
https://MyDomainName.my.site.com/store, but the address bar in their browser shows
https://www.example.com.
So users can apply for positions within the company, we create a custom URL for the Jobs site.
• For domain, we select our active domain, www.example.com.
• For site, we select Jobs.
• For path, we enter /apply.
When we save this custom URL, users who visit https://www.example.com/apply see the content from
https://MyDomainName.my.site.com/joblistings, but the address bar in their browser shows
https://www.example.com/apply.

SEE ALSO:
Custom Domains
Custom Domain Build Example

641
Extend Salesforce with Clicks, Not Code Custom Domain Build Example

Custom Domain Build Example

Domains and sites can have a many-to-many relationship through custom URLs. See this relationship
EDITIONS
in action with an example where three custom domains serve one parent site with two different
brands. Available in: both Salesforce
In this example, Example Company owns two clothing brands: Red Example and Blue Example. Classic and Lightning
Their Experience Cloud sites include two sites for each brand. One is a storefront, and the other Experience
provides job listings for the brand.
Available in: Enterprise,
The parent company owns three domains: https://www.example.com, Performance, and
https://www.redexample.com, and https://blueexample.com. They want Unlimited Editions. Domains
visitors to be able to access the sites for both brands from each of those domains. that use the Salesforce CDN
are also available with
Marketing Cloud Account
Build the Site Engagement (Pardot) in
Professional Edition.
First, the admin builds an Experience Cloud site to serve as a landing page. Because they want to
drive traffic to their storefronts, this site highlights the latest trends for both brands and includes Applies to: Salesforce Sites
navigation links to the Red Example storefront site and the Blue Example storefront sites. The sites and LWR, Aura, and
for Red Example and Blue Example include a header that links to the other brand’s storefront. Visualforce sites
Now in Salesforce, there are five Experience Cloud sites.
• Home–The landing page. Site path: /.
• Red Storefront–Storefront for Red Example brand. Site path: /red/shop.
• Red Jobs–Job listings for Red Example brand. Site path: /red/joblist.
• Blue Storefront–Storefront for Blue Example brand. Site path: /blue/shop.
• Blue Jobs–Job listings for Blue Example brand. Site path: /blue/joblist.

Update DNS
To add the three custom domains as records on the Domain Setup page, Salesforce requires that the domains point to their org. The
admin visits the page where they can add a domain to verify the canonical name (CNAME) records values to use when they configure
DNS.
The admin works with their DNS provider to add a CNAME record for each domain that point that the corresponding
*.live.siteforce.com value.
To serve the three custom domains over the Salesforce Content Delivery Network (CDN), the admin also adds a second
_acme-challenge CNAME record for each domain as required by the Salesforce CDN partner, Akamai.

Add the Domains

Now that each CNAME record in DNS for each domain target points to their Salesforce org, the admin can add the domains in Salesforce.
From the Domains Setup page, the admin adds three domains: one with the domain name www.example.com, one with the domain
name www.redexample.com, and one with the domain name www.blueexample.com. For each domain, the admin selects the HTTPS
option, Serve the domain with the Salesforce Content Delivery Network (CDN).
After the admin saves each domain record, Salesforce provisions the domains. In other words, Salesforce gets the new domains ready
for activation. When the admin receives an email that each domain is ready for activation, they activate each domain.

642
Extend Salesforce with Clicks, Not Code Custom Domain Build Example

Add Custom URLs for the Root Domains

To specify the site to load when users access their root domains, the admin sets up Custom URLs. For each Custom URL, the admin
specifies the domain record, the site, and the path. The admin adds Custom URLs with these values.

Domain Site Path

www.example.com Home /

www.redexample.com Home /

www.blueexample.com Home /

When the admin adds the custom URL for www.example.com, they also select Site Primary Custom URL.
When the admin saves these changes, users who visit https://www.example.com, https://www.redexample.com,
or https://blueexample.com see the content from the landing page. However, the address bar in the user’s browser shows
the corresponding branded URL. Also, because the admin selected Site Primary Custom URL for www.example.com,
https://www.example.com is the preferred URL for the site's authenticated pages and email.

Add Custom URLs for the Brand-Specific Site Pages

To load the brand-specific sites for Red Example and Blue Example, the admin adds Custom URLs for the storefront and jobs sites.

Domain Site Path

www.redexample.com Red Storefront /shop

www.redexample.com Red Jobs /apply

www.blueexample.com Blue Storefront /shop

www.blueexample.com Blue Jobs /apply

When the admin saves these custom URLs, users who visit https://www.redexample.com/shop or
https://www.blueexample.com/shop see the corresponding brand’s storefront. And users who visit
https://www.redexample.com/apply or https://www.blueexample.com/apply see the corresponding brand’s
job listings.

SEE ALSO:
Custom Domains
Options to Serve a Custom Domain
Add a Custom URL

643
Extend Salesforce with Clicks, Not Code Custom Domain Management

Custom Domain Management

Keep your custom domain up to date with your business needs. Learn how to manage your domain
EDITIONS
during org migrations and certificate changes. Edit your domain’s HTTPS option, move to a different
domain name, or enable HSTS preloading. And when you no longer need a custom domain, delete Available in: both Salesforce
the domain and its custom URLs in Salesforce. Classic and Lightning
Experience
Maintain Your Custom Domain Available in: Enterprise,
To keep your custom domain running smoothly, follow these guidelines. If you serve your Performance, and
domain with your HTTPS certificate, update the certificate before it expires. Optimize your Unlimited Editions. Domains
domain that uses the Salesforce content delivery network (CDN). Minimize downtime when that use the Salesforce CDN
you update your domain, and take steps to help prevent domain takeover attacks. And review are also available with
recommendations for communicating to your users when you change your domain. Marketing Cloud Account
Engagement (Pardot) in
View Your Custom Domain Details
Professional Edition.
Get information about your custom domain. For example, scan the expiration dates for your
HTTPS certificates that serve your domains. Or get the target hostname for your domain that’s Applies to: Salesforce Sites
served by a third-party service or content delivery network (CDN). Also, you can view and and LWR, Aura, and
manage the custom URLs associated with the domain, and view alerts about the domain’s DNS Visualforce sites
configuration.
Enable HSTS Preloading on a Custom Domain
As a security best practice, enable and submit your custom domain for HTTP Strict Transport Security (HSTS) preloading so that
HTTPS connections are always used in supported browsers. Connections can be vulnerable when HTTP requests are redirected to
HTTPS, for example, when a user attempts to access your custom domain using the HTTP protocol. HSTS preloading instructs browsers
to always use HTTPS, protecting your users from attacks during those HTTP redirections.
Update an Expiring Certificate for Your Custom Domain
If you serve your domain with your HTTPS certificate on Salesforce servers, avoid disruption to your domain by renewing or replacing
your certificate before it expires. You can find the expiration date for your HTTPS certificates on the Certificate and Key Management
Setup page. Also, admins receive an expiring certificate notification email before the certificate expires.
Change the HTTPS Option for Your Custom Domain
Change the method for serving your domain. For example, switch from a third-party service or content delivery network (CDN) to
the Salesforce CDN. Update your domain in Salesforce to use a different third-party service or CDN to serve your site. Or update a
temporary non-HTTPS domain to use HTTPS as required by Salesforce.
Change the Domain Name for a Custom Domain
Whether your brand changed or you want to use a different domain to serve your site content, you can change the domain name
of an existing custom domain in Salesforce. Review these important steps to ensure a smooth transition and reduce the risk of
takeover attacks.
Move a Domain to Another Production Org
If you purchase a new production org, your old org continues to serve your sites with your custom domain. To move the domain to
your new org, set up the domain, and then delete the domain in your old org. Or if you have multiple production orgs, you can move
an existing domain to an org of your choice.

644
Extend Salesforce with Clicks, Not Code Custom Domain Management

Delete a Domain
To stop serving a site via your custom domain, such as https://www.example.com, first delete the custom URLs for that domain.
Then delete the domain in Salesforce. Or to point the domain to a different site, set up new custom URLs.

SEE ALSO:
Use a Temporary Non-HTTPS Domain to Serve Your Custom Domain
Custom Domains
Troubleshoot Common Custom Domain Issues

Maintain Your Custom Domain

To keep your custom domain running smoothly, follow these guidelines. If you serve your domain
EDITIONS
with your HTTPS certificate, update the certificate before it expires. Optimize your domain that uses
the Salesforce content delivery network (CDN). Minimize downtime when you update your domain, Available in: both Salesforce
and take steps to help prevent domain takeover attacks. And review recommendations for Classic and Lightning
communicating to your users when you change your domain. Experience

Available in: Enterprise,

Update an Expiring Certificate Performance, and
If Salesforce serves your custom domain with your HTTPS certificate, avoid disruption by renewing Unlimited Editions. Domains
or replacing your certificate before it expires. Admins receive an expiring certificate notification that use the Salesforce CDN
are also available with
email before the certificate expires. See Update an Expiring Certificate for Your Custom Domain.
Marketing Cloud Account
Engagement (Pardot) in
Optimize the Salesforce CDN Professional Edition.

When your custom domain serves your Experience Cloud site with the Salesforce CDN, each byte Applies to: Salesforce Sites
of traffic that’s requested on your custom domain counts toward your CDN usage amount. To learn and LWR, Aura, and
how to monitor your Salesforce CDN usage and what happens if you exceed the terabyte limit, see Visualforce sites
Traffic Allowances for the Salesforce CDN.
To improve the performance of your LWR Experience Cloud site that’s served on the Salesforce
CDN, cache Apex methods on the Salesforce CDN. See Apex Caching on the Salesforce CDN.

Change the HTTPS Option for Your Domain

Change the method for serving your domain. Switch from using a third-party service to serving your domain with the Salesforce CDN,
or change the third party that serves your domain. See Change the HTTPS Option for Your Custom Domain.

Help Prevent Domain Takeovers

A domain takeover occurs when a malicious actor controls someone else’s domain. They then point the domain to a site that performs
malicious activity. When a malicious attacker takes over your domain, your users’ trust in your company makes them more susceptible
to the attack, and the resulting impact on your users can damage your brand.
A common reason for a domain takeover is a DNS record that points to a resource that’s no longer available. Such DNS records are also
known as dangling DNS entries. To help prevent these attacks, if you change your domain name, review and update the DNS record for
the old domain.

645
Extend Salesforce with Clicks, Not Code Custom Domain Management

In Salesforce, a domain takeover can also occur when you use a third-party service or CDN to serve your domain, and then you change
to another service or domain name. If you no longer have control over the DNS or service for the previous external hostname, update
your domain in Salesforce.
• If you removed your custom domain from the third-party service or CDN, update the external hostname field for your domain to the
new service or change the HTTPS option for your custom domain.
• If you no longer use the custom domain, delete it.
For example, a third-party CDN serves your custom domain and the corresponding external hostname for the domain is
cdn.example.com. You remove your custom domain from that CDN, but the domain record in Salesforce isn’t updated to remove
the pointer from www.example.com to cdn.example.com. In this situation, an attacker can potentially create an account with
that CDN and then set up your custom domain in that CDN to serve content that’s under their control.

Move a Custom Domain to a New Org

If you purchase a new production org, your old org continues to serve your sites with your custom domain. To move the domain to your
new org, set up the domain, and then delete the domain in your old org. Or if you have multiple production orgs, you can move an
existing domain to an org of your choice. See Move a Domain to Another Production Org.

Use a Different Domain Name to Serve Your Site Content

Whether your brand changed or you simply want to use a different URL to serve your sites, you have two options.
• To serve your site content on an additional domain, add the domain in Salesforce. More than one custom domain can serve the
same site content.
• To switch an existing custom domain to serve the site content on a different domain name and stop using the current domain, see
Change the Domain Name for a Custom Domain.

Communicate Site Domain Changes

A change to your domain can impact external users, such as visitors to your Experience Cloud sites. To review recommendations about
communicating to these groups before and after you activate an updated domain, see Notify Users and Customers About a My Domain
Change.

SEE ALSO:
Custom Domains
Custom Domain Management

646
Extend Salesforce with Clicks, Not Code Custom Domain Management

View Your Custom Domain Details

Get information about your custom domain. For example, scan the expiration dates for your HTTPS
EDITIONS
certificates that serve your domains. Or get the target hostname for your domain that’s served by
a third-party service or content delivery network (CDN). Also, you can view and manage the custom Available in: both Salesforce
URLs associated with the domain, and view alerts about the domain’s DNS configuration. Classic and Lightning
1. From Setup, in the Quick Find box, enter Domains, and then select Domains. Experience

The domains list includes your custom domains and the system-managed domains. Available in: Enterprise,
System-managed domains are the domains that Salesforce serves for your org, including your Performance, and
Experience Cloud sites, Salesforce Sites, and My Domain. Unlimited Editions. Domains
that use the Salesforce CDN
are also available with
Marketing Cloud Account
Engagement (Pardot) in
Professional Edition.

Applies to: Salesforce Sites

and LWR, Aura, and
Visualforce sites

In the domain list, you can see the status of your domain.
• Awaiting Custom URL—The domain requires a custom URL to start provisioning. Applies to domains that use the Salesforce
Cloud HTTPS option only.
• Provisioning—Salesforce is provisioning the domain. In other words, Salesforce is getting the domain ready for activation.
• Awaiting Activation—The provisioning process is complete. To use the updated domain, click Activate.
• Completed—The domain is active and in use.
You can also view the domain’s current HTTPS option. If you saved a change to your domain, the Pending HTTPS Option column
lists the HTTPS option that takes effect when you activate the domain.
• Content Delivery Network (CDN) Partner of Salesforce—A custom domain that uses the HTTPS option, Serve the domain with
the Salesforce Content Delivery Network (CDN).
• Experience Cloud Sites Domain—If enhanced domains are deployed, the system-managed domain for your Experience Cloud
sites that ends in *.my.site.com.

647
Extend Salesforce with Clicks, Not Code Custom Domain Management

• Experience Cloud Sites Force.com Domain—If enhanced domains aren’t deployed, the system-managed domain for your
Experience Cloud sites that ends in *.force.com.
• Domain is served by an external host—A custom domain that uses the HTTPS option, Use a third-party service or CDN to serve
the domain.
• My Domain—Your org’s My Domain.
• No HTTPS (Temporary)—A custom domain that uses the HTTPS option, Use a temporary non-HTTPS domain.
• Salesforce Cloud—A custom domain that uses the HTTPS option, Serve the domain with your HTTPS certificate on Salesforce
servers.
For domains with this option in the Current HTTPS Option column, the Certificate and Key column includes a hyperlink to the
certificate that serves the domain. Also, in the Certificate Expiration Date column, you can see when that certificate expires.

• Salesforce Sites Domain—If enhanced domains are deployed, the system-managed domain for your Salesforce Sites that ends
in *.my.salesforce-sites.com.
• Salesforce Sites Force.com Domain—If enhanced domains aren’t deployed, the system-managed domain for your Salesforce
Sites that ends in *.force.com.
For system-managed domains, you can’t edit the domain, such as domains that end in .my.site.com or
.my.salesforce.com. To update the subdomain name of these domains, change your My Domain. For more information,
see My Domain and Plan for a My Domain Change in Salesforce Help. If you click the domain name for those domains, you see the
corresponding Setup page. For example, if you click your My Domain name, you see the My Domain Setup page.

2. To view additional information about your custom domain, in the Domain Name column, click the domain name.
The Domain Detail page shows additional information about your domain. The fields vary based on the HTTPS option for your
domain. Here’s an example of the Domain Detail page for a domain that’s served by a third-party service or CDN.

648
Extend Salesforce with Clicks, Not Code Custom Domain Management

When you access this page, Salesforce validates that your domain points to your Salesforce org. If that validation fails, a warning
message provides next steps (1). If your domain is served by an external host, you can view the target hostname to give to your third
party to point to your org (2). If custom URLs exist for this domain, you can view and manage them from the Custom URL table (3).

SEE ALSO:
Custom Domains
Custom Domain Management
My Domain
Plan for a My Domain Change

Enable HSTS Preloading on a Custom Domain

As a security best practice, enable and submit your custom domain for HTTP Strict Transport Security
EDITIONS
(HSTS) preloading so that HTTPS connections are always used in supported browsers. Connections
can be vulnerable when HTTP requests are redirected to HTTPS, for example, when a user attempts Available in: both Salesforce
to access your custom domain using the HTTP protocol. HSTS preloading instructs browsers to Classic and Lightning
always use HTTPS, protecting your users from attacks during those HTTP redirections. Experience
HSTS is enabled on all Salesforce and Visualforce pages, and for all system-managed domains for
Available in: Enterprise,
Experience Cloud sites and Salesforce Sites. The system-managed domain format for Experience Performance, and
Cloud sites is MyDomainName.my.site.com in orgs with enhanced domains and Unlimited Editions. Domains
ExperienceCloudSitesSubdomain.force.com in orgs without enhanced domains. that use the Salesforce CDN
The system-managed domain format for Salesforce Sites is are also available with
MyDomainName.my.salesforce-sites.com in orgs with enhanced domains and Marketing Cloud Account
SalesforceSitesSubdomain.force.com in orgs without enhanced domains. No Engagement (Pardot) in
action is required to enable HSTS on those domains. Professional Edition.
To enable HSTS on custom domain that serves your site content, such as Applies to: Salesforce Sites
https://www.example.com, complete these steps. and LWR, Aura, and
1. Allow HSTS on your custom domain in Salesforce. Visualforce sites

This setting is automatically enabled in domains created or edited in Summer ’21 or later.
USER PERMISSIONS
Note: This setting applies only to domains that are eligible for HSTS preloading. Domain
names can consist of a public suffix plus one additional label. For example, To view a domain:
example.com and example.co.uk are eligible, but www.example.com, • View Setup and
www.example.co.uk, and sub.example.com aren’t eligible. Configuration

a. From Setup, in the Quick Find box, enter Domains, and then select Domains. To edit a domain:
• Customize Application
b. In the Domain Name column, click the domain name.
c. On the Domain Detail page, select Allow HSTS preloading registration.
d. Save your changes.
To allow HSTS preloading, Salesforce adds the preload directive to the HSTS header for your custom domain.

649
Extend Salesforce with Clicks, Not Code Custom Domain Management

2. To enable HSTS preloading on your domain, go to https://hstspreload.org, and submit your domain.

SEE ALSO:
Custom Domains
Custom Domain Management

Update an Expiring Certificate for Your Custom Domain

If you serve your domain with your HTTPS certificate on Salesforce servers, avoid disruption to your
EDITIONS
domain by renewing or replacing your certificate before it expires. You can find the expiration date
for your HTTPS certificates on the Certificate and Key Management Setup page. Also, admins receive Available in: both Salesforce
an expiring certificate notification email before the certificate expires. Classic and Lightning
Experience
Note: These instructions only apply to certificates for custom domains that you serve with
your HTTPS certificate on Salesforce servers. If your custom domain uses the Salesforce content Available in: Enterprise,
delivery network (CDN) to serve your Digital Experiences, Akamai automatically renews the Performance, and
certificate. If a third-party service or CDN serves your domain, work with that third party to Unlimited Editions. Domains
ensure that your certificates remain valid. that use the Salesforce CDN
are also available with
Unfamiliar with terms like DNS and certificate? See Custom Domain Terminology.
Marketing Cloud Account
By default, when you generate a certificate authority (CA)-signed HTTPS certificate in Salesforce, Engagement (Pardot) in
that certificate expires in a year, after which the certificate isn’t trusted. If you serve your site with Professional Edition.
a certificate that you uploaded to your Experience Cloud site, that certificate also expires periodically.
Applies to: Salesforce Sites
To avoid downtime and allow time for testing, update your certificate at least one week before the
and LWR, Aura, and
certificate expires.
Visualforce sites
1. Download your existing certificate.
It’s a good idea to save a copy of any key before you delete it. If there’s an issue after you delete
USER PERMISSIONS
a certificate, you can import the key later.
a. From Setup, in the Quick Find box, enter Certificate and Key Management, To create, edit, and manage
and then select Certificate and Key Management. certificates:
• Customize Application
b. In the Label column, click the certificate to download.
To edit a domain:
c. On the Certificate and Key Detail page, click Download Certificate. • Customize Application
d. Save the *.crt file to a safe location.

2. Create and upload a new certificate to Salesforce.

Although it’s technically possible to update your existing certificate, we recommend that you create a certificate in Salesforce when
your certificate is about to expire. This approach increases the security of your certificate because adding a certificate generates a
new public-private key pair for encryption
a. If your CA uses intermediate certificates, see the instructions in the knowledge article, Merge a complete certificate chain for
custom HTTPS domains.
b. To upload your certificate to Salesforce, see Generate a Certificate Signed by a Certificate Authority. You can get the required CA
signature as a part of that process.
c. To import an existing certificate that is already signed, see the knowledge article, Use HTTPS certificate that exists within your
Community domain.

3. To use the new certificate, update your custom domain.

650
Extend Salesforce with Clicks, Not Code Custom Domain Management

a. From Setup, in the Quick Find box, enter Domains, and then select Domains.
b. Next to your domain, click Edit.
c. Under the HTTPS option, serve the domain with your HTTPS certificate on Salesforce servers, and clear the certificate field. Then
click the lookup icon ( ).

d. In the lookup window, select the label of the new certificate.

e. Save your changes.
It can take up to 4 hours for the updated certificate to take effect.

4. Validate your domain.

Because it can take up to 4 hours for the change to take effect, we recommend that you validate your domain both after you save
your changes and then again the next day.

5. Optionally, delete your old certificate.

a. From Setup, in the Quick Find box, enter Certificate and Key Management, and then select Certificate and Key
Management.
b. For the expired certificate, click Del.

651
Extend Salesforce with Clicks, Not Code Custom Domain Management

This option is available only when no domain, identity provider, single sign-on (SSO) setting, or connected app uses the certificate.

SEE ALSO:
Custom Domains
Custom Domain Management
Certificates and Keys

652
Extend Salesforce with Clicks, Not Code Custom Domain Management

Change the HTTPS Option for Your Custom Domain

Change the method for serving your domain. For example, switch from a third-party service or
EDITIONS
content delivery network (CDN) to the Salesforce CDN. Update your domain in Salesforce to use a
different third-party service or CDN to serve your site. Or update a temporary non-HTTPS domain Available in: both Salesforce
to use HTTPS as required by Salesforce. Classic and Lightning
Experience
Tip: Unsure which HTTPS option to use? See Determine How to Serve Your Custom Domain.
Available in: Enterprise,
1. Complete the prerequisites for your chosen HTTPS option.
Performance, and
a. To serve your domain with your HTTPS certificate on Salesforce servers, complete the Unlimited Editions. Domains
prerequisites for that option. that use the Salesforce CDN
are also available with
b. To serve your Experience Cloud site with the Salesforce CDN, complete the prerequisites
Marketing Cloud Account
for the Salesforce CDN.
Engagement (Pardot) in
c. To use a third-party service or CDN to serve your domain, complete the prerequisites for Professional Edition.
that option. These third-party services include third-party hosts, web application firewalls
Applies to: Salesforce Sites
(WAFs), and non-Salesforce CDNs.
and LWR, Aura, and
2. Add custom URLs or your custom domain. Visualforce sites
At this point, you kept your website up and running while you prepared to use the new HTTPS
option. When you’re ready to change the HTTPS option for your domain, complete these three USER PERMISSIONS
steps.
To view a domain:
3. If necessary, update the DNS record of your domain. • View Setup and
Work with your DNS provider to complete these steps. Configuration

a. If your new HTTPS option serves your domain with your HTTPS certificate or with the To add a domain:
Salesforce CDN, validate that the canonical name (CNAME) record points to your org. If the • Customize Application
CNAME record points to your org and you completed the other prerequisites for your new OR
HTTPS option, no further action is required. View Setup and
b. Reduce the Time to Live (TTL) of your domain in DNS. Use a small value, such as 300, for Configuration plus either
a Site.com Publisher
300 seconds or 5 minutes.
license or Create and Set
Think of your TTL as a timer for calls to your domain. This value tells servers how long to Up Experiences
cache, or keep, a web page before calling DNS again to refresh the page. When you
To edit or delete a domain:
temporarily reduce this value, you minimize the chance of your users calling the previous
• Customize Application
IP address during the move.
To add, edit, and delete
After you make this change, wait for the time duration of the previous TTL before you make custom URLs:
other changes to DNS. • Customize Application
c. To switch to serving your custom domain with your HTTPS certificate on Salesforce servers, OR
update the CNAME record to point to your org. View Setup and
Configuration AND either
d. To switch to serving your custom domain with the Salesforce CDN, update the CNAME
Create and Set Up
record to point to your org. Experiences OR a
e. To switch to using a third-party service or CDN to serve your domain, work with your Site.com Publisher
third-party provider to use your target hostname to forward requests to your domain to license
your org.
After you update your DNS record, the changes are updated across the internet. That process,
called DNS propagation, typically takes a few hours, but it can take up to 72 hours.

653
Extend Salesforce with Clicks, Not Code Custom Domain Management

4. From Setup in production, in the Quick Find box, enter Domains, and then click Domains.
5. For your existing custom domain, click Edit.
6. Select your new HTTPS option.
a. If you have a certificate authority (CA)-signed certificate using Certificate and Key Management for your domain, select Serve
the domain with your HTTPS certificate on Salesforce servers, and then choose the certificate to serve the domain.
b. To use the Salesforce CDN partner to host an Experience Cloud site on your custom domain, select Serve the domain with the
Salesforce Content Delivery Network (CDN).

Note: This option is unavailable for registrable domains, such as example.com without the www subdomain, and for
Salesforce Sites. To serve a registrable domain or a Salesforce Site on a CDN, serve your custom domain with a third-party
service or CDN.
For more information and important considerations about the Salesforce CDN, see Serve Your Experience Cloud Site with the
Salesforce Content Delivery Network (CDN).

c. If a third-party service or CDN serves your domain, select Use a third-party service or CDN to serve this domain, and then
enter the external hostname.

7. To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your
domain, select Allow HSTS preloading registration.
This setting adds the preload directive to the HSTS header. After you enable this setting, submit your domain at https://hstspreload.org.
For more information, see Enable HSTS Preloading on a Custom Domain.

8. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to serve the sites in your production org, select Production. Or select a sandbox where you want to test this custom
domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

9. Save your domain.

When you save the domain, Salesforce provisions the domain in your new org. Provisioning can take up to 14 hours for the Salesforce
CDN and up to 8 hours for other HTTPS options. During provisioning, your site can be inaccessible and your site visitors can experience
errors.
When that process is complete, the status of the domain on the Domains Setup page changes to Awaiting Activation and you receive
an email.
Until you activate the domain, the configuration uses your previous HTTPS option.

10. To activate your updated domain, on the Domains Setup page, click Activate next to your custom domain.
Your site can be unavailable for 5–10 minutes after activation, so activate your custom domain when your site traffic is low. When
your site is active, the status changes from Awaiting Activation to Completed.

11. When your updated domain is live, reset the TTL of your domain in DNS to your previous setting.
12. If you used a temporary non-HTTPS domain to configure this domain, remove any temporary configuration in Salesforce and DNS.
a. Delete any temporary non-HTTPS domains that are no longer needed.

654
Extend Salesforce with Clicks, Not Code Custom Domain Management

b. In DNS, delete any TXT records that you added to set up the temporary domain.

SEE ALSO:
Custom Domains
Custom Domain Management

Change the Domain Name for a Custom Domain

Whether your brand changed or you want to use a different domain to serve your site content, you
EDITIONS
can change the domain name of an existing custom domain in Salesforce. Review these important
steps to ensure a smooth transition and reduce the risk of takeover attacks. Available in: both Salesforce
Note: These instructions apply when an existing custom domain serves your site content Classic and Lightning
Experience
and you want to switch to serving the site content on a different domain name.
To serve your site content on an additional domain, add the domain in Salesforce. More than Available in: Enterprise,
one domain can serve the same site content. For an example where three custom domains Performance, and
serve one parent site with two different brands, see Custom Domain Build Example. Unlimited Editions. Domains
that use the Salesforce CDN
To minimize the downtime for your site, consider setting up and activating your new domain are also available with
in Salesforce, and then delete the old domain. Marketing Cloud Account
Engagement (Pardot) in
To update an existing custom domain to serve your site content on a different domain name and
Professional Edition.
stop using the current domain, complete these steps.
Applies to: Salesforce Sites
Before you start, determine how to process visits to your old domain after the change. Common
and LWR, Aura, and
approaches include redirecting traffic to your new domain or displaying a landing page that directs
Visualforce sites
visitors to the new page.

Tip: To minimize site downtime, update the domain in Salesforce and the DNS records when USER PERMISSIONS
your org receives minimal traffic, such as during the weekend.
1. Complete the prerequisites for your chosen HTTPS option to serve the domain. To view a domain:
• View Setup and
a. To serve your domain with your HTTPS certificate on Salesforce servers, complete the Configuration
prerequisites for that option
To add a domain:
b. To serve your Digital Experiences with the Salesforce content delivery network (CDN), • Customize Application
complete the prerequisites for the Salesforce CDN. OR
c. To use a third-party service or CDN to serve your domain, complete the prerequisites for View Setup and
that option. These third-party services include third-party hosts, web application firewalls Configuration plus either
(WAFs), and non-Salesforce CDNs. a Site.com Publisher
license or Create and Set
2. Reduce the Time to Live (TTL) of your domain in DNS. Use a small value, such as 300, for 300 Up Experiences
seconds or 5 minutes.
To edit or delete a domain:
Work with your DNS provider to complete this step. • Customize Application
Think of your TTL as a timer for calls to your domain. This value tells servers how long to cache,
or keep, a web page before calling DNS again to refresh the page. When you temporarily reduce
this value, you minimize the chance of your users calling the previous IP address during the move.
After you make this change, wait for the time duration of the previous TTL before you make other changes to DNS.

655
Extend Salesforce with Clicks, Not Code Custom Domain Management

3. If a third-party service or CDN serves your new domain, work with your third-party provider to use your target hostname to forward
requests to your domain to your org.
4. If you plan to serve your new domain with your HTTPS certificate on Salesforce servers on with the Salesforce CDN, point the new
domain to your org.
5. From Setup in production, in the Quick Find box, enter Domains, and then select Domains.
6. For the domain with your old domain name, click Edit.
7. Clear the Domain Name field, and then enter your new domain name.
Salesforce validates ownership based on the fully qualified domain name (FQDN) that you enter when you add a domain to your
org. If you get an error message, point your custom domain to your org, and then wait for the changes to propagate. After you
update your domain’s DNS record, it can take up to 72 hours for that change to take effect worldwide.

8. If you serve your domain with your HTTPS certificate, update the certificate.
a. Under the HTTPS option, Serve the domain with your HTTPS certificate on Salesforce servers, clear the certificate field. Then click
the lookup icon ( ).

b. In the lookup window, select the label of the certificate for your new domain.

9. If you use a third-party service or CDN to serve your domain, update the external hostname.

656
Extend Salesforce with Clicks, Not Code Custom Domain Management

This step is required to serve your new domain. If you no longer have control over the DNS or service of the previous external
hostname, this action also reduces the risk of a domain takeover attack.

Note: Without these steps, an attacker can potentially take over the custom domain’s live service.
For example, a third-party CDN serves your custom domain and the corresponding external hostname for the domain is
cdn.example.com. You remove your custom domain from that CDN, and the domain record in Salesforce isn’t updated
to remove the pointer from www.example.com to cdn.example.com. In this situation, an attacker can potentially
create an account with that CDN and then set up your custom domain in that CDN to serve content that’s under their control.

10. Save your domain.

After you save your custom domain, Salesforce provisions the domain or gets it ready to be used. The provisioning process can take
4–14 hours. During provisioning, your site can be inaccessible.
When that process is complete, the domain’s status on the Domains Setup page changes to Awaiting Activation and you receive
an email.
Until you activate the domain, the configuration uses your previous domain name.

11. To activate your domain, on the Domains Setup page, click Activate next to your custom domain name.

Note: Custom domains for a sandbox are edited and activated in production.

Your site can be unavailable for 5–10 minutes, so activate your custom domain when your site traffic is low. When your site is active,
the status changes from Awaiting Activation to Completed.

12. In DNS, remove the records that point to your Salesforce org from your old domain.
Work with your DNS provider to complete this step.
a. If you use a registrable domain, work with your DNS provider to remove the alias record or canonical name (CNAME) flattening
setting that points to your Salesforce org.
b. If you serve your domain with your HTTPS certificate, remove the CNAME record for your old domain that points to your internal
Salesforce CNAME.
c. If you serve the Salesforce CDN, remove the CNAME record for your old domain that points to your internal Salesforce CNAME.
Also remove the acme-challenge CNAME for your old domain.
d. If a third-party service or CDN serves your domain, work with that third party to remove the target hostname that points to your
Salesforce org.
For more information on these settings, see Point Your Custom Domain to Your Salesforce Org and Prerequisites for a Custom Domain
That Uses a Third-Party Service or CDN.

13. Update your old domain to redirect or inform users.

Update DNS or work with your third party to establish a redirection to your new domain, or to display a page informing visitors about
the new domain.

If you still have control over the old domain, you can reset the TTL in DNS after your users transition to the new site. You can also remove
redirections or the informational page about the move when that redirection is no longer required.

SEE ALSO:
Custom Domains
Custom Domain Management

657
Extend Salesforce with Clicks, Not Code Custom Domain Management

Move a Domain to Another Production Org

If you purchase a new production org, your old org continues to serve your sites with your custom
EDITIONS
domain. To move the domain to your new org, set up the domain, and then delete the domain in
your old org. Or if you have multiple production orgs, you can move an existing domain to an org Available in: both Salesforce
of your choice. Classic and Lightning
If you set up a custom domain in a sandbox and want to move that domain to production, see Experience
Activate a Sandbox Custom Domain in Production.
Available in: Enterprise,
To move a custom domain from one production org to another production org, complete these Performance, and
steps. Unlimited Editions. Domains
that use the Salesforce CDN
1. Verify that the Experience Cloud sites, Salesforce Sites, and corresponding pages exist in the
are also available with
new org. If not, move them to the new org.
Marketing Cloud Account
2. To configure your custom domain in the new org, add a temporary non-HTTPS domain. Engagement (Pardot) in
With a temporary non-HTTPS domain, your existing domain keeps serving your sites while you Professional Edition.
configure the domain and custom URLs in the new org. Applies to: Salesforce Sites
You can’t add the same domain to two orgs on the same Salesforce instance. If your new org and LWR, Aura, and
is on the same instance as your old org, contact Salesforce Customer Support to move the org Visualforce sites
to another instance.
USER PERMISSIONS
3. Complete the prerequisites for your chosen HTTPS option to serve the domain.
a. To serve your domain with your HTTPS certificate on Salesforce servers, complete the To view a domain:
prerequisites for that option. • View Setup and
Configuration
b. To serve your Digital Experiences with the Salesforce content delivery network (CDN),
complete the prerequisites for the Salesforce CDN. To add a domain:
• Customize Application
c. To use a third-party service or CDN to serve your domain, complete the prerequisites for
OR
that option. These third-party services include third-party hosts, web application firewalls
(WAFs), and non-Salesforce CDNs. View Setup and
Configuration plus either
4. Add custom URLs for your temporary non-HTTPS domain. a Site.com Publisher
license or Create and Set
At this point, you kept your website up and running while you prepared to move your domain Up Experiences
to the new org.
To edit or delete a domain:
Tip: To minimize site downtime, perform the remaining steps when your org receives • Customize Application
minimal traffic, such as during the weekend.
To add, edit, and delete
5. If necessary, update the DNS record of your domain. custom URLs:
• Customize Application
To complete these steps, work with your DNS provider or third-party provider.
OR
a. Reduce the Time to Live (TTL) of your domain in DNS. Use a small value, such as 300, for
View Setup and
300 seconds or 5 minutes.
Configuration AND either
Think of your TTL as a timer for calls to your domain. This value tells servers how long to Create and Set Up
cache or keep a web page before calling DNS again to refresh the page. When you Experiences OR a
temporarily reduce this value, you minimize the chance of your users calling the previous Site.com Publisher
license
IP address during the move.
After you make this change, wait for the time duration of the previous TTL before you make
other changes to DNS.

658
Extend Salesforce with Clicks, Not Code Custom Domain Management

b. If you serve your domain with your HTTPS certificate on Salesforce servers or with the Salesforce CDN, update the canonical
name (CNAME) record to point to your new org.
c. If a third-party service or CDN serves your domain, work with your third-party provider to use your target hostname to forward
requests to your domain to your new org.
After you update your DNS record, the changes are updated across the internet. That process, called DNS propagation, typically takes
a few hours, but it can take up to 72 hours. Update the DNS record of your domain.

6. From Setup in production, in the Quick Find box, enter Domains, and then select Domains.
7. For your existing temporary non-HTTPS domain, click Edit.
8. Select your HTTPS option.
a. If you have a certificate authority (CA)-signed certificate using Certificate and Key Management for your domain, select Serve
the domain with your HTTPS certificate on Salesforce servers, and then choose the certificate to serve the domain.
b. To use the Salesforce CDN partner to host an Experience Cloud site on your custom domain, select Serve the domain with the
Salesforce Content Delivery Network (CDN).
If you use Marketing Cloud Account Engagement (Pardot) in a Professional Edition org, the Salesforce CDN is the only HTTPS
option available for your custom domains.
This option is unavailable for registrable domains such as example.com without the www subdomain, and for Salesforce Sites.
To serve a registrable domain or a Salesforce Site on a CDN, serve your custom domain with a third-party service or CDN.
For more information and important considerations about the Salesforce CDN, see Serve Your Experience Cloud Site with the
Salesforce Content Delivery Network (CDN).

c. If a third-party service or CDN serves your domain, select Use a third-party service or CDN to serve this domain, and then
enter the external hostname.

9. To avoid vulnerabilities during HTTP redirects and to have supported web browsers always use secure HTTPS connections for your
domain, select Allow HSTS preloading registration.
This setting adds the preload directive to the HSTS header. After you enable this setting, submit your domain at https://hstspreload.org.
For more information, see Enable HSTS Preloading on a Custom Domain.

10. For Associated Org, select the org from which you want this custom domain to serve site content.
For example, to serve the sites in your production org, select Production. Or select a sandbox where you want to test this custom
domain.
This field only appears in production orgs with associated sandboxes. You can edit this field only from production orgs. For more
information, see Test Your Custom Domains in a Sandbox.

11. Save your domain.

When you save a domain that uses your HTTPS certificate on Salesforce servers, the status of the domain on the Domain Setup page
changes to Awaiting Activation.
When you save a domain that uses another HTTPS option, Salesforce provisions the domain in your new org. Provisioning can take
up to 14 hours for the Salesforce CDN and up to 8 hours for other HTTPS options. During provisioning, your site can be inaccessible
and your site visitors can experience errors.
When the provisioning process is complete, the status of the domain on the Domains Setup page changes to Awaiting Activation
and you receive an email.

12. To serve your sites via your domain, add a custom URL.

659
Extend Salesforce with Clicks, Not Code Custom Domain Management

When you add the first custom URL for a domain that uses your HTTP certificate on Salesforce servers, Salesforce provisions the
domain. In other words, Salesforce gets it ready to be used. The provisioning process can take 4–14 hours. When that process is
complete, the domain’s status on the Domains Setup page changes from Awaiting Custom URL to Awaiting Activation and you
receive an email.

13. To activate your updated domain, on the Domains Setup page, click Activate next to your custom domain.
Newly created custom domains use HTTP, not HTTPS, until you activate the domain.
Your site can be unavailable for 5–10 minutes after activation, so activate your custom domain when your site traffic is low. When
your site is active, the status changes from Awaiting Activation to Completed.

14. Delete the domain in your old production org.

Warning: If the old domain isn’t deleted, users can be routed to the old IP address and experience errors or view outdated
content.

15. When your updated domain is live, remove any temporary configuration in Salesforce and DNS.
a. Work with your DNS provider or third-party service provider to reset the TTL of your domain in DNS to your previous setting.
b. Delete any temporary non-HTTPS domains that are no longer needed.
c. In DNS, delete the TXT records that you added to set up the temporary domain.

SEE ALSO:
Custom Domains
Custom Domain Management

660
Extend Salesforce with Clicks, Not Code Custom Domain Management

Delete a Domain
To stop serving a site via your custom domain, such as https://www.example.com, first delete the
EDITIONS
custom URLs for that domain. Then delete the domain in Salesforce. Or to point the domain to a
different site, set up new custom URLs. Available in: both Salesforce
1. If you use a legacy Site.com site, deactivate the site in Salesforce. Classic and Lightning
Experience
If you use Experience Cloud sites or Salesforce Sites, skip this step.
Available in: Enterprise,
2. Delete the custom URLs for your domain. Performance, and
a. From Setup, in the Quick Find box, enter Custom URLs, and then select Custom URLs. Unlimited Editions. Domains
that use the Salesforce CDN
b. For each custom URL associated with your domain, click Del next to the URL name, and
are also available with
then click OK.
Marketing Cloud Account
For Experience Cloud sites and Salesforce Sites, the URL is deleted immediately, and users who Engagement (Pardot) in
visit that URL no longer have access to the site. Professional Edition.
With legacy Site.com sites, the URL remains active until you republish or delete the site. Applies to: Salesforce Sites
and LWR, Aura, and
3. To use the Salesforce-hosted domain for your site, or if you set up custom URLs for a different Visualforce sites
domain to serve your site, activate your site again.
a. For Experience Cloud sites, see Activate Your Site.
USER PERMISSIONS
b. For Salesforce Sites, from Setup, in the Quick Find box, enter Sites, select Sites, and then
click Deactivate. To view custom URLs:
• View Setup and
c. For legacy Site.com sites, see Publishing and Managing Live Sites. Configuration
4. Optionally, delete your domain. To add, edit, and delete
custom URLs:
a. From Setup, in the Quick Find box, enter Domains, and then select Domains.
• Customize Application
b. Next to the domain name, click Del, and then click OK. OR
For Experience Cloud sites and Salesforce Sites, the domain is deleted immediately, and View Setup and
users who visit that URL no longer have access to any site connected to that domain. Configuration AND either
Create and Set Up
For legacy Site.com sites unrelated to Experience Cloud sites, the domain remains active
Experiences OR a
until you republish or delete the site. Site.com Publisher
license
Note: When you delete a domain with an unpublished legacy Site.com site attached,
it also deletes any custom URLs associated with that site. To view a domain:
• View Setup and
5. Work with your DNS provider to update the DNS record for your domain. Remove pointers from Configuration
the domain to Salesforce. To edit or delete a domain:
For information about the initial configuration, see Point Your Custom Domain to Your Salesforce • Customize Application
Org.

6. Optionally, review and revert other configuration related to your domain’s HTTPS option.
a. If your domain used your HTTPS certificate on Salesforce servers, remove the certificate from Salesforce. On the Certificate and
Key Management Setup page, next to your certificate, click Del.
This option is available only when no domain, identity provider, single sign-on (SSO) setting, or connected app uses the certificate.

b. If your domain used the Salesforce CDN, see Prerequisites for the Salesforce CDN.

661
Extend Salesforce with Clicks, Not Code Troubleshoot Common Custom Domain Issues

c. If a third-party service or CDN served your domain, see Prerequisites for a Custom Domain That Uses a Third-Party Service or
CDN.

SEE ALSO:
Custom Domains
Custom Domain Management

Troubleshoot Common Custom Domain Issues

Review the potential causes and troubleshooting steps for common issues that you can encounter
EDITIONS
when you set up a custom domain.

Tip: Unfamiliar with terms like DNS, CDN, certificate, and CNAME? See Custom Domain Available in: both Salesforce
Terminology. Classic and Lightning
Experience
Behavior Potential Causes and Troubleshooting Steps Available in: Enterprise,
Performance, and
When adding a The canonical name (CNAME) record is missing or incorrect in the
Unlimited Editions. Domains
domain and entering domain’s DNS record. Verify the CNAME record is present, and correct
that use the Salesforce CDN
the domain name, an for your fully qualified domain name (FQDN). See Point Your Custom are also available with
admin gets the error, Domain to Your Salesforce Org. Marketing Cloud Account
Unable to verify the Engagement (Pardot) in
The change to your domain’s DNS record is still being propagated. It can
CNAME target. Professional Edition.
take up to 72 hours for that change to take effect worldwide. Wait for
propagation to finish, then try again. Applies to: Salesforce Sites
and LWR, Aura, and
A custom domain is Provisioning a domain can take 4–14 hours for the Salesforce content Visualforce sites
stuck in provisioning. delivery network (CDN) and 4–8 hours for other options.
If that time has elapsed, check your domain’s DNS record for any DNS
changes. Then contact Salesforce Customer Support.

A custom domain has For custom domains that use your HTTPS certification on Salesforce
a status of Awaiting servers, provisioning starts when you add the first custom URL. In this
Custom URL. case, the status on the Domains Setup page is Awaiting Custom URL. To
Provisioning didn’t start provisioning, add a custom URL for the domain.
start.

When attempting to The CNAME record is missing or incorrect in the domain’s DNS record.
visit the custom Verify the CNAME record is present and correct for your fully qualified
domain, users get the domain name (FQDN). See Point Your Custom Domain to Your Salesforce
ERR_NAME_NOT_RESOLVED Org.
error in Chrome.
The domain isn’t activated in Salesforce. Check the domain status on the
Domains Setup page.

When users attempt to The common name (CN) on the certificate is incorrect. A certificate is
access a custom valid only if the request hostname matches the certificate CN.
domain that uses your

662
Extend Salesforce with Clicks, Not Code Troubleshoot Common Custom Domain Issues

Behavior Potential Causes and Troubleshooting Steps

HTTPS certificate, they see an A mismatch between the certificate and the provisioned domain name. For example, the certificate
error that indicates a security is for www.example.com and the domain name in Salesforce is example.com.
issue.
Ensure that your custom domain points to its own *.live.siteforce.com CNAME target.
For example, CNAME record for www.example.com points at
www.example.com.18CharOrgId.live.siteforce.com, and the CNAME record
for products.example.com points at
products.example.com.18CharOrgId.live.siteforce.com.

When users attempt to access a Verify that your proxy or CDN requests forward to the target hostname shown on the Domain Detail
custom domain that’s hosted by page for your domain in Setup. For more information, see Prerequisites for a Custom Domain That
a third-party service or CDN, Uses a Third-Party Service or CDN.
they see an SSL connection
error. The most common cause for this issue is the use of a site hostname, such as
MyDomainName.my.site.com, as a target hostname. That configuration fails. Instead, use
the value displayed on the Domain Detail page.

Ensure that the SSL certificate is installed properly on the third party’s origin server.

In Setup, the custom domain The custom domain configuration prevents the association. This issue can happen if you use a proxy
isn’t reflected as the Site URL on or point indirectly to the *.live.sitesforce.com CNAME target.
the All Sites Setup page.
Two custom domains serve the same site. Only one is displayed on the All Sites Setup page.

Users can’t authenticate via the If you have two custom domains that serve the same site, verify that the authentication method is
custom domain with methods configured for both custom domains.
such as single-sign-on (SSO),
connected apps, and auth Often when the authentication method isn’t configured for one domain, authentication methods
providers. that use the default site URL ending in *.force.com or *.my.site.com work.

If you deployed enhanced domains, see Restore Access to Sites After Enhanced Domains
Auto-Deployment.

Some users can’t connect to the Check the common issues in the knowledge article, Restore Access to Sites After Enhanced Domains
site via a custom domain that Auto-Deployment.
uses the Salesforce CDN.

Users see unexpected content If you host multiple sites on the same domain, review your site URLs for conflicts because it’s possible
when they visit a custom URL. to configure the same URL for pages on two different sites.
Let’s say that you host Site A and Site B on the same domain, https://www.example.com.
Site A’s URL uses the custom URL path prefix /products. Site B serves pages from the root path
and has a page with the page path /products. As a result, both Site A’s URL and Site B’s page
URL are https://www.example.com/products.
In this scenario, a site visitor can access the Site B page only through a navigation menu on Site B. If
a site visitor navigates to https://example.com/products any other way, they’re directed
to Site A.
If you identify a potential conflict, either rename the site path or choose a different path for serving
the content on your custom domain.

663
Extend Salesforce with Clicks, Not Code Custom Domain Terminology

Behavior Potential Causes and Troubleshooting Steps

When users visit my temporary This behavior is expected. Because Salesforce requires HTTPS, HTTP-only requests to your site are
non-HTTPS domain, the browser redirected to a working HTTPS URL.
address bar shows a version of
my internal site URL. For example, an admin adds www.example.com in Salesforce as a Domain with the HTTPS
Option, Use a temporary non-HTTPS domain. The admin activates the domain and adds a Custom
URL to load their Experience Cloud site with the CNAME 00d000000000000013.live.siteforce.com.
When users visit www.example.com, the browser’s address bar displays
https://00d000000000000013.my.site.com instead of
http://www.example.com.
To get your custom domain name to persist in the browser’s address bar, update the temporary
non-HTTPS domain to use another HTTPS option.

SEE ALSO:
Custom Domains
Custom Domain Management

Custom Domain Terminology

Review the terms related to setting up a custom domain in Salesforce.
EDITIONS
A Record
A record added to a domain’s DNS record that maps the domain to an IPv4 address. A DNS Available in: both Salesforce
record can contain multiple A records. Classic and Lightning
Experience
AAAA Record (quad A)
A record added to a domain’s DNS record that maps the domain to an IPv6 address. A domain’s Available in: Professional,
DNS record can contain multiple AAAA records. Enterprise, Performance,
and Unlimited Editions.
Canonical Name (CNAME)
Domains created in
A record in DNS that points to a domain name, rather than an IP address. Often, when sites
Professional Edition must
have subdomains such as blog.example.com or shop.example.com, those
use the Salesforce CDN.
subdomains have CNAME records that point to a root domain (example.com). CNAME
records follow changes made to the root domain. Use CNAME when you want to make one
domain name the alias of another name.
Certificate Authority (CA)
A trusted entity that stores, signs, and issues digital certificates to authenticate content sent from web servers. Sometimes referred
to as a certification authority.
Content Delivery Network (CDN)
A geographically distributed network of servers that stores cached versions of web assets to optimize page load times and site
performance. For more information, see Content Delivery Networks (CDNs) and Salesforce.
Certificate
A file provided by a certificate authority (CA) that authenticates a website’s identity and enables an encrypted connection. The file
contains a public key and other data that identifies the private key owner.
For custom domains, CDNs use single and shared certificates. Single certificates display only one brand, while shared certificates
display multiple brands. The Salesforce CDN encourages single certificates because they’re more secure and branded. As of Winter

664
Extend Salesforce with Clicks, Not Code Custom Domain Terminology

’21, all new sites using the Salesforce CDN use single certificates by default. To switch from a shared to a single certificate, edit your
domain, and then select Single certificate for content delivery network (CDN).
Common Name (CN)
Represents the hostname protected by the SSL certificate. The CN serves as a hostname identifier of a certificate.
Custom URL
In Salesforce, a custom URL maps a full path URL to an Experience Cloud site or Salesforce Site in your org. At least one custom URL
is required per domain. For more information, see Add a Custom URL.
DNS Resolver
A server designed to receive DNS queries from web browsers and other applications. The resolver receives a hostname and uses the
DNS record for the hostname to return an IP address.
Domain Name
A company’s identity on the web. Domain names are human-friendly alphabetic versions of numeric IP addresses. In
https://www.example.com, the domain name is example.com. When you set up a custom domain in Salesforce, unless
you’re setting up a registrable domain, include the www. prefix in your domain name. See Point Your Custom Domain to Your
Salesforce Org.
Domain Name System (DNS)
A hierarchical and decentralized naming system for computers, services, or other resources connected to the internet or a private
network.
Fully Qualified Domain Name (FQDN)
All the parts of a domain required to look up this authority by name unambiguously using the internet’s DNS system. For example,
www.example.com.
HTTP, HTTPS
Hypertext Transfer Protocol, a communications protocol used to connect to web servers on the internet or on a local network
(intranet). Hypertext Transfer Protocol Secure (HTTPS) is a protocol that secures communication and data transfer between a user’s
web browser and a website.
HTTP Strict Transport Security (HSTS)
A response header that declares that others access the website using HTTPS only, and instructs requesters to convert any future
attempts to access the website using HTTP automatically to HTTPS. This highly recommended option helps to protect against
man-in-the-middle attacks. For more information, see Enable HSTS Preloading on a Custom Domain.
IP Address
A unique string of characters that identifies a device using the Internet Protocol to communicate over the internet or a local network.
IP addresses come in two formats: IPv4 addresses such as 255.255.255.0, which contain only numbers, or IPv6 addresses such as
2001:0db8:95a3:0000:0000:8c2f:0730:9155, which can contain numbers and letters.
Naked Domain
See registrable domain.
Registrable Domain
Your unique domain name that you obtained from a domain registrar. The registrable domain of your site is likely your homepage
and the highest page in your site hierarchy. Subdomains or pages can be built off the registrable domain, but each page’s URL must
include the registrable domain to be a part of your site. An example of a registrable domain name is example.com.
Root Domain
See registrable domain.
Path
In a URL, the path refers to the exact location of a page, post, file, or other asset. It can be analogous to the underlying file structure
of the website. The path resides after the hostname and is separated by “/”.

665
Extend Salesforce with Clicks, Not Code Extend the Reach of Your Organization

Proxy Server
A proxy server is a dedicated computer or a software system that acts as an intermediary between an endpoint device, such as a
computer, and another server. When a user or client makes a request—for example, by visiting a URL or loading an image— the
proxy routes the request. The proxy server can exist in the same machine as a firewall server or it can exist on a separate server, which
forwards requests.
Public-Private Key Pair
Two related encryption keys used in public-key cryptography. When data is encrypted with the public key, that data can be decrypted
only with the matching private key. The owner of the key pair makes the public key available to anyone but keeps the private key
secret. CA-signed HTTPS certificates use a public-private key pair to establish the security of data transmission.
Subdomain
A division of your main domain, often used for a different content type or for a separate business unit. For example,
https://shop.example.com points to your site’s store, while blog.example.com points to the site’s blog. A subdomain
is considered a standalone site. It’s related to, but distinct from, the main domain.

Note: www is a subdomain that identifies your site as part of the World Wide Web.

Subdirectory or Subfolder
Subfolders are a further division of your domain to organize and navigate to different sections of your website. For instance:
shop.example.com/newproducts or blog.example.com/faq.
Top-Level Domain (TLD)
The level of the domain hierarchy that identifies sites based on their commonality of geography (.ca, .au) or purpose (.com,
.org).
Uniform Resource Identifier (URI)
A string that identifies a resource on the internet or an intranet. There are two types of URIs: URLs and URNs.
Uniform Resource Locator (URL)
A unique identifier that specifies the location of a resource on the internet or an intranet.
Uniform Resource Name (URN)
A persistent and location-independent identifier that specifies the name of a resource on the internet or an intranet.
Web Application Firewall (WAF)
A web application firewall protects web applications for potential attacks, such as cross-site scripting (XSS), injection attacks, sensitive
data exposure, and security misconfigurations. It analyzes each HTTP or HTTPS request at the application layer.

SEE ALSO:
Custom Domains

Extend the Reach of Your Organization

Sometimes your users need to work with data and services that are outside your Salesforce org. There’s a variety of ways you can provide
seamless access across org boundaries.

Provide Actions, Buttons, and Links

Buttons and links let users interact with Salesforce data and with external websites and services, such as search engines and online
maps. Salesforce includes several standard buttons and links. You can also create custom ones. Actions let users do tasks, such as
create records in the Chatter publisher and in the Salesforce app.

666
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

External Services
Connect your Salesforce org to an external API using zero lines of code. Use declarative tools and OpenAPI specifications to describe
the external API functionality, and External Services automatically creates invocable actions within Salesforce. Use External Services
for outbound integrations from Salesforce using low code, process-based integrations or to turbo charge your Apex integrations.
Call the invocable actions natively from Apex, or create a flow or Einstein bot that interacts with the external API source.
Access External Data With Salesforce Connect
Salesforce Connect lets your users view, search, and modify data that’s stored outside your Salesforce org. Instead of copying the
data into standard or custom objects, use external objects to access the data in real time via web service callouts.
Work with External Data Sources
An external data source specifies how to access an external system. Salesforce Connect uses external data sources to access data
that's stored outside your Salesforce organization. Files Connect uses external data sources to access third-party content systems.
External data sources have associated external objects, which your users and the Lightning platform use to interact with the external
data and content.
Connect Business Processes with Real-Time Events
Publish and subscribe to platform events to connect business processes in Salesforce and external sources through the exchange
of real-time event data. Also, use event relays to integrate platform events and change data capture events with Amazon EventBridge.
Sync Data Between Salesforce and Heroku
Heroku Connect lets you sync data between Salesforce and Heroku Postgres.
Organization Sync
This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced Salesforce org. Users could
access a subset of Salesforce data in that org when the primary org was unavailable.

Provide Actions, Buttons, and Links

Buttons and links let users interact with Salesforce data and with external websites and services,
EDITIONS
such as search engines and online maps. Salesforce includes several standard buttons and links.
You can also create custom ones. Actions let users do tasks, such as create records in the Chatter Available in: both Salesforce
publisher and in the Salesforce app. Classic and Lightning
Experience
Action Types Available in: All Editions
There are several categories of actions, such as standard Chatter actions, default actions, mobile
smart actions, custom actions, and productivity actions. The types of actions you see depends
on the age and configuration of your org. USER PERMISSIONS
Custom Buttons and Links To create or edit buttons,
Custom buttons and links help you integrate Salesforce data with external URLs, applications, links, and actions:
your company’s intranet, or other back-end office systems. • Customize Application

667
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Types
There are several categories of actions, such as standard Chatter actions, default actions, mobile
EDITIONS
smart actions, custom actions, and productivity actions. The types of actions you see depends on
the age and configuration of your org. Available in: both Salesforce
Which actions are available in the full Salesforce site depends on whether your org has Chatter, Classic (not available in all
feed tracking, and actions in the publisher enabled. Actions in the Salesforce mobile app don’t rely orgs) and Lightning
on whether Chatter or actions in the publisher are enabled. For how Chatter enablement affects Experience
action visibility, see Actions With and Without Chatter on page 695.
Quick actions available in:
Group, Professional,
Standard Chatter Actions Enterprise, Performance,
Standard Chatter actions are available only when Chatter is enabled. The standard Chatter Unlimited, Contact
actions are Post, Poll, Question, and Announcements (groups only). Salesforce Classic standard Manager, Database.com,
actions also include File, Link, and Thanks (WDC). Standard actions are supported in both the and Developer Editions
full Salesforce site and in the Salesforce mobile app. Custom canvas actions
Default Actions available in: Professional
Default actions are sets of predefined actions to get you and your users started using actions (with Canvas enabled),
in your org. Add default actions to publisher layouts to make them available to your users in Enterprise, Performance,
Unlimited, and Developer
the full Salesforce site and the action bar in the Salesforce mobile app.
Editions
Mobile Smart Actions
Mobile smart actions are a set of preconfigured quick actions. They are available for account,
case, contact, lead, and opportunity pages and on the global publisher layout in the Salesforce mobile app. You can use them to set
up quick actions for mobile users with little effort.
Productivity Actions
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.
Quick Actions
Quick actions enable users to do more in Salesforce and in the Salesforce mobile app. With custom quick actions, you can make your
users’ navigation and workflow as smooth as possible by giving them convenient access to information that’s most important. For
example, you can let users create or update records and log calls directly in their Chatter feed or from their mobile device.
Mass Quick Actions
With mass quick actions, users can create or update up to 100 records from a list view or related list. Users can select one record in
the list to update only that record, or multiple records to perform bulk updates. To help users understand the changes they’re making,
the action window includes a Fields to update section when users update more than one record.
Actions in Lightning Experience
In Lightning Experience, actions appear in the Global Actions menu in the header, on related lists, and on list view items. Actions
also appear on a record page, in one of several places depending on the action’s type.
Salesforce Mobile App Action Bar
Salesforce mobile app users have a one-stop place to find actions, so there’s no confusion about where to go to do something. The
action bar and its associated action menu collect actions from different places in the app into a single, unified home.

Standard Chatter Actions

Standard Chatter actions are available only when Chatter is enabled. The standard Chatter actions are Post, Poll, Question, and
Announcements (groups only). Salesforce Classic standard actions also include File, Link, and Thanks (WDC). Standard actions are
supported in both the full Salesforce site and in the Salesforce mobile app.

668
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

You can customize the order in which standard Chatter actions appear, but you can’t edit their properties. To see standard Chatter actions
on an object, the object must have feed tracking enabled.
Only standard Chatter actions appear on the user profile page, regardless of which actions are assigned to the User Page Layout or the
global publisher layout. Similarly, only standard Chatter actions appear on reports, regardless of which other actions are assigned to the
global publisher layout.
Which actions are available in the full Salesforce site depends on whether your org has Chatter, feed tracking, and actions in the publisher
enabled. Actions in the Salesforce mobile app don’t rely on whether Chatter or actions in the publisher are enabled. For how Chatter
enablement affects action visibility, see Actions With and Without Chatter on page 695.

Default Actions
Default actions are sets of predefined actions to get you and your users started using actions in
EDITIONS
your org. Add default actions to publisher layouts to make them available to your users in the full
Salesforce site and the action bar in the Salesforce mobile app. Available in: both Salesforce
Each default action has a predefined set of fields. Use the page layout editor or global publisher Classic (not available in all
layout to remove actions or to change the order in which the actions appear. Default actions are orgs) and Lightning
supported on the account, case, contact, lead, and opportunity objects. Experience

This table lists the available default actions. Italicized actions are standard Chatter actions. Available in: Essentials,
Group, Professional,
Note: In orgs created after Winter ’14, Salesforce adds default actions to the global publisher Enterprise, Performance,
layout and to the account, case, contact, lead, and opportunity object page layouts. In orgs Unlimited, Contact
created before Winter ’14, default actions are available in the palette on the page layout Manager, and Developer
editor, but they’re not automatically added to the page layouts. Editions

Layout Page Default Actions

Global layout (also applies to custom objects) • Post
• File
• New Event
• New Task
• New Contact
• Log a Call (logged calls are saved as
completed tasks)
• New Opportunity
• New Case
• New Lead
• Thanks
• Link
• Poll
• Question

Account • Post
• File
• New Event
• New Task

669
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Layout Page Default Actions

• New Contact
• New Case
• Log a Call (logged calls are saved as completed tasks)
• New Note
• New Opportunity
• Thanks
• Link
• Poll
• Question

Case • Post
• File
• New Child Case
• Log a Call (logged calls are saved as completed tasks)
• New Task
• New Event
• Thanks
• Link
• Poll
• Question

Contact, Lead, and Opportunity • Post

• File
• New Task
• Log a Call (logged calls are saved as completed tasks)
• New Case
• New Note
• New Event
• Thanks
• Link
• Poll
• Question

Note: Using record types in your org can affect the availability of global default actions for your users. For more information, see
Quick Actions and Record Types on page 706.

670
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Default Action Fields

Each default action includes a pre-defined set of fields, which lets you make actions available to your users without spending a lot
of time on setup.

SEE ALSO:
Quick Actions

Default Action Fields

Each default action includes a pre-defined set of fields, which lets you make actions available to
EDITIONS
your users without spending a lot of time on setup.
These fields are included on each default action and appear in the action layout in the order listed. Available in: both Salesforce
Classic and Lightning
Action Fields Experience

Log a Call Available in: Essentials,

• Subject (default value: Call)
Group, Professional,
• Comment (description) Enterprise, Performance,
• Name Unlimited, Contact
Manager, and Developer
• Related To
Editions
New Case and New Child Case • Contact Name
• Status
• Subject
• Description

New Contact • Name

• Email
• Phone
• Account Name
• Title

New Event • Subject

• Start
• End
• All-Day Event
• Name
• Related To
• Assigned To
• Location

New Lead • Name

• Email
• Phone

671
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Fields
• Company
• Title

New Note • Title

• Public (checkbox)
• Body

New Opportunity • Opportunity Name

• Account
• Close Date (default value: 30 days from today)
• Stage
• Amount

New Task • Subject

• Due Date
• Name
• Related To
• Assigned To
• Status

You can change the fields that appear on each action layout using the action layout editor.

SEE ALSO:
Default Actions
Quick Actions

Mobile Smart Actions

Mobile smart actions are a set of preconfigured quick actions. They are available for account, case,
EDITIONS
contact, lead, and opportunity pages and on the global publisher layout in the Salesforce mobile
app. You can use them to set up quick actions for mobile users with little effort. Available in: both Salesforce
Note: Mobile smart actions don’t appear in the full Salesforce site, regardless of which page Classic (not available in all
orgs) and Lightning
layouts you add them to. They appear only to users in the Salesforce mobile app.
Experience
Mobile smart actions are populated with all your org’s required fields on the relevant object,
regardless of how many fields there are. For example, the New Case action in the mobile smart Available in: Group,
action bundle includes all required case fields. You can’t edit the fields on mobile smart actions. Professional, Enterprise,
The fields that appear change only if you change which fields on an object are required. Performance, Unlimited,
Contact Manager,
Database.com, and
Developer Editions

672
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

You also can’t change which actions are included as part of a mobile smart actions bundle—removing New Event or adding a custom
action, for example. To create a more customized set of actions, create the actions you want, add them to the relevant page layouts,
and remove the mobile smart actions bundle.
Mobile smart actions appear as a single action element in the page layout editor. In the Salesforce mobile app, the Mobile Smart Actions
element expands to distinct create actions that enable users to create records directly from the action bar.
Here’s what the mobile smart action element on each supported object expands to include. The actions appear in the action bar and
menu in the order shown.

Layout Actions Included in Mobile Smart Action Bundle

Global layout (also applies to custom objects) • New Task
• New Contact
• Log a Call (logged calls are saved as completed tasks)
• New Opportunity
• New Case
• New Lead

Account • New Task

• New Contact
• New Case
• Log a Call (logged calls are saved as completed tasks)
• New Note
• New Opportunity

Case • New Child Case

• Log a Call (logged calls are saved as completed tasks)
• New Task
• New Event

Contact • New Task

• Log a Call (logged calls are saved as completed tasks)
• New Case
• New Note
• New Event

Lead • New Task

• Log a Call (logged calls are saved as completed tasks)
• New Case
• New Note
• New Event

Opportunity • New Task

673
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Layout Actions Included in Mobile Smart Action Bundle

• Log a Call (logged calls are saved as completed tasks)
• New Case
• New Note
• New Event

SEE ALSO:
Quick Actions
Set Up Actions with Chatter Enabled

Productivity Actions
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.
You can customize the layout of the Call productivity action. The Call action uses the layout of the global Log a Call quick action, which
you can edit. You can also customize the Call action for different objects. When you create a Log a Call quick action for an object, you
see your custom Log a Call action’s layout when you tap Call from that object in the Salesforce mobile app.
Productivity actions appear on these objects.
• Account
• Contact
• Event
• Lead
• User
• User Profile
Productivity actions are supported in Lightning Experience and the Salesforce mobile app.

Tip: When selecting a record type, do not use Master. Master acts as a placeholder record type that is not accessible to most
profiles. Instead, select a specific record type.

674
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Quick Actions
Quick actions enable users to do more in Salesforce and in the Salesforce mobile app. With custom
EDITIONS
quick actions, you can make your users’ navigation and workflow as smooth as possible by giving
them convenient access to information that’s most important. For example, you can let users create Available in: both Salesforce
or update records and log calls directly in their Chatter feed or from their mobile device. Classic (not available in all
Quick actions can also invoke Lightning components, flows, Visualforce pages, or canvas apps with orgs) and Lightning
functionality that you define. For example, you can create a custom action so that users can write Experience
comments that are longer than 5,000 characters. Or create one that integrates a video-conferencing
application so that support agents can communicate visually with customers. Quick actions available in:
Group, Professional,
Create quick actions, and add them to your Salesforce Classic home page, to the Chatter tab, to Enterprise, Performance,
Chatter groups, and to record detail pages. Choose from standard quick actions, such as create and Unlimited, Contact
update actions, or create custom actions based on your company’s needs. Manager, Database.com,
and Developer Editions
Note: Custom quick actions aren’t supported in Chatter groups with customers.
Custom canvas actions
In Salesforce Classic, quick actions appear in the Chatter publisher when Chatter Settings are enabled. available in: Professional
In Lightning Experience, they appear in different areas of the user interface, depending on the (with Canvas enabled),
action’s type. In the Salesforce mobile app, actions of all types appear in the action bar, the action Enterprise, Performance,
bar’s action menu, and as list-item actions. Unlimited, and Developer
Editions
Quick actions come in two flavors.

Object-specific quick actions

Object-specific actions have automatic relationships to other records. Users can quickly create or update records, log calls, send emails,
and more in the context of a particular object. For example, you add an object-specific action on the Account object that creates contacts.
If a user creates a contact with that action on the detail page for the Acme account, that new contact is associated with Acme.

Global quick actions

You create global quick actions in a different place in Setup than object-specific actions. They’re called global actions because they can
be put anywhere actions are supported. Users can log call details, create records, or send email, all without leaving the page they’re on.
There are several types of object-specific and global quick actions.
• Create actions let users create records—like New Contact, New Opportunity, and New Lead. Global create actions enable users to
create object records, but the new record has no direct relationship with other records. Object-specific create actions create records
that are automatically associated with related records. They’re different from the Quick Create and Create New features on the
Salesforce Classic home page, because create actions respect validation rules and field requiredness, and you can choose each
action’s fields.
• Update actions let users make changes to a record.
• Log a Call actions let users record the details of phone calls or other customer interactions. These call logs are saved as completed
tasks. Object-specific Log a Call actions let users enter notes about calls, meetings, or other interactions that are related to a specific
record.
• Custom actions invoke Lightning components, flows, Visualforce pages, or canvas apps with functionality that you define. Use a
Visualforce page, Lightning component, or a canvas app to create global custom actions for tasks that don’t require users to use
records that have a relationship to a specific object. Object-specific custom actions invoke Lightning components, flows, Visualforce
pages, or canvas apps that let users interact with or create records that have a relationship to an object record.

675
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• Object-specific Send Email actions, available only on cases, give users access to a simplified version of the Case Feed Email action in
the Salesforce mobile app. You can use the case-specific Send Email action in Salesforce Classic, Lightning Experience, and the
Salesforce mobile app.
• Global Send Email actions are supported only in Lightning Experience. You can’t add them to the Cases layout or use them with
cases.
• Question actions enable users to ask and search for questions about the records that they’re working with.
For create, Log a Call, and custom actions, you can create either object-specific actions or global actions. Update actions must be
object-specific.

Global Quick Actions

You can add global quick actions to almost any page that supports actions. Use global actions to let users log call details, create or
update records, or send email, all without leaving the page they’re on. Global create actions enable users to create object records,
but the new record has no direct relationship with other records.
Object-Specific Actions
Object-specific actions let users quickly create or update records, log calls, send emails, and more, in the context of a particular object.
Lightning Component Actions
Lightning component actions are custom actions that invoke a Lightning component. They support Apex and JavaScript and provide
a secure way to build client-side custom functionality. Lightning component actions are supported only in the Salesforce mobile
app and Lightning Experience.
Lightning Web Component Actions
Lightning web component (LWC) actions are custom quick actions that invoke a Lightning web component. They support JavaScript
and provide a secure way to build client-side functionality. LWC actions are supported only on record pages in Lightning Experience.
Flow Actions
Flow actions are custom actions that render a flow. They provide a secure way to build custom functionality without writing code.
Flow actions are supported only in the Salesforce mobile app and Lightning Experience.
Visualforce Pages as Object-Specific Custom Actions
A Visualforce page added as a custom action on an object is invoked in the context of a record of that object type. The custom action
is passed a specific record ID—the record the user was looking at when the user clicked the custom action. Design the page to act
on that specific record type.
Enable Actions in the Chatter Publisher
Enabling actions in the publisher lets you add actions that you’ve created to the Chatter publisher. Actions appear on the Home
page, on the Chatter tab, in Chatter groups, and on record detail pages.
Action Layout Editor
Just as object record pages have page layouts that can be customized, actions have action layouts that can be customized. When
you create an action, Salesforce populates its layout with a default set of fields. You can add, remove, or reorder fields on the action
layout to present only the essential items your users need when they’re taking the action.
Custom Success Messages for Quick Actions
For Create a Record, Update a Record, and Log a Call action types, you can create a custom message that displays when the action
executes successfully.
Customize Actions with the Enhanced Page Layout Editor
Use the page layout editor to customize which actions show up in Salesforce and in the Salesforce mobile app.

676
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Set Predefined Field Values for Quick Action Fields

When you create actions, use predefined field values to set a value for a field. Predefined values can help ensure consistency and
make it faster and easier for users to create records.
Global Publisher Layouts
Global publisher layouts determine the global actions that appear in the various Salesforce interfaces. In Salesforce Classic and
Lightning Experience, these layouts customize the actions on global pages (like the Home page) and on the Chatter page. Lightning
Experience also uses these layouts to populate the Global Actions menu. And in the Salesforce mobile app, these layouts drive the
actions that appear in the action bar on the Feed and People pages. Global publisher layouts can include global actions only.
Quick Actions and Record Types
Using record types in your organization can affect the availability of quick actions for your users.
Actions Best Practices
Use these tips as you set up actions.
Quick Action Considerations
Keep these considerations in mind when working with quick actions.
Troubleshooting Actions
Action Limits and Limitations
Actions can work differently than you expect in certain situations and for different objects. Keep these limits and limitations in mind
when working with actions.

SEE ALSO:
Set Up Actions with Chatter Enabled
Actions Best Practices
Quick Action Considerations

Global Quick Actions

You can add global quick actions to almost any page that supports actions. Use global actions to
EDITIONS
let users log call details, create or update records, or send email, all without leaving the page they’re
on. Global create actions enable users to create object records, but the new record has no direct Available in: Salesforce
relationship with other records. Classic and Lightning
Experience
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 Available in: Group,
implementations. Professional, Enterprise,
Performance, Unlimited,
Note: Global quick actions aren’t context-aware, so fields can’t be populated with information
Contact Manager,
from the current page. Instead, add the appropriate quick action to a page to specify Database.com, and
predefined fields. Developer Editions
Global actions live on a special layout of their own, known as the global publisher layout. The layout
isn’t associated with an object, and it populates the global actions menu in Lightning Experience.
Users can access the global actions menu by clicking in the Salesforce header.
If an object page layout isn’t customized with actions, the actions on those object record pages are inherited from the global publisher
layout.
You can do lots of different things with global quick actions.

677
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• To let users send emails from anywhere in Lightning Experience, add a Send Email action to the global layout. Add a Send Email
action to any page layout for objects that are enabled for activities. Global Send Email actions are supported only in Lightning
Experience. You can’t add a global Send Email action to the Cases layout or use the action with cases.

Note: To let users send emails from anywhere in Lightning Experience, keep a Send Email action on the global publisher
layout, in the Salesforce Mobile and Lightning Experience Actions section.

• To let users record call details, add Log a Call actions to global layouts. For example, users can log calls from global pages in Salesforce
Classic, such as the Home page and the Chatter tab, or in the Salesforce mobile app from the Feed or Groups pages. In Lightning
Experience, Log a Call actions on global layouts display in the Global Actions menu.
If you have multiple Log a Call actions and use simpler task forms on the Salesforce mobile app, mobile users see the first valid Log
a Call action listed for the mobile publisher layout.

• Use a Visualforce page, Lightning component, or a canvas app to create global custom actions for tasks that don’t require users to
use records that have a relationship to a specific object. Canvas apps that you want to use as custom actions require Publisher as a
location. Visualforce pages that you want to use as global custom actions can’t use standard controllers. For example, you want a
custom action that lets users enter a street address and see a map, the local time, and the local weather. For this action, create a
Visualforce page that doesn’t use any of the standard controllers, and add it as a custom global action.
You can find out more about canvas apps and custom actions in the Salesforce Mobile App Developer Guide.

• You can also use a global Create a Record quick action to enable your Salesforce for Outlook users to create records directly from
the Salesforce side panel. For more information, see Email Application Publisher Layouts.

Note:
• Chatter groups with customers don’t support global create, log a call, or custom actions and display only standard Chatter
actions, such as Post, File, Link, and Poll.
• Actions to create records for an object that is the detail object in a master-detail relationship must be object-specific, not
global.

Supported Objects for Create Actions

You can create global actions to let users create many kinds of records, including:
• Account
• Asset
• Badge
• Campaign
• Case
• Contact
• Contract
• Custom objects
• Event (without invitees)
• Goal
• Group
• Knowledge object
• Lead
• Note

678
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• Opportunity
• Orders
• Person Account
• Question
• Reward
• Task
• Work Order

Create Global Quick Actions

You can add global actions to any page that supports actions, like the Home page, the Chatter tab, object pages, and custom
Lightning app pages. For example, add a Log a Call action to global layouts so users can record call details right from a Chatter thread.

SEE ALSO:
Object-Specific Actions
Actions With and Without Chatter
Quick Action Considerations
Quick Actions

Create Global Quick Actions

You can add global actions to any page that supports actions, like the Home page, the Chatter tab,
USER PERMISSIONS
object pages, and custom Lightning app pages. For example, add a Log a Call action to global
layouts so users can record call details right from a Chatter thread. To create actions:
1. From Setup, in the Quick Find box, enter Actions, and then select Global Actions. • Customize Application

2. Click New Action.

3. Select the type of action to create.
4. Customize the action.
For a Create a Record action, select the type of object to create. If the object has more than one record type, select the one that you
want to use for records created through this action.
For a Custom Visualforce or Custom Canvas action, select a Visualforce page or canvas app, and then specify the height of the action
window. The width is fixed.
For a Lightning Component action, select the component to be called by the action.

Note: While you can create Lightning Web Component global actions and add them to the Global Publisher Layout, these
actions are available for use only in the Salesforce Field Service (SFS) mobile app. These actions aren’t available in Lightning
Experience on mobile or desktop.

5. Enter a label for the action. Users see this label as the name of the action.

Tip: You can choose an option from the Standard Label Type list to have Salesforce generate the label. For the labels in this
list that include [Record] and [Record Type], Salesforce fills in the type of object or the record type the action creates. For
example, if you choose the Create New [Record] standard label on a create contact action, the generated label is Create New
Contact.

6. If necessary, change the name of the action. If you selected a standard label type in the previous step, you must enter the name.

679
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

This name is used in the API and managed packages. It must begin with a letter and use only alphanumeric characters and underscores,
and it can’t end with an underscore or have two consecutive underscores. Unless you’re familiar with working with the API, we don’t
recommend editing this field.
7. Type a description for the action.
The description appears on the detail page for the action and in the list on the Buttons, Links, and Actions page. The description isn’t
visible to your users. If you’re creating several actions on the same object, use a detailed description, such as “Create Contact on
Account using New Client record type.”
8. Select to post a feed item in the record feed when the action’s completed.
When enabled, Create Feed Item causes the creation of a feed item when the action is performed. The target object’s compact
layout defines the feed item’s fields.
When feed tracking is enabled for the object, and All Related Objects is selected, performing the action causes the creation of a
feed item. The feed item is created, regardless of whether Create Feed Item is selected.

9. For a Create a Record, Update a Record, or Log a Call action, you can add a custom success message. The success message displays
after the action executes successfully.
10. Optionally, to select a different icon for the action, click Change Icon.
Custom images used for action icons must be less than 1 MB

11. Save your changes.

After you create a quick action, customize its layout, add predefined values, and then add the action to page layouts.

Tip: If you delete an action, the action is removed from all layouts that it’s assigned to.

SEE ALSO:
Set Predefined Field Values for Quick Action Fields
Customize Actions with the Enhanced Page Layout Editor
Custom Success Messages for Quick Actions
Visualforce Pages as Object-Specific Custom Actions

680
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Object-Specific Actions
Object-specific actions let users quickly create or update records, log calls, send emails, and more,
EDITIONS
in the context of a particular object.
Object-specific create actions create records that are automatically associated with related records. Available in: both Salesforce
For example, you add an object-specific action on the Account object that creates contacts. If a Classic (not available in all
user creates a contact with that action on the detail page for the Acme account, that new contact orgs) and Lightning
is associated with Acme. Experience

Object-specific actions are only available on page layouts for that object. For example, you can add Quick actions available in:
the New Group Member action only to the group publisher layout. Group, Professional,
When a user creates a record by using an object-specific create action, a feed item for that record Enterprise, Performance,
appears: Unlimited, Contact
Manager, Database.com,
• In the feed for the record on which the new record was created
and Developer Editions
• As the first entry in the feed for the new record
Custom canvas actions
• In the Chatter feed of the user who created the record available in: Professional
• In the user profile feed for the user who created the record (with Canvas enabled),
Enterprise, Performance,
• In the Chatter feed of any users who follow the record on which the record was created
Unlimited, and Developer
• In the Chatter feed of any users who, through custom triggers or auto-follow rules for new Editions
records, automatically follow the new record
There are several types of object-specific quick actions.
• Object-specific Create a Record actions create records that are associated with related records.
• Object-specific Log a Call actions let users enter notes about calls, meetings, or other interactions that are related to a specific record.

Note: Make sure that you have only one Log A Call action on your page layout, or mobile users see the full Task layout when
they click Call on their mobile devices.

• Object-specific Update a Record actions make it easy for users to edit records. You can define the fields that are available for update.
• Object-specific custom actions invoke Lightning components, flows, Visualforce pages, or canvas apps that let users interact with
or create records that have a relationship to an object record. The Visualforce page for an object-specific custom action must include
the standard controller for the relevant object. For example, use the standard contact controller to create a custom action that lets
users import a contact’s Twitter profile and add that information to a contact record.
• Object-specific Send Email actions, available only on cases, give users access to a simplified version of the Case Feed Email action in
the Salesforce mobile app. You can use the case-specific Send Email action in Salesforce Classic, Lightning Experience, and the
Salesforce mobile app.

Supported Objects
When you create an object-specific action, you can choose as a target object an event, a task, or any object that has a parent-child or
lookup relationship to the host object. You can’t choose Quote as a target object from Opportunity. However, you can still create quotes
from an opportunity by going to the opportunity’s Quotes related list and clicking New.
You can create object-specific actions on many objects, including:
• Account
• Campaign
• Case
• Contact

681
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• ContentNote
• Custom objects
• Group
• Lead
• Opportunity

Create Object-Specific Quick Actions

Object-specific actions let users create records with automatic relationships to other records, make updates to specific records, and
interact with records in ways that you define.

SEE ALSO:
Global Quick Actions
Actions With and Without Chatter
Quick Action Considerations
Quick Actions
Send Email Action Considerations for Cases

Create Object-Specific Quick Actions

Object-specific actions let users create records with automatic relationships to other records, make
EDITIONS
updates to specific records, and interact with records in ways that you define.

Important: Where possible, we changed noninclusive terms to align with our company Available in: both Salesforce
value of Equality. We maintained certain terms to avoid any effect on customer Classic (not available in all
orgs) and Lightning
implementations.
Experience
1. From the management settings for the object for which you want to create an action, go to
Buttons, Links, and Actions. Available in: Group,
Professional, Enterprise,
2. Click New Action. Performance, Unlimited,
3. Select the type of action to create. Contact Manager,
Database.com, and
4. Customize the action.
Developer Editions
• For a Create a Record action, select the type of object to create.
– If the object has more than one record type, select the one you want to use for records USER PERMISSIONS
created through this action.
– If the object for which you’re creating the action has multiple relationships with the To create actions:
target object, select the field to populate when a record’s created. If the two objects • Customize Application
have a master-detail relationship, you can’t select which field to populate. The
master-detail Relationship field is selected by default, and you can’t change this
setting. Set the Relationship field to Read-Only so that users can view the field on the object.
– You can’t choose Quote as a target object from Opportunity. However, you can still create quotes from an opportunity by
going to the opportunity’s Quotes related list and clicking New.

• For a Custom Visualforce action, select the Visualforce page, and then specify the height of the action window. The width is
fixed.
• For a Lightning Component action, select the component called by the action.

682
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• For a flow action, select the flow to render.

5. Enter a label for the action. Users see this label as the name of the action.

Tip: You can choose an option from the Standard Label Type list to have Salesforce generate the label. For the labels in this
list that include “Record” and “Record Type,” Salesforce fills in the type of object or the record type the action creates. For
example, if you choose the Create New “Record” standard label on a create contact action, the generated label is Create New
Contact.

6. If necessary, change the name of the action. If you selected a standard label type in the previous step, you must enter the name.
This name is used in the API and managed packages. It must begin with a letter and use only alphanumeric characters and underscores,
and it can’t end with an underscore or have two consecutive underscores. Unless you’re familiar with working with the API, we
suggest not editing this field.
7. Type a description for the action.
The description appears on the detail page for the action and in the list on the Buttons, Links, and Actions page. The description isn’t
visible to your users. If you’re creating several actions on the same object, use a detailed description, such as “Create Contact on
Account using New Client record type.”
8. Select to post a feed item in the record feed when the action’s completed.
When enabled, Create Feed Item causes the creation of a feed item when the action is performed. The target object’s compact
layout defines the feed item's fields.
When feed tracking is enabled for the object, and All Related Objects is selected, performing the action causes the creation of a
feed item. The feed item is created, regardless of whether Create Feed Item is selected.

9. For a Create a Record, Update a Record, or Log a Call action, you can add a custom success message. The success message displays
after the action executes successfully.
10. Optionally, click Change Icon to select a different icon for the action.
Custom images used for action icons must be less than 1 MB in size.

11. Click Save.

After you create a quick action, customize its layout, add predefined values, and then add the action to page layouts.

Note: If you delete an action, the action is removed from all layouts that it’s assigned to.

SEE ALSO:
Set Predefined Field Values for Quick Action Fields
Customize Actions with the Enhanced Page Layout Editor
Visualforce Pages as Object-Specific Custom Actions
Custom Success Messages for Quick Actions

683
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Lightning Component Actions

Lightning component actions are custom actions that invoke a Lightning component. They support
EDITIONS
Apex and JavaScript and provide a secure way to build client-side custom functionality. Lightning
component actions are supported only in the Salesforce mobile app and Lightning Experience. Available in: both the
You can add Lightning component actions to an object’s page layout using the page layout editor. Salesforce mobile app and
If you have Lightning component actions in your org, you can find them in the Mobile & Lightning Lightning Experience
Actions category in the page layout editor’s palette.
Available in: Essentials,
Lightning component actions can’t call just any Lightning component in your org. For a component Group, Professional,
to work as a Lightning component action, it must be configured for that purpose and implement Enterprise, Performance,
either the force:LightningQuickAction or Unlimited, Contact
force:LightningQuickActionWithoutHeader interfaces. You must also set a default Manager, and Developer
value for each component attribute marked as required. Editions

If you plan on packaging a Lightning component action, the component the action invokes must
be marked as access=global.

Create a Lightning Component Action

Creating a Lightning component action is similar to creating a regular quick action, and you do it in the same place in Setup. All you
need is a Lightning component in your org for the quick action to trigger.

SEE ALSO:
Lightning Aura Components Developer Guide
Actions in Lightning Experience
Quick Action Considerations

Create a Lightning Component Action

Creating a Lightning component action is similar to creating a regular quick action, and you do it
EDITIONS
in the same place in Setup. All you need is a Lightning component in your org for the quick action
to trigger. Available in: Lightning
1. In Setup, click Object Manager, click the object that you want to create the action for, and Experience
click Buttons, Links, and Actions.
Available in: Group,
2. Click New Action. Professional, Enterprise,
3. For Action Type, select Lightning Component. Performance, Unlimited,
Contact Manager,
4. Select the component that you want the action to call. Database.com, and
5. Enter a label for the action. Users see this label as the name of the action. Developer Editions

Tip: You can choose an option from the Standard Label Type list to have Salesforce
generate the label. For the labels in this list that include “Record” and “Record Type,” USER PERMISSIONS
Salesforce fills in the type of object or the record type the action creates. For example, if
To create actions:
you choose the Create New “Record” standard label on a create contact action, the
• Customize Application
generated label is Create New Contact.

6. If necessary, change the name of the action. If you selected a standard label type in the previous
step, you must enter the name.

684
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

This name is used in the API and managed packages. It must begin with a letter and use only alphanumeric characters and underscores,
and it can’t end with an underscore or have two consecutive underscores. Unless you’re familiar with working with the API, we
suggest not editing this field.
7. Type a description for the action.
The description appears on the detail page for the action and in the list on the Buttons, Links, and Actions page. The description isn’t
visible to your users. If you’re creating several actions on the same object, we recommend using a detailed description, such as
“Create Contact on Account using New Client record type.”
8. Optionally, click Change Icon to select a different icon for the action.
When you’re finished creating your action, add it to the Salesforce Mobile and Lightning Experience Actions section of the desired page
layout, such as the case page layout, and your users can start using it!

SEE ALSO:
Add Quick Actions to the Case Page Layout for Lightning Experience

Lightning Web Component Actions

Lightning web component (LWC) actions are custom quick actions that invoke a Lightning web
EDITIONS
component. They support JavaScript and provide a secure way to build client-side functionality.
LWC actions are supported only on record pages in Lightning Experience. Available in: Lightning
Note: My Domain must be deployed in your org to use Lightning web component actions. Experience

Available in: Essentials,

You can add LWC actions to a record’s page layout using Dynamic Actions in the Lightning App
Group, Professional,
Builder. If you have LWC actions in your org, you can find them in the Lightning Actions category
Enterprise, Performance,
in the page layout editor’s palette. Unlimited, Contact
For a component to work as an LWC action, it must be configured for that purpose and implement Manager, and Developer
either the Action or ScreenAction target. For more information, see Configure a Component Editions
for Quick Actions in the Lightning Web Components Developer Guide.

Create a Lightning Web Component Action

Creating a Lightning web component (LWC) action is similar to creating a regular quick action, and you do it in the same place in
Setup for most supported objects. All you need is an LWC in your org for the quick action to trigger.

SEE ALSO:
Lightning Web Components Developer Guide
Actions in Lightning Experience
Quick Action Considerations

685
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Create a Lightning Web Component Action

Creating a Lightning web component (LWC) action is similar to creating a regular quick action, and
EDITIONS
you do it in the same place in Setup for most supported objects. All you need is an LWC in your org
for the quick action to trigger. Available in: Lightning
You can create a Lightning web component action for custom objects and for Salesforce record Experience
home objects that are enabled for LWC. If you can’t create actions with the Lightning Web
Available in: Group,
Component action type, they’re not currently supported for that object.
Professional, Enterprise,
Note: When feed tracking is enabled for cases, you can’t use the page layout to add a Performance, Unlimited,
Lightning web component action to the Highlights Panel of a case record. Add Lightning Contact Manager,
web component actions to a case record page’s Highlights Panel as dynamic actions in Database.com, and
Developer Editions
Lightning App Builder.
1. From Setup, click Object Manager, click the object that you want to create the action for, and
then click Buttons, Links, and Actions. USER PERMISSIONS
2. Click New Action. To create actions:
3. For Action Type, select Lightning Web Component. • Customize Application

4. Select the component that you want the action to call.

5. Enter a label for the action. Users see this label as the name of the action.

Tip: You can choose an option from the Standard Label Type list to have Salesforce generate the label. For the labels in this
list that include Record and Record Type, Salesforce fills in the type of object or the record type the action creates. For example,
if you choose the Create New Record standard label on a create contact action, the generated label is Create New Contact.

6. If necessary, change the name of the action. If you selected a standard label type in the previous step, you must enter the name.
This name is used in the API and managed packages. It must begin with a letter and use only alphanumeric characters and underscores,
and it can’t end with an underscore or have two consecutive underscores. Unless you’re familiar with working with the API, we
suggest not editing this field.
7. Type a description for the action.
The description appears on the detail page for the action and in the list on the Buttons, Links, and Actions page. The description isn’t
visible to your users. If you’re creating several actions on the same object, we recommend using a detailed description, such as
“Create Contact on Account using New Client record type.”
8. Optionally, to select a different icon for the action, click Change Icon.
When you finish creating your action, add it to the Lightning Experience Actions section of the desired page layout, such as the opportunity
page layout, and your users can start using it.

Note: Lightning web component quick actions are available only on record pages in Lightning Experience. They’re not supported
in Aura Experience Builder sites or on the Salesforce mobile app. Orgs with the Salesforce Field Service (SFS) mobile app support
Lightning web component actions on additional objects. These actions appear only in the SFS mobile app and not in Lightning
Experience on mobile or desktop.

SEE ALSO:
Lightning Web Components Developer Guide: Use Quick Actions
Add Quick Actions to the Case Page Layout for Lightning Experience
Create Dynamic Actions in Lightning App Builder

686
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Flow Actions
Flow actions are custom actions that render a flow. They provide a secure way to build custom
EDITIONS
functionality without writing code. Flow actions are supported only in the Salesforce mobile app
and Lightning Experience. Available in: both the
You can add flow actions to an object’s page layout using the page layout editor. If you have flow Salesforce mobile app and
actions in your org, you can find them in the Mobile & Lightning Actions category in the page layout Lightning Experience
editor’s palette.
Available in: Essentials,
On Lightning Experience record pages, flow actions display in the page-level action menu in the Professional, Enterprise,
highlights panel. Performance, Unlimited,
and Developer Editions

Flow Action Considerations

Keep these considerations in mind before using flow actions.

Flow Action Considerations

Keep these considerations in mind before using flow actions.
EDITIONS
Flow Type
Flow actions support only flows that include screens. Available in: both the
Salesforce mobile app and
Flow Status
Lightning Experience
The flow must be active. If you later deactivate the flow, the action doesn’t appear at runtime.
Action Types Available in: Essentials,
Flow actions are available only as object-specific actions. Professional, Enterprise,
Performance, Unlimited,
Action Title and Developer Editions
The displayed title is the action’s label instead of its flow name. We recommend that you enter
the flow name as the action label. When you run a flow from a custom quick action, the title is
always displayed even if you configure the flow to hide the header.
Input Variables
Flow actions let you pass the value of the record's ID field into the flow, but that's it. If your flow has a Text input variable called
recordId, the action passes the record's ID into that variable at runtime. If not, it doesn't, and the flow tries to run anyway.
Help Text
A flow action’s screen-level help text isn’t available for feed-based page layouts.

687
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Visualforce Pages as Object-Specific Custom Actions

A Visualforce page added as a custom action on an object is invoked in the context of a record of
EDITIONS
that object type. The custom action is passed a specific record ID—the record the user was looking
at when the user clicked the custom action. Design the page to act on that specific record type. Available in: both Salesforce
Visualforce pages you create to use as object-specific actions must use a standard object controller. Classic (not available in all
Use controller extensions to add custom code, including @RemoteAction methods you can orgs) and Lightning
call using JavaScript remoting. Experience

Your custom code could do more than make updates to the originating record. For example, the Available in: Group,
Create Quick Order custom action searches for matching merchandise. It then creates an invoice Professional, Enterprise,
and line item, all as part of creating an order for a part. That logic occurs in the context of the Performance, Unlimited,
originating account record—the invoice is associated to the account record where the quick order Contact Manager,
action was invoked. Database.com, and
Developer Editions
The following code sample shows a page designed to be used as a custom action on the account
object, so it uses the standard Account controller. This action lets users create cases from account
detail pages, and it has a different user interface from standard create actions.
public with sharing class CreateCaseExtension {
private final SObject parent;
public Case theCase {get; set;}
public String lastError {get; set;}

public CreateCaseExtension2(ApexPages.StandardController controller) {

parent = controller.getRecord();
theCase = new Case();
theCase.accountId = parent.id;
lastError = '';
}

public PageReference createCase() {

createNewCase();
theCase = new Case();
theCase.accountId = parent.id;
return null;
}

private void createNewCase() {

try {
insert theCase;

FeedItem post = new FeedItem();

post.ParentId = ApexPages.currentPage().getParameters().get('id');
post.Body = 'created a case';
post.type = 'LinkPost';
post.LinkUrl = '/' + theCase.id;
post.Title = theCase.Subject;
insert post;
} catch(System.Exception ex){
lastError = ex.getMessage();
}
}
}

688
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

<apex:page standardcontroller="Account" extensions="CreateCaseExtension" showHeader="false">

<script type='text/javascript' src='/canvas/sdk/js/publisher.js'/>

<style>
.requiredInput .requiredBlock, .requiredBlock {background-color: white;}
.custompubblock div {display: inline-block;}
.custompublabel {width:54px;}
</style>
<script>
function refreshFeed() {
Sfdc.canvas.publisher.publish({name : 'publisher.refresh', payload :
{feed:true}});
}
</script>
<div>
<apex:form >
<apex:actionFunction action="{!createCase}" name="createCase" rerender="out"

oncomplete="refreshFeed();"/>
<apex:outputPanel id="out" >
<div class="custompubblock">
<div class="custompublabel">Account:</div><apex:inputField
value="{!theCase.accountId}"
style="margin-left:0;"/>&nbsp;&nbsp;&nbsp;
<div>Contact:&nbsp;</div><apex:inputField value="{!theCase.contactId}"
/>
</div>
<apex:inputField value="{!theCase.description}"
style="width:538px;height:92px;margin-top:4px;" />
<div class="custompubblock" style="margin-top:5px;">
<div>Status:&nbsp;</div><apex:inputField value="{!theCase.status}"
/>&nbsp;&nbsp;&nbsp;
<div>Priority:&nbsp;</div><apex:inputField value="{!theCase.priority}"
/>&nbsp;&nbsp;&nbsp;
<div>Case Origin:&nbsp;</div><apex:inputField value="{!theCase.origin}"
/>
</div>
</apex:outputPanel>
</apex:form><br/>
<button type="button" onclick="createCase();"
style="position:fixed;bottom:0px;right:0px;padding:5px 10px;
font-size:13px; font-weight:bold; line-height:
18px;background-color:#0271BF;background-image:-moz-linear-gradient(#2DADDC,
#0271BF);background-repeat:repeat-x;border-color:#096EB3;"
id="addcasebutton">Create Case</button>
</div>
</apex:page>

Note: When you redirect to a URL internal to your org, the action dialog closes upon completion or programmatically navigating
away. If you set up the redirect to point to an external URL, the behavior can vary because an external URL opens in a new browser
tab.

689
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Requirements for Refreshing Host Pages

If you want an object-specific or global custom action to refresh the feed on the page that hosts it, the Visualforce page you create to
use as that action must:
• Reference the publisher JavaScript file: <script type='text/javascript'
src='/canvas/sdk/js/publisher.js'/>. (Creating custom Visualforce actions doesn’t require the Canvas SDK.)
• Include this JavaScript call: Sfdc.canvas.publisher.publish({name : 'publisher.refresh', payload
: {feed:true}});.

Visualforce Pages as Global Custom Actions

Visualforce pages used as global actions can be invoked in many different places and don’t have a specific record associated with
them. They have complete “freedom of action,” which means it’s up to you to write the code.
Hide the Action Header for Visualforce Custom Actions
When creating a Visualforce page to use as a custom action, you can choose to hide the action’s header. Hiding the action header
helps prevent user confusion, especially if you have your own buttons specified in the Visualforce page.

SEE ALSO:
Visualforce Pages as Global Custom Actions
Create Object-Specific Quick Actions
Quick Actions

Visualforce Pages as Global Custom Actions

Visualforce pages used as global actions can be invoked in many different places and don’t have a
EDITIONS
specific record associated with them. They have complete “freedom of action,” which means it’s
up to you to write the code. Available in: both Salesforce
Visualforce pages you create to use as global actions can’t use a standard object controller. You Classic (not available in all
must write a custom controller to handle the page. orgs) and Lightning
Experience
When a global action completes, the user should be either redirected to a parent record created
as part of the action or returned to where they started. Available in: Group,
Professional, Enterprise,
This code sample shows a Visualforce page designed to be used as a custom action on any object
Performance, Unlimited,
that supports actions. This action lets users create cases from record detail pages, Chatter, Chatter
Contact Manager,
groups (except customer groups), or the home page. It has a different user interface from standard
Database.com, and
create actions. As with all global actions, the records created through this action aren’t associated
Developer Editions
with other records.

<!-- Custom controller -->

public with sharing class CreateCaseController {
public Case theCase {get; set;}
public String lastError {get; set;}
public CreateCaseController() {
theCase = new Case();
lastError = '';
}

public PageReference createCase() {

createNewCase();

690
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

theCase = new Case();

return null;
}

private void createNewCase() {

try {
insert theCase;

FeedItem post = new FeedItem();

post.ParentId = ApexPages.currentPage().getParameters().get('id');
post.Body = 'created a case';
post.type = 'LinkPost';
post.LinkUrl = '/' + theCase.id;
post.Title = theCase.Subject;
insert post;
} catch(System.Exception ex){
lastError = ex.getMessage();
}
}
}

<apex:page controller="CreateCaseController" showHeader="false">

<script type='text/javascript' src='/canvas/sdk/js/publisher.js'/>
<style>
.requiredInput .requiredBlock, .requiredBlock {background-color: white;}
.custompubblock div {display: inline-block;}
.custompublabel {width:54px;}
</style>

<script>
function refreshFeed() {
Sfdc.canvas.publisher.publish({name : 'publisher.refresh', payload : {feed:
true}});
}
</script>

<div>
<apex:form >
<apex:actionFunction action="{!createCase}" name="createCase" rerender="out"
oncomplete="refreshFeed();"/>
<apex:outputPanel id="out" >
<div class="custompubblock">
<div>Subject:&nbsp;</div><apex:inputField value="{!theCase.subject}"
style="width:500px;" />
</div>
<div class="custompubblock">
<div class="custompublabel">Account:</div><apex:inputField
value="{!theCase.accountId}"
style="margin-left:0;"/>&nbsp;&nbsp;&nbsp;
<div>Contact:&nbsp;</div><apex:inputField value="{!theCase.contactId}"
/>
</div>
<apex:inputField value="{!theCase.description}"

691
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

style="width:500px;height:92px;margin-top:4px;" />
<div class="custompubblock" style="margin-top:5px;">
<div>Status:&nbsp;</div><apex:inputField value="{!theCase.status}"
/>&nbsp;&nbsp;&nbsp;
<div>Priority:&nbsp;</div><apex:inputField value="{!theCase.priority}"
/>&nbsp;&nbsp;&nbsp;
<div>Case Origin:&nbsp;</div><apex:inputField value="{!theCase.origin}"
/>
</div>
<div style="color:red;">{!lastError}</div>
</apex:outputPanel>
</apex:form><br/>
<button type="button" onclick="createCase();"
style="position:fixed;bottom:0px;right:0px;padding:5px 10px;
font-size:13px; font-weight:bold; line-height:
18px;background-color:#0271BF;background-image:-moz-linear-gradient(#2DADDC,
#0271BF);background-repeat:repeat-x;
border-color:#096EB3;" id="addcasebutton">Create Case</button>
</div>
</apex:page>

Requirements for Refreshing Host Pages

To have an object-specific or global custom action refresh the feed on the page that hosts it, the Visualforce page you create to use as
that action must:
• Reference the publisher JavaScript file: <script type='text/javascript'
src='/canvas/sdk/js/publisher.js'/>. (Creating custom Visualforce actions doesn’t require the Canvas SDK.)
• Include this JavaScript call: Sfdc.canvas.publisher.publish({name : 'publisher.refresh', payload
: {feed:true}});.

SEE ALSO:
Visualforce Pages as Object-Specific Custom Actions
Create Global Quick Actions
Quick Actions

Hide the Action Header for Visualforce Custom Actions

When creating a Visualforce page to use as a custom action, you can choose to hide the action’s
EDITIONS
header. Hiding the action header helps prevent user confusion, especially if you have your own
buttons specified in the Visualforce page. Available in: both Salesforce
To hide the header, add showQuickActionVfHeader=“false” to the <apex:page> Classic (not available in all
tag of the custom action’s Visualforce page. When the Visualforce custom action renders in the orgs) and Lightning
Salesforce mobile app, the header and the Cancel and Save buttons are hidden. Using this attribute Experience
doesn’t affect how the action displays in the full Salesforce site. Available in: Group,
If you don’t specify showQuickActionVfHeader, its value defaults to true. Professional, Enterprise,
Performance, Unlimited,
Contact Manager,
Database.com, and
Developer Editions

692
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

The showQuickActionVfHeader attribute isn’t supported in Experience Cloud sites.

SEE ALSO:
Visualforce Pages as Object-Specific Custom Actions
Visualforce Pages as Global Custom Actions

Prerequisites for Using Canvas Apps as Custom Actions

Using canvas apps as custom actions makes it easy to give users access to the functionality of your
EDITIONS
apps in Chatter and elsewhere in Salesforce.
You can use as a custom action any canvas app that uses Publisher as a location. For example, you Available in: both Salesforce
might use an expense report app as a custom action to make it easy for salespeople to submit Classic (not available in all
expense reports directly from feeds. A custom action that includes a video conferencing canvas orgs) and Lightning
app could help support agents communicate with customers visually for easier troubleshooting of Experience
technical issues.
Quick actions available in:
Before creating a custom action with a canvas app, be sure the app uses Publisher as a location, Group, Professional,
and be sure to give the users you want to be able to use the action access to the app. Enterprise, Performance,
Unlimited, Contact
SEE ALSO: Manager, Database.com,
and Developer Editions
Visualforce Pages as Object-Specific Custom Actions
Custom canvas actions
Quick Actions
available in: Professional
(with Canvas enabled),
Enterprise, Performance,
Unlimited, and Developer
Editions

Enable Actions in the Chatter Publisher

Enabling actions in the publisher lets you add actions that you’ve created to the Chatter publisher.
USER PERMISSIONS
Actions appear on the Home page, on the Chatter tab, in Chatter groups, and on record detail
pages. To enable actions in the
Chatter publisher:
Available in: Salesforce Classic (not available in all orgs) • Customize Application

Available in: Group, Professional, Enterprise, Performance, Unlimited, Contact Manager,

Database.com, and Developer Editions

By default, the Salesforce Classic Chatter publisher includes the standard actions Post, File, Link, Poll, Question, and Thanks. With the
actions in the publisher setting enabled, you can include nonstandard actions in the Chatter publisher too. Nonstandard actions include
Create, Update, Log a Call, custom actions, and Mobile Smart Actions.
In organizations created after the Winter ‘14 release, actions in the publisher is enabled automatically.
1. From Setup, enter Chatter Settings in the Quick Find box, then select Chatter Settings.
2. Click Edit.
3. Select Enable Actions in the Publisher.

693
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Although the Enable Actions setting appears in Lightning Experience, it has no effect there.

4. Click Save.

Note: You aren’t required to enable actions in the publisher to use them in the Salesforce app or in third-party apps. See
Actions With and Without Chatter for more information.

Set Up Actions with Chatter Enabled

Global and object-specific actions enhance the Chatter experience for your users in Salesforce Classic and in the Salesforce app.
Set Up Actions Without Chatter Enabled
You can set up object-specific and global actions for the Salesforce mobile app or third-party apps, even if your org doesn’t have
Chatter enabled.
Actions With and Without Chatter
Use actions regardless of whether Chatter or actions in the publisher are enabled.

Set Up Actions with Chatter Enabled

Global and object-specific actions enhance the Chatter experience for your users in Salesforce
EDITIONS
Classic and in the Salesforce app.
Chatter must be enabled for your organization. Available in: both Salesforce
Classic (not available in all
By default, the Chatter publisher in Salesforce Classic includes the standard actions Post, File, Link,
orgs) and Lightning
Poll, Question, and Thanks. To set up more actions in Chatter:
Experience
1. Enable feed tracking for the objects for which you want to make actions available.
Available in: Group,
2. Enable actions in the publisher if you want to see both standard actions and non-standard Professional, Enterprise,
actions in the Chatter publisher. Performance, Unlimited,
3. Optionally, enable feed updates for related records to display feed items on a record detail page Contact Manager,
when related records are created. Database.com, and
Developer Editions
4. Create object-specific actions or global actions.
5. Customize the action layout with the fields that you want users to see when they use the action.
USER PERMISSIONS
6. Add the actions to page layouts or global publisher layouts.
To set up actions:
Salesforce automatically adds default actions to the page layouts for account, case, contact,
• Customize Application
lead, and opportunity, and to the global publisher layout in organizations that were created
after Winter ‘14.

SEE ALSO:
Enable Actions in the Chatter Publisher
Create Object-Specific Quick Actions

694
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Set Up Actions Without Chatter Enabled

You can set up object-specific and global actions for the Salesforce mobile app or third-party apps,
EDITIONS
even if your org doesn’t have Chatter enabled.
When Chatter is disabled in an org, only the nonstandard actions appear in the action bar in the Available in: both Salesforce
Salesforce mobile app or in third-party apps that use action lists. Nonstandard actions include Classic (not available in all
Create, Update, Log a Call, custom actions, and Mobile Smart Actions. orgs) and Lightning
Experience
Note: You can create actions in Salesforce Classic when Chatter is disabled. Those actions
don’t appear in Salesforce Classic, but can appear in Lightning Experience and the Salesforce Available in: Group,
mobile app if you don’t customize the Salesforce Mobile and Lightning Experience Actions Professional, Enterprise,
section of the page layout editor. Performance, Unlimited,
Contact Manager,
Follow these steps to set up actions for use in the Salesforce mobile app or third-party apps. Database.com, and
1. Create object-specific actions or global actions. Developer Editions

2. Customize the action layout with the fields that you want users to see when they use the action.
3. Add the actions to page layouts or global publisher layouts.
USER PERMISSIONS
Salesforce automatically adds default actions to the page layouts for account, case, contact, To set up actions:
lead, and opportunity, and to the global publisher layout in organizations that were created • Customize Application
after Winter ‘14.

SEE ALSO:
Create Object-Specific Quick Actions
Create Global Quick Actions
Customize Actions with the Enhanced Page Layout Editor

Actions With and Without Chatter

Use actions regardless of whether Chatter or actions in the publisher are enabled.
EDITIONS
The actions that are available in the full Salesforce site (Salesforce Classic and Lightning Experience)
or in the Salesforce mobile app depend on your org’s settings. To enable or disable Chatter for your Available in: both Salesforce
organization, from Setup, enter Chatter Settings in the Quick Find box, then select Classic (not available in all
Chatter Settings. If Chatter is enabled, the Enable Actions in the Publisher option orgs) and Lightning
controls whether the actions that you create display in the Chatter publisher. Experience

Quick actions available in:

Chatter Off, Chatter On, Chatter On,
Actions Off Actions Off Actions On Group, Professional,
Enterprise, Performance,
You can create global actions Yes Yes Yes Unlimited, Contact
and customize global action Manager, Database.com,
lists and Developer Editions

You can create Yes Yes Yes Custom canvas actions

available in: Professional
object-specific actions and
(with Canvas enabled),
customize object-specific
Enterprise, Performance,
action lists
Unlimited, and Developer
Actions appear on the Home No Yes1 Yes Editions
page and Chatter home

695
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Chatter Off, Actions Off Chatter On, Actions Off Chatter On, Actions On
page in the full Salesforce site

Actions appear in object feeds in the full No Yes1,2 Yes2

Salesforce site

The action bar is available in the No3 Yes4 Yes

Salesforce mobile app feed

The action bar is available on the record Yes5 Yes6 Yes6

view in the Salesforce mobile app

The action bar is available on Lightning Yes5 Yes Yes

pages in the Salesforce mobile app

Footnotes:
1. If actions in the publisher aren’t enabled, only standard Chatter actions (Post, File, Link, Poll, and Thanks) appear in the Chatter
publisher in the full Salesforce site.
2. The Chatter feed appears on an object’s detail page in the full Salesforce site only for objects that have feed tracking enabled.
3. When Chatter is disabled, the Feed item isn’t available in the Salesforce mobile app.
4. When Chatter is enabled but actions in the publisher aren’t, standard Chatter actions and nonstandard actions appear in the Salesforce
mobile app action bar and in third-party apps that use action lists. Nonstandard actions include Create, Update, Log a Call, custom
actions, and Mobile Smart Actions.
5. When Chatter and actions in the publisher are disabled, only nonstandard actions appear in the action bar in the Salesforce mobile
app or in third-party apps that use action lists. Nonstandard actions include Create, Update, Log a Call, custom actions, and Mobile
Smart Actions.
6. If feed tracking isn’t enabled on an object, only nonstandard actions appear in the Salesforce mobile app action bar and in third-party
apps that use action lists. Nonstandard actions include Create, Update, Log a Call, custom actions, and Mobile Smart Actions.

SEE ALSO:
Set Up Actions with Chatter Enabled
Set Up Actions Without Chatter Enabled
Quick Actions

696
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Layout Editor

Just as object record pages have page layouts that can be customized, actions have action layouts
EDITIONS
that can be customized. When you create an action, Salesforce populates its layout with a default
set of fields. You can add, remove, or reorder fields on the action layout to present only the essential Available in: both Salesforce
items your users need when they’re taking the action. Classic (not available in all
For example, a Post action needs just one large text area for user input. By contrast, an object-related orgs) and Lightning
Create action must include multiple fields; otherwise, Salesforce can’t create the record. Experience

The first time you view the layout for an action you’ve created, certain fields are prepopulated: Available in: Group,
target object default fields, standard required fields, and any custom universally required fields. Professional, Enterprise,
Default actions (available in organizations created after Winter ’14) have predefined sets of fields. Performance, Unlimited,
Contact Manager,
The upper part of the action layout editor is the palette, and below the palette is the action layout.
Database.com, and
The palette contains fields from the action’s target object that you can add to the action layout,
Developer Editions
except for the following unsupported field types:
• Record type fields
• Read-only field types such as roll-up summary, formula, and auto-number fields
• Read-only system fields such as Created By or Last Modified By
• When you create a custom action and the action type is Update a Record, you can't add the Owner field to the action layout for
most objects. The exception is Case records. You can add the Case Owner field to your action layout when you create a custom
action to update a Case record.
Inactive Fields
Fields that are already on the action layout still appear on the palette but are inactive. When you select an inactive field on the palette,
Salesforce highlights the field on the action layout.
Field Type Conversion
If you convert a field’s type from one that is supported for actions to a type that isn’t supported, Salesforce removes the field from
the action layout. If you convert the field back to a supported type without changing the action layout, Salesforce automatically
adds the field back to the layout. If you edit the layout, and then convert the field back to a supported type, add the field back to
the layout manually.
Layouts Used for Log a Call Actions
A Log a Call action takes the active task page layout except under the following conditions:
• Suppose that your organization has a custom Log a Call action for an object. The custom action takes the custom action layout
defined for it.
• Now suppose that your organization has a custom Log a Call global action. That action takes the custom layout defined for it,
unless you also have a custom Log a Call action for an object. (A custom action on an object overrides a custom global action.)
To display the simpler New Task form to Salesforce mobile app users, enable the form in Activity Settings and ensure that the layout
used includes a subject field.
Layout Auditing
Salesforce tracks action layout customization in the setup audit trail history.
To view and edit the layouts for global actions in Setup, enter Actions in the Quick Find box, then select Global Actions and
then click Layout next to the action’s name. To view and edit the layouts for object-specific actions, find the object in Setup, then go
to Buttons, Links, and Actions.

697
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Layout Editor Considerations

When you create an action, Salesforce populates its layout with a default set of fields. You can add, remove, or reorder fields on the
action layout to present only the essential items your users need when they’re taking the action.

SEE ALSO:
Quick Actions

Action Layout Editor Considerations

When you create an action, Salesforce populates its layout with a default set of fields. You can add,
EDITIONS
remove, or reorder fields on the action layout to present only the essential items your users need
when they’re taking the action. Available in: both Salesforce
• There’s no hard limit to the number of fields you can add to an action layout. However, for Classic (not available in all
optimum usability, we recommend a maximum of 8 fields. Adding more than 20 fields can orgs) and Lightning
severely impact user efficiency. To reduce the number of fields in your layout, you can create Experience
predefined values for the required fields, and then remove those fields from your layout. You Available in: Group,
can set predefined field values from the action detail page. Professional, Enterprise,
• By default, the Call productivity action in the Salesforce mobile app action bar uses the global Performance, Unlimited,
Log A Call action layout. If you create one Log a Call action on an object, users see that custom Contact Manager,
Log a Call action’s layout when they tap Call from the action bar for that object. If you create Database.com, and
more than one Log a Call action for the same object, the Call action on that object doesn’t know Developer Editions
which layout to use, so it uses the global Log a Call action layout.
• Mobile smart actions are populated with all your org’s required fields on the relevant object,
regardless of how many fields there are. For example, the New Case action in the mobile smart action bundle includes all required
case fields. You can’t edit the fields on mobile smart actions. The fields that appear change only if you change which fields on an
object are required.
• You can remove a required field from the action layout, but make sure that the field has a predefined value. Otherwise, users can’t
create records.
• Rich text area fields are supported only when you add them to one-column layouts, or as fields that span both columns in two-column
layouts. If you add a rich text area field to only one column in a two-column layout, it appears as a plain text area, because there’s
not enough space to display the full rich text editor.
• When you create a custom action and the action type is Update a Record, you can't add the Owner field to the action layout for
most objects. The exception is Case records. You can add the Case Owner field to your action layout when you create a custom
action to update a Case record.
• When an Activities component is placed in a sidebar region on a Lightning page, global action fields always appear in a single
column, even if the global action has a two-column layout.

698
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Success Messages for Quick Actions

For Create a Record, Update a Record, and Log a Call action types, you can create a custom message
EDITIONS
that displays when the action executes successfully.
Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Experience

Available in: Group,

Professional, Enterprise,
Performance, Unlimited,
Contact Manager,
Database.com, and
Developer Editions

In the Salesforce mobile app and Lightning Experience, when a create, update, or Log a Call action is completed, a default success
message displays, regardless of whether the action created a feed item. If you add a custom success message to one of these actions,
your custom success message displays instead of the default message.
In Salesforce Classic, custom success messages have slightly different behavior. If you select Create Feed Item for a Create a
Record or Log a Call action, no success message displays in Salesforce Classic. The feed item itself is the confirmation that the action
executed successfully.
You can configure translations for custom success messages through the Translation Workbench. From Setup, enter Translate in
the Quick Find box, and then select Translate. Choose Action for the Setup Component, and choose Informational Message for the
Aspect.

Note: If you have All Related Objects selected under feed tracking for a particular object, when a quick action creates related
objects, a feed item is always created, regardless of the status of Create Feed Item.

SEE ALSO:
Create Object-Specific Quick Actions
Create Global Quick Actions

699
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Customize Actions with the Enhanced Page Layout Editor

Use the page layout editor to customize which actions show up in Salesforce and in the Salesforce
EDITIONS
mobile app.

Tip: To manage the actions for global pages, such as Home, Chatter Home, and Chatter Available in: both Salesforce
groups, see Global Publisher Layouts. Classic (not available in all
orgs) and Lightning
From the management settings for the object whose actions you want to manage, go to Page Experience
Layouts.
Available in: Group,
You can add actions to two sections on a page layout: Professional, Enterprise,
Quick Actions in the Salesforce Classic Publisher Performance, Unlimited,
This section can contain actions only from the Quick Actions category in the palette. Actions Contact Manager,
in this section appear in the Chatter publisher in Salesforce Classic. Database.com, and
Developer Editions
Salesforce Mobile and Lightning Experience Actions
This section can contain actions only from the Mobile & Lightning Actions category in the
palette. On object page layouts, the Mobile & Lightning Actions category contains all available USER PERMISSIONS
types of actions for the object, including quick actions, productivity actions, Lightning component
actions, and standard and custom buttons. Actions in this section appear in the action bar and To create actions:
action menu in the Salesforce mobile app and in various areas of Lightning Experience. • Customize Application
To customize action layouts
Tip: Hover over an action in the palette to see its label, API name, and action type. and page layouts:
• Customize Application
• To override the action defaults for an action section that you haven’t customized, either click
the override text or hover over the section and click . To view page layouts:
• View Setup
If you haven’t customized the Quick Actions in the Salesforce Classic Publisher section of a page
layout, the actions that appear in the publisher for that object default to the actions that are
assigned to the global publisher layout. Upon overriding, the actions default to the standard actions—Post, File, Link, Poll, Question,
and Thanks—regardless of what actions were assigned to the global publisher layout.
If you haven’t customized the Salesforce Mobile and Lightning Experience Actions section of a page layout, the actions for that object
default to a set of predefined actions. If you have customized actions in the Quick Actions in the Salesforce Classic Publisher section,
and have saved the layout, the Salesforce Mobile and Lightning Experience Actions section inherits the actions from the Quick
Actions in the Salesforce Classic Publisher section, plus any standard or custom buttons present on the layout, when you click to
override.

• To revert the actions in either section to the defaults for that section, hover over the section and click .

SEE ALSO:
Set Up Actions with Chatter Enabled
Actions in Lightning Experience
Send Email Action Considerations for Cases
Mobile Smart Actions
The Enhanced Page Layout Editor
Find Object Management Settings

700
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Set Predefined Field Values for Quick Action Fields

When you create actions, use predefined field values to set a value for a field. Predefined values can
EDITIONS
help ensure consistency and make it faster and easier for users to create records.
When you configure action layouts, it’s better to use fewer fields. Most users, especially mobile Available in: both Salesforce
users, don’t like to fill in too many required fields. They want to get things done and move on to Classic (not available in all
their next task. A good way to use fewer fields in action layouts is to set predefined values for as orgs) and Lightning
many fields as possible. The more fields you can set predefined values for, the more you can remove Experience
from the layout and make the action easier and quicker to use. Balance ease of use with the need Available in: Group,
for required information. However, don’t remove required fields from an action layout without Professional, Enterprise,
setting a predefined value for those fields, or when a user applies that action. The record doesn’t Performance, Unlimited,
save properly. Contact Manager,
If you set predefined values for fields on object records created through an action, you don’t need Database.com, and
to add those fields to the action layout. For example, when you configure an action that lets users Developer Editions
create opportunities, set Prospecting as the predefined value for the Stage field. All new opportunities
users create through that action are automatically assigned to the prospecting stage. You can USER PERMISSIONS
remove the Stage field from the action’s layout, because the field is going to be assigned a value
automatically. To set predefined field
values:
Tip: Predefined values for fields on actions are different from default values that you can set • Customize Applications
for fields on records. If a field is included in an action, it can have both a predefined value set
for the action and a default value set.
1. Click the name of an action in the Buttons, Links, and Actions list or the Global Actions list.
2. On the action detail page, click New in the Predefined Field Values list.
3. Select the field you want to predefine a value for.
4. Specify the value for the field.
For single-select picklists, you can specify both a specific value and a formula value. If you set both, the formula value takes precedence
over the specific value.

5. Click Save.

Tip: On object-specific actions, the predefined value can include references to the source object and its related objects.

Notes on Predefined Field Values for Quick Actions

SEE ALSO:
Notes on Predefined Field Values for Quick Actions

701
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Notes on Predefined Field Values for Quick Actions

Setting predefined field values for quick actions is especially important if you remove required or
EDITIONS
Always on Layout fields from the action layout.
• You can set predefined values for any field available in the action layout editor, with these Available in: both Salesforce
exceptions. Classic (not available in all
orgs) and Lightning
– Dependent picklists
Experience
– Multi-select picklists
Available in: Group,
– Read-only field types like auto-number, formula, and roll-up summary fields
Professional, Enterprise,
• If you set a predefined value for the lookup field that’s used as the action’s relationship field, Performance, Unlimited,
the action ignores the predefined value and uses the parent record ID instead. Contact Manager,
Database.com, and
• You can’t use a dependent picklist to set a predefined value.
Developer Editions
• 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.
• If a picklist field on a quick action has both a predefined specific value and predefined formula value, the formula value takes
precedence over the specific value.
• If you set a predefined value for a field and leave it on the action layout, that value displays as the default value for the field.
• If you use a rich text field as a predefined field value, any text formatting that was applied in the rich text field is removed in the new
field.
• When you have a required field with a predefined value and remove the field from the action layout, you must add the required
field back to the action layout if you later delete the field’s predefined value. Otherwise, users can’t save the record.
• Formulas can’t reference fields on external objects, so you can’t reference an external object field to set a predefined field value for
a quick action.
• You can use a TEXT(picklist) value in a predefined value field.
• To set the value for an email action’s recipient, predefine the To, CC, or BCC fields. You can use ID fields, such as Contact.Id, or
string fields, such as Contact.custom_email_field to predefine the value.
– Contact, lead, and person account IDs are supported.
– Use an ID field if you want to log the email on the recipient’s record.
– Use a string field to predefine an email recipient for a custom object or custom field.
– If you use a string field, the email isn’t logged on the recipient’s record.

SEE ALSO:
Set Predefined Field Values for Quick Action Fields

702
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Global Publisher Layouts

Global publisher layouts determine the global actions that appear in the various Salesforce interfaces.
EDITIONS
In Salesforce Classic and Lightning Experience, these layouts customize the actions on global pages
(like the Home page) and on the Chatter page. Lightning Experience also uses these layouts to Available in: both Salesforce
populate the Global Actions menu. And in the Salesforce mobile app, these layouts drive the actions Classic (not available in all
that appear in the action bar on the Feed and People pages. Global publisher layouts can include orgs) and Lightning
global actions only. Experience
In Salesforce for Outlook, global publisher layouts drive the actions that Group, Contact Manager, Available in: Group,
and Professional Edition users see when they click the Salesforce Side Panel Publisher. Salesforce Professional, Enterprise,
for Outlook users working in all other editions can set up their side panel publishers using Outlook Performance, Unlimited,
Side Panel Publisher Layouts. Contact Manager,
Database.com, and
Note: Chatter groups without customers display the global publisher layout by default,
Developer Editions
unless you override it with a customized group publisher layout. In Chatter groups that allow
customers, the publisher displays standard actions only, such as Post, File, Link, and Poll.
You can assign different global publisher layouts to different user profiles to customize which actions USER PERMISSIONS
users see by default on global pages. To create actions:
Note: Changes to user layouts override the global publisher layout on user profile pages • Customize Application
and the Chatter home page. To customize action layouts
and page layouts:
Follow these steps to work with global publisher layouts.
• Customize Application
To view page layouts:
1. Create Global Publisher Layouts
• View Setup
Global publisher layouts determine the global actions that appear in the various Salesforce
interfaces. In Salesforce Classic and Lightning Experience, these layouts customize the actions
on global pages (like the Home page) and on the Chatter page. Lightning Experience also uses these layouts to populate the Global
Actions menu. And in the Salesforce mobile app, these layouts drive the actions that appear in the action bar on the Feed and People
pages. Global publisher layouts can include global actions only.
2. Add Actions to Global Publisher Layouts
Actions you add to the global publisher layouts appear on pages such as the Home and Chatter pages. They also appear on the
action bar and action menu on the Feed and People pages in the Salesforce mobile app.
3. Assign Global Publisher Layouts to User Profiles
Once you finish creating a global publisher layout, you can assign it to different user profiles. For example, a Marketing User and a
Standard User might need different actions in the Chatter publisher or in the Salesforce mobile app. Create multiple global publisher
layouts and assign them to different user profiles to customize the actions for each profile.

SEE ALSO:
Create Global Quick Actions

703
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Create Global Publisher Layouts

Global publisher layouts determine the global actions that appear in the various Salesforce interfaces.
EDITIONS
In Salesforce Classic and Lightning Experience, these layouts customize the actions on global pages
(like the Home page) and on the Chatter page. Lightning Experience also uses these layouts to Available in: both Salesforce
populate the Global Actions menu. And in the Salesforce mobile app, these layouts drive the actions Classic and Lightning
that appear in the action bar on the Feed and People pages. Global publisher layouts can include Experience
global actions only.
Available in: Enterprise,
1. From Setup, enter Publisher Layouts in the Quick Find box, then select Publisher Performance, Unlimited,
Layouts. Database.com, and
2. To create a new global publisher layout, click New. Developer Editions
3. To clone a publisher layout, select one from the Existing Global Publisher Layout drop-down
list. USER PERMISSIONS
4. Enter a name for the new global publisher layout. To create actions:
5. Click Save. • Customize Application
To customize action layouts
SEE ALSO: and page layouts:
• Customize Application
Assign Global Publisher Layouts to User Profiles
To view page layouts:
Global Publisher Layouts
• View Setup

Add Actions to Global Publisher Layouts

Actions you add to the global publisher layouts appear on pages such as the Home and Chatter
EDITIONS
pages. They also appear on the action bar and action menu on the Feed and People pages in the
Salesforce mobile app. Available in: both Salesforce
Arrange the actions so that the frequently used actions appear first in each list. Classic (not available in all
orgs) and Lightning
You can add actions to two sections on a page layout:
Experience
Quick Actions in the Salesforce Classic Publisher
This section can contain actions only from the Quick Actions category in the palette. Actions Available in: Group,
Professional, Enterprise,
in this section appear in the Chatter publisher in Salesforce Classic.
Performance, Unlimited,
Salesforce Mobile and Lightning Experience Actions Contact Manager,
This section can contain actions only from the Mobile & Lightning Actions category in the Database.com, and
palette.On object page layouts, the Mobile & Lightning Actions category contains all available Developer Editions
types of actions for the object, including quick actions, productivity actions, Lightning component
actions, and standard and custom buttons. Actions in this section appear in the action bar and
USER PERMISSIONS
action menu in the Salesforce mobile app and in various areas of Lightning Experience.

Note: Changes to user layouts override the global publisher layout on user profile pages To create actions:
and the Chatter home page. Actions on the user profile page come from the Quick Actions • Customize Application
in the Salesforce Classic Publisher section of the global publisher layout. Only standard Chatter To customize action layouts
actions appear on the user profile page, regardless of which actions are present in the User and page layouts:
Page Layout or the global publisher layout. • Customize Application

1. From Setup, enter Publisher Layouts in the Quick Find box, then select Publisher To view page layouts:
Layouts. • View Setup

704
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

2. To add or remove actions, drag them to and from the palette. To reorder actions, select an action and drag it to a new position.
3. Click Save when you’re done, or click Quick Save to save your changes and continue working on the layout.
If you navigate away without saving, you lose your changes.

Note: Before using the personal email setting When you click an email address to compose an email, which email editor do
you want to use?, confirm that the Global Publisher Layout has the email action in the Salesforce Mobile and Lightning
Experience Action section.

Example: Let’s add the New Account action to the publisher on the Home and Chatter pages in Salesforce Classic. The New
Account action lets users create an account directly from the publisher. Drag the New Account action to the Quick Actions in the
Salesforce Classic Publisher section and save your changes.

Go to the Chatter tab in Salesforce Classic. Now the New Account action shows up in the publisher.

Note: The Chatter page in Lightning Experience supports only the standard Chatter actions Post, Poll, and Question, and
if you have Groups, the Announcement action.

SEE ALSO:
Actions in Lightning Experience
Send Email Action Considerations for Cases
Assign Global Publisher Layouts to User Profiles
Email Application Publisher Layouts

705
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Assign Global Publisher Layouts to User Profiles

Once you finish creating a global publisher layout, you can assign it to different user profiles. For
EDITIONS
example, a Marketing User and a Standard User might need different actions in the Chatter publisher
or in the Salesforce mobile app. Create multiple global publisher layouts and assign them to different Available in: both Salesforce
user profiles to customize the actions for each profile. Classic (not available in all
1. From Setup, enter Publisher Layouts in the Quick Find box, then select Publisher orgs) and Lightning
Layouts. Experience

2. Click Publisher Layout Assignment. Available in: Group,

Professional, Enterprise,
3. Click Edit Assignment.
Performance, Unlimited,
4. Select a user profile by clicking anywhere on its row in the table. Contact Manager,
5. From the Publisher Layout to Use drop-down, select the global publisher layout that you want Database.com, and
to assign to the highlighted profile. Developer Editions

6. Save the layout.

USER PERMISSIONS
SEE ALSO: To create actions:
Add Actions to Global Publisher Layouts • Customize Application
Global Publisher Layouts To customize action layouts
and page layouts:
• Customize Application
To view page layouts:
• View Setup

Quick Actions and Record Types

Using record types in your organization can affect the availability of quick actions for your users.
EDITIONS
If users don’t have access to a particular record type, actions that are assigned to that record type
aren’t available to them. For example, let’s say that you have a page layout that contains a mix of Available in: both Salesforce
actions—some have no record type assigned and some are assigned to Record Type A. Users Classic (not available in all
without access to Record Type A see only the nonassigned actions when they visit the page. orgs) and Lightning
Experience
Important: Don’t assign actions to the Master record type. The Master record type is a
placeholder record type that’s assigned when your organization is created. Quick actions available in:
Group, Professional,
Enterprise, Performance,
Default Global Actions: A Special Case
Unlimited, Contact
If you have default global actions in your organization and you’re using record types, your users Manager, Database.com,
might not be able to see all the default actions that are assigned to a page layout. and Developer Editions
Default global actions are assigned to the Master record type, which isn’t accessible to most profiles. Custom canvas actions
As a result, default global actions with the Master record type that are associated with target objects available in: Professional
that have record types configured aren’t available for most users. To fix this issue, edit the default (with Canvas enabled),
global actions associated with those objects and reassign them to a different record type. Enterprise, Performance,
Unlimited, and Developer
For example, the New Contact default global action has Contact as its target object. Let’s say you Editions
have record types set up for the Contact object, and you add the New Contact default global object
to a page layout. Users who visit records based on that page layout don’t see the New Contact
action because the action is assigned to the Master record type by default. Editing the New Contact

706
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

default global action and assigning it to a record type other than Master makes it available for all users who have access to its assigned
record type.

Actions Best Practices

Use these tips as you set up actions.
EDITIONS

Tips for Creating Actions Actions available in: both

Salesforce Classic and
• Action labels longer than approximately 12–14 characters are shortened when they’re displayed Lightning Experience
in the Chatter publisher. Keep names short and descriptive.
• Give your actions task-oriented names that tell your users what they do. Use terms such as New, Publisher available in:
Salesforce Classic
Create, Share, Update, or Import.
• Use the Description field to create notes for yourself about each action. Notes are especially Available in: Essentials,
useful if you’re creating several similar actions for different record types, for example. The Group, Professional,
description appears in the list of buttons, links, and actions for object-specific actions, or in the Enterprise, Performance,
list of global actions, as well as on the detail page for the action. Your notes aren’t visible to Unlimited, Contact
users. Manager, Database.com,
and Developer Editions
• When creating custom actions that are going to be displayed in the Chatter publisher, limit
their height to 400 pixels so that they are displayed correctly.

Tips for Laying Out Actions

• When customizing action layouts, consider what your users will do with them. Minimalism is key. Include only the fields that are
necessary for them and for whomever handles the cases, calls, or records that result from those actions.
• To create a single-column layout, such as for display on mobile devices, add fields only in the left column.
• Use predefined field values to set standard values for common fields. For example, when you configure an action that lets users
create opportunities, set Prospecting as the predefined value for the Stage field. All new opportunities users create through that
action are automatically assigned to the prospecting stage. You can remove the Stage field from the action’s layout, because the
field is going to be assigned a value automatically. If you set predefined values for fields on object records created through an action,
you don’t need to add those fields to the action layout.
• Use the Preview As button on the Action Layout Editor to see how an action layout appears to different user profiles.

Tips for Adding Actions to Publishers

• Because adding too many actions can cause the page to load slowly, we recommend including no more than nine actions total in
each publisher, including any standard actions.
• In Salesforce Classic, if you include five or more actions in the actions section of a page layout, three are shown and the rest are
added to the publisher’s More menu. If you include four or fewer actions, they’re all shown.
• In the Salesforce mobile app, the first three actions show up in the action bar, and the full set of actions are accessed by tapping .

SEE ALSO:
Quick Action Considerations
Troubleshooting Actions
Set Up Actions with Chatter Enabled

707
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Quick Action Considerations

Keep these considerations in mind when working with quick actions.
EDITIONS
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 Actions available in: both
implementations. Salesforce Classic and
Lightning Experience
• If you’re using record types in your org, sometimes quick actions aren't visible to your users.
For more information, see Quick Actions and Record Types on page 706. Available in: Essentials,
Group, Professional,
• The Printable View action is supported on Lightning Experience for desktop only. It isn’t
Enterprise, Performance,
supported on mobile devices.
Unlimited, Contact
• To see an object-specific action on a page layout, a user must have both Read and Edit Manager, Database.com,
permissions on the action’s relationship field. The relationship field is the field that’s automatically and Developer Editions
populated on the target object when a user creates a record using an action. For example, for
an action on a case that lets users create child cases, the default relationship field is Parent
Case. To be sure that users can see the Create Child Case action, check that they have both Read and Edit permissions on the
Parent Case field.
Field-level security sets the Account parent field on the Case object to read-only by default, which means it’s not visible to non-system
administrator users. Therefore, actions on accounts that have Case as the target object are also not visible to users without the System
Administrator profile. To let users see actions on accounts that have Case as the target object, remove the Read Only setting.

• In quick action layouts:

– A blank space inserted on the same line as another field in the quick action layout causes that field to stretch to the full page
width. The field is left justified on the page, regardless of its position in the quick action layout editor. If you add a field only to
the right column in a two-column layout, the field label is truncated. We recommend adding the field to the left column instead.
– Two blank spaces inserted on the same row in the quick action layout editor don't create a blank line on the page. The two blank
spaces are ignored.
– If there's an uneven number of fields on the quick action layout, the final field stretches to the full page width and is left justified.
The behavior is the same if a blank space is inserted on the same row as the final field.

• Custom actions can be defined for person accounts but with these exceptions.
– Person account-specific fields, including Email and Mobile, aren’t available in action layouts when using object-specific
custom actions to update accounts.
– To set up object-specific custom quick actions that create person account records, define a custom lookup field for Account
on the Account or Contact object. Global custom quick actions can be used without defining this field.
– Actions that create business account records from a person account detail page must be global, not object-specific.

• If you delete an action, the action is removed from all layouts that it’s assigned to.
• Automatic triggers that change record ownership can affect what object details are visible to users. In some cases, a user can enter
information that is then immediately hidden from them if an automatic trigger changes the object's owner. For example, if you use
a global create quick action to create an object and an automatic trigger changes the object ownership, some information about
the object isn't visible to you.
• Chatter groups without customers display the global publisher layout by default, unless you override it with a customized group
publisher layout. In Chatter groups that allow customers, the publisher displays standard actions only, such as Post, File, Link, and
Poll.
• When you create a custom quick action, use a unique label and API name. If the custom quick action has the same API name as a
legacy standard action, Metadata API and change set deployment errors can occur. The incorrect action can also appear on page
layouts.

708
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Actions and Master-Detail Object Relationships

• Actions to create records for an object that is the detail object in a master-detail relationship must be object-specific, not global.
• If you create an action on a detail object in a master-detail relationship, the action’s target object can’t be a different detail object
of the same master.
For example, master object A has two detail objects, B and C. You can create actions on object A with B or C as the target object.
However, when creating an action on object B, the target object can’t be object C because B and C have the same master. To create
an action on B with C as the target, you can do one of the following:
– Change the relationship between B and C to master-detail so that A is the master of B, and B is the master of C.
– Change the relationship between C and A to a lookup relationship. A is still the master of B with this option, so you can’t create
a quick action on B with a target object of A.

Troubleshooting Actions

EDITIONS
I don’t see feeds on record detail pages for a certain object.
Feeds appear only for objects for which you’ve enabled feed tracking. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
I see the feed on a record detail page, but I don’t see a publisher. Experience
If there are no actions in the Quick Actions in the Salesforce Classic Publisher section on a page Available in: Group,
layout, the publisher in Salesforce Classic doesn't appear. Add at least one action to the page layout Professional, Enterprise,
for the publisher to appear. Performance, Unlimited,
Contact Manager,
I can create actions, but I can’t add them to publishers. Database.com, and
Developer Editions
Enable actions in the publisher to add nonstandard actions to publishers in Salesforce Classic.

I’m using Internet Explorer 10 and all the actions I’ve created appear in the publisher with the same icon, even though the
actions are for different types of objects.
Internet Explorer version 10 doesn’t support the techniques Salesforce uses to show icons that correspond to the type of object an action
is associated with. Consider using Chrome, Firefox, Safari, or an earlier version of Internet Explorer.

I’ve added an action to a page layout, but a user assigned to the profile that uses that page layout can’t see the action.
Be sure that the user has both Read and Edit permissions on the action’s relationship field. The relationship field is the field that’s
automatically populated on the target object when a user creates a record using an action. For example, for an action on a case that lets
users create child cases, the default relationship field is Parent Case. To be sure that users can see the Create Child Case action,
check that they have both Read and Edit permissions on the Parent Case field.

I don’t see a relationship field on my global create actions.

Relationship fields apply only to object-specific create actions, not to global actions.

I don’t see some of the actions in my Chatter groups.

Which actions you see depends on your role in the group, the type of group, and how your administrator has configured the publisher
layout for groups. Chatter groups without customers display the global publisher layout by default, unless you override it with a customized

709
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

group publisher layout. In Chatter groups that allow customers, the publisher displays standard actions only, such as Post, File, Link, and
Poll.

I see an error when I select a custom create account action from a person account.
Although your administrator can add the custom create account action to the page layout, this action isn’t supported for person accounts.

SEE ALSO:
Actions Best Practices
Set Up Actions with Chatter Enabled

Action Limits and Limitations

Actions can work differently than you expect in certain situations and for different objects. Keep
EDITIONS
these limits and limitations in mind when working with actions.
• Quick actions aren’t available in Aura Experience Builder sites. Available in: Essentials,
• You can display up to 10 actions in Lightning view. Group, Professional,
Enterprise, Performance,
• Custom images used for action icons must be less than 1 MB in size. Unlimited, Contact
• Custom actions can be defined for person accounts but with these exceptions. Manager, Database.com,
and Developer Editions
– Person account-specific fields, including Email and Mobile, aren’t available in action
layouts when using object-specific custom actions to update accounts.
– To set up object-specific custom quick actions that create person account records, define a custom lookup field for Account
on the Account or Contact object. Global custom quick actions can be used without defining this field.
– Actions that create business account records from a person account detail page must be global, not object-specific.

• Actions associated with objects that aren’t supported in Lightning Experience don’t appear in the Global Actions menu. Also, the
Global Actions menu doesn’t support standard Chatter actions.
• Mobile smart actions don’t appear in the full Salesforce site, regardless of which page layouts you add them to. They appear only in
the Salesforce mobile app.
• The Chatter page in Lightning Experience supports only the standard Chatter actions Post, Poll, and Question, and if you have Groups,
the Announcement action.
• The palette in the action layout editor doesn’t support:
– Record type fields
– Read-only field types such as roll-up summary, formula, and auto-number fields
– Read-only system fields such as Created By or Last Modified By
– When you create a custom action and the action type is Update a Record, you can't add the Owner field to the action layout for
most objects. The exception is Case records. You can add the Case Owner field to your action layout when you create a custom
action to update a Case record.

• Actions on the user profile page come from the Quick Actions in the Salesforce Classic Publisher section of the global publisher
layout. Only standard Chatter actions appear on the user profile page, regardless of which actions are assigned to the User Page
Layout or the global publisher layout.
• Actions on reports come from the Quick Actions in the Salesforce Classic Publisher section of the global publisher layout. Only
standard Chatter actions appear on reports, regardless of which other actions are assigned to the global publisher layout.

710
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• Chatter groups with customers don’t support global create, log a call, or custom actions and display only standard Chatter actions,
such as Post, File, Link, and Poll.
• External objects support quick actions, except when the actions involve features or functionality that are incompatible with external
objects. For example:
– Formulas can’t reference fields on external objects, so you can’t reference an external object field to set a predefined field value
for a quick action.
– Log a Call actions create tasks, which aren’t available for external objects.

• When you create an object-specific action, you can choose as a target object an event, a task, or any object that has a parent-child
or lookup relationship to the host object. You can’t choose Quote as a target object from Opportunity. But to create quotes from an
opportunity you can go to the opportunity’s Quotes related list and click New.
• The Account Contact Relationship object supports custom actions, but with limitations.
– Custom actions must be specific to the Account Contact Relationship object. Global actions aren’t supported.
– You can create actions that update records or invoke Lightning components or Visualforce pages. But you can’t create actions
that create records.
– You can’t create actions that send emails or log calls because you can't associate activities to the Account Contact Relationship
object.
– You can’t override the default actions on the Account Contact Relationship object.
– Only custom actions that are created on the Contact object can use the Account Contact Relationship object as a target object.
– Chatter standard actions aren’t supported because the Account Contact Relationship object doesn’t have a Chatter feed.

Mass Quick Actions

With mass quick actions, users can create or update up to 100 records from a list view or related
EDITIONS
list. Users can select one record in the list to update only that record, or multiple records to perform
bulk updates. To help users understand the changes they’re making, the action window includes Available in: both Salesforce
a Fields to update section when users update more than one record. Classic (not available in all
orgs) and Lightning
Important: Only these quick action types are supported for mass quick actions.
Experience
• Create a Record
• Update a Record Quick actions available in:
Group, Professional,
Enterprise, Performance,
Set Up a Mass Quick Action for List Views Unlimited, Contact
With mass quick actions on a list view, users can create or update records in bulk rather than Manager, Database.com,
one at a time. You can configure a mass quick action for cases, leads, accounts, campaigns, and Developer Editions
contacts, opportunities, work orders, and custom objects that support quick actions and have Custom canvas actions
a list view button layout in Lightning Experience. available in: Professional
(with Canvas enabled),
Set Up a Mass Quick Action for Related Lists (Beta)
Enterprise, Performance,
With mass quick actions on a related list, users can create or update related records in bulk
Unlimited, and Developer
without leaving the page. You can configure a mass quick action on related lists for any related Editions
object that supports quick actions.
Mass Quick Action Considerations
Review these guidelines and considerations before setting up and using mass quick actions in list views.

711
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Set Up a Mass Quick Action for List Views

With mass quick actions on a list view, users can create or update records in bulk rather than one
EDITIONS
at a time. You can configure a mass quick action for cases, leads, accounts, campaigns, contacts,
opportunities, work orders, and custom objects that support quick actions and have a list view Available in: Lightning
button layout in Lightning Experience. Experience
Before setting up mass quick actions on a list view:
Available in: Essentials,
• Review Mass Quick Action Considerations. Group, Professional,
• Set up Create a Record or Update a Record quick actions for your objects. These actions are Enterprise, Performance,
those that you want users to perform on multiple records in a list view. Unlimited, and Developer
Editions
To add mass quick actions on a list view, customize an object’s list view button layout.
1. From the object management settings for the object that you want to allow mass quick actions
USER PERMISSIONS
on, go to List View Button Layout.
2. Edit the List View layout. To set up mass quick actions
for Lightning Experience:
3. In the List View Actions in Lightning Experience section, add the actions that you want your • Customize Application
users to be able to perform on list views for multiple records.
4. Save your changes.
The list view for the object that you updated now includes buttons for the actions that you added.

Example: Here’s an example of the list view actions configured for the case object.

SEE ALSO:
Mass Quick Action Considerations

712
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Set Up a Mass Quick Action for Related Lists (Beta)

With mass quick actions on a related list, users can create or update related records in bulk without
EDITIONS
leaving the page. You can configure a mass quick action on related lists for any related object that
supports quick actions. Available in: Lightning
Note: This feature is a Beta Service. Customers may opt to try such Beta Service in its sole Experience
discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided Available in: Essentials,
at Agreements and Terms. Group, Professional,
Before setting up mass quick actions on a related list: Enterprise, Performance,
Unlimited, and Developer
• Review Mass Quick Action Considerations. Editions
• Set up Create a Record or Update a Record quick actions for the object contained in the related
list, not the parent object. For example, to add a mass quick action to the Opportunities related
USER PERMISSIONS
list on the Account record detail page, create a quick action on the Opportunity object.
There are two ways to add mass quick actions on a related list. To add actions directly from the To set up mass quick actions
Lightning App Builder, select the Dynamic Related List - Single component in the record page. In for Lightning Experience:
the properties pane, click Add Action, and then select your quick action. • Customize Application

Or, you can set up mass quick actions on a related list from the page layout editor.
1. From the object management settings for the parent object, go to the Page Layouts section and choose the page layout to edit.
2. Edit the related list’s properties and expand the Buttons section.
3. Under Quick Actions in Lightning Experience (Beta), select the quick actions to show on the related list.
4. Save your changes to the page layout.
The related list on the record detail page now includes buttons for the actions that you added. If you don’t see the quick actions on the
list, update the related list type. In the Lightning App Builder, select the Related Lists component or the Related List - Single component
in the record page. Then, in the properties pane, set the Related List Type to Enhanced List.

Mass Quick Action Considerations

Review these guidelines and considerations before setting up and using mass quick actions in list
EDITIONS
views.
Available in: Lightning
Setting Up a Mass Quick Action Experience

• Mass quick actions are available only in Lightning Experience apps, including apps with standard Available in: Essentials,
and console navigation. Personal, Group,
Enterprise, Performance,
• You can’t perform mass quick actions in Experience Cloud sites, or on notes or users.
Unlimited, Developer, and
• You can’t use the Tooling API, AppExchange, and Changesets to add mass quick actions to an Professional Editions
object’s list view button layout.
• If you want to set up predefined field values for a quick action, we recommend not including
those fields on the quick action’s layout.
If a predefined field value is included in the quick action’s layout, it’s only updated if the user manually selects it. If a predefined field
value isn’t included in the quick action’s layout, the predefined value is updated, but the user isn’t notified of the change. The Fields
to update section includes only predefined field values that are specified in the layout.

713
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Using a Mass Quick Action

• When using a mass quick action, only the fields you manually modify are changed. Some fields show a default value, but changes
aren’t made unless you manually select them. The Fields to update section shows the changes you’re making.
• You can’t undo changes performed by a mass quick action—so be careful when making your changes.
• In list views, you can use mass actions in both table view and split view. Mass actions in split view use the same logic as mass actions
in table view.
• If you use a mass quick action to update only one record, the Fields to update section isn’t displayed.
• List views in split view and related lists have checkboxes to select records only if a mass action is available.

Note: The Quick Actions on Related Lists feature is a Beta Service. Customers 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.

Example: This mass quick action updates the owner on cases. The Case Owner field displays Awesome Admin because the user
modified this field. The Status field displays New because that was the value of all the selected records. The changes to make are
listed in the Fields to update section.

If the selected records have different statuses, such as one is set to New and one is set to Escalated, the Status field shows None.

SEE ALSO:
Set Up a Mass Quick Action for List Views

714
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Actions in Lightning Experience

In Lightning Experience, actions appear in the Global Actions menu in the header, on related lists,
EDITIONS
and on list view items. Actions also appear on a record page, in one of several places depending
on the action’s type. Available in: both Salesforce
Note: Quick actions aren’t the only action type covered here. Standard and custom buttons Classic (not available in all
orgs) and Lightning
are also considered actions.
Experience

Actions in the Global Actions Menu Quick actions available in:

Group, Professional,
The Global Actions menu displays a subset of global actions from the Salesforce Mobile and Lightning
Enterprise, Performance,
Experience Actions section of the global publisher layout.
Unlimited, Contact
Manager, Database.com,
and Developer Editions
Custom canvas actions
available in: Professional
(with Canvas enabled),
Enterprise, Performance,
Unlimited, and Developer
Editions

The items in the menu appear in the order that they’re listed in the Salesforce Mobile and Lightning Experience Actions section of the
global publisher layout.
Actions associated with objects that aren’t supported in Lightning Experience don’t appear in the Global Actions menu. Also, the Global
Actions menu doesn’t support standard Chatter actions.

Actions on List Views and List View Items

Custom list buttons, list view actions, and certain standard buttons are supported on all list views, except Recently Viewed. To have a
custom list button appear on a list view, add the button to the object’s List View Button Layout.
In the Kanban view, only the standard New action is supported.
List view items support only specific standard actions, like Edit, Delete, or Change Owner.

715
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

For Tasks, table format list views and the Kanban view support only standard buttons. Tasks list view items in table view and the task
item detail pane in split view contain the complete list of available actions for tasks.

Actions on the Home Page

On the Home page, you can find actions on recommendations in the Assistant. For example, imagine that a sales rep receives an update
that an opportunity doesn’t have any open activity. The rep can create a task or event directly from the recommendation.

The actions that appear depend on the type of recommendation. To appear in the Assistant, actions must be added to the Salesforce
Mobile and Lightning Experience Actions section of the global publisher layout. Supported actions include:
• New Task
• New Event
• Edit
• Email
After you complete an action, the related recommendation disappears from the Assistant.

Actions on the Chatter Page

The Chatter page, like the Chatter tab on record pages, contains only standard Chatter actions. By default, only the Post, Poll, and Question
actions are supported, and if you have Groups, the Announcement action. You can add, remove, or reorder the actions on the Chatter
page from the Salesforce Mobile and Lightning Experience Actions section of the global publisher layout.

716
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Actions on Record Pages

Here’s a sample contact page in Lightning Experience.

Note: The opportunity and leads workspaces have different structures, but actions appear in the same way on those pages.

The page-level action menu in the record’s highlights panel (1) contains:
• Productivity actions
• Global and object-specific quick actions, except for those actions related to creating tasks, creating events, and logging calls
• Standard buttons
• Custom object-specific Lightning component and Lightning web component quick actions
• Custom flow actions
• Custom Visualforce quick actions
• Custom Visualforce buttons
• Canvas actions
The actions that appear in the page-level action menu are listed in the order that they appear in the Salesforce Mobile and Lightning
Experience Actions section of the page layout.

717
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Note: You can enable dynamic actions in the highlights panel on an object’s record page using the Lightning App Builder.
Dynamic actions are supported for custom objects on desktop and mobile and for standard objects on desktop. Add, remove, and
reorder actions directly in the Lightning App Builder and control action visibility based on filters that you apply. When you enable
dynamic actions in the Lightning App Builder, highlights panel actions for the record page no longer come from the object’s page
layout.
The Activity tab (2) contains Create a Record quick actions that point to the Event and Task objects. It also contains Log A Call and Send
Email actions.
The Chatter tab (3) contains standard Chatter actions. By default, only the Post, Poll, and Question actions are supported, and if you have
Groups, the Announcement action. Some objects support other standard Chatter actions predefined by Salesforce.

Note: Actions on user profiles, cases, and work orders can appear in a different way than on other records.
• Actions on the user profile page come from the Quick Actions in the Salesforce Classic Publisher section of the global publisher
layout. Only standard Chatter actions appear on the user profile page, regardless of which actions are assigned to the User
Page Layout or the global publisher layout.
• When feed tracking is enabled for cases or work orders, the page-level action menu on those records contains only custom
buttons and supported standard buttons. Quick actions appear on the Chatter tab. On Experience Builder sites, quick actions
for work orders appear on the page-level action menu.

Actions on Related Lists

Related lists in Lightning Experience (4) show custom list buttons and supported standard buttons assigned to the related list. Not all
related list standard buttons are supported in Lightning Experience.

Actions on Reports
Actions on reports come from the Quick Actions in the Salesforce Classic Publisher section of the global publisher layout. Only standard
Chatter actions appear on reports, regardless of which other actions are assigned to the global publisher layout.

Example: Let’s say you have these actions on your Contact page layout in the Salesforce Mobile and Lightning Experience Actions
section.

You have quick actions (New Account, New Event, New Task), a productivity action (Call), standard buttons (Edit, Delete, Clone,
Send an Email), and Chatter actions (Poll, Post). Here’s how those actions appear on a contact record page in Lightning Experience.
• The actions in the page-level action menu are a combination of the quick actions, productivity actions, and standard buttons.
These actions appear in the order that they’re listed on the page layout. Although they’re quick actions, New Event and New
Task don’t show up here.

• The Chatter actions from the front of the action list are on the Chatter tab.

718
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• The Activities-related actions—Email, New Event, New Task—display on the Activity tab.

How Actions Are Ordered in Lightning Experience

In Lightning Experience, the actions on record pages are derived from the list of actions in the Salesforce Mobile and Lightning
Experience Actions section of the page layout for that object. The same section on global publisher layouts determines the global
actions that appear in the Global Actions menu.

SEE ALSO:
Quick Actions
Quick Action Considerations
Set Up Cases for Lightning Experience

719
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

How Actions Are Ordered in Lightning Experience

In Lightning Experience, the actions on record pages are derived from the list of actions in the
EDITIONS
Salesforce Mobile and Lightning Experience Actions section of the page layout for that object. The
same section on global publisher layouts determines the global actions that appear in the Global Available in: both Salesforce
Actions menu. Classic (not available in all
If you haven’t customized the Salesforce Mobile and Lightning Experience Actions section of an orgs) and Lightning
object’s page layout, the quick actions that appear on the object’s record pages are derived from: Experience

• The actions on the global publisher layout Quick actions available in:
• Standard and custom buttons in the buttons section of the object page layout Group, Professional,
However, the order of the actions from the global page layout aren’t respected on those record Enterprise, Performance,
Unlimited, Contact
pages.
Manager, Database.com,
When you click to override the predefined actions in the Salesforce Mobile and Lightning Experience and Developer Editions
Actions section, the custom buttons in the buttons section of the page layout aren’t automatically
Custom canvas actions
included in the action list. You must add the custom buttons as actions from the Mobile & Lightning
available in: Professional
Actions category in the palette. (with Canvas enabled),
After you customize the Salesforce Mobile and Lightning Experience Actions section of an object’s Enterprise, Performance,
page layout, the actions in each section of the record page respect the ordering of its types of Unlimited, and Developer
actions on the page layout. For example, actions in the page-level actions menu appear in the order Editions
that you configure them in the Salesforce Mobile and Lightning Experience Actions section on the
page layout. And actions in the Chatter and Activity tabs reflect the order of the actions supported
for those tabs on the page layout.

The Global Actions menu ( ) in the Lightning Experience header displays all global quick actions from the Salesforce Mobile and
Lightning Experience Actions section of the global publisher layout, except the standard Chatter actions Post, File, Poll, Link, Question,
and Thanks.

SEE ALSO:
Actions in Lightning Experience
Send Email Action Considerations for Cases
Quick Actions

Salesforce Mobile App Action Bar

Salesforce mobile app users have a one-stop place to find actions, so there’s no confusion about where to go to do something. The
action bar and its associated action menu collect actions from different places in the app into a single, unified home.
The productivity actions, standard and custom record buttons, and quick actions appear in the action bar and the action menu. The
action bar and action menu show all the available actions for a given page.

720
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Salesforce Mobile App Actions in the Action Bar and Action Menu

The action bar appears in most places in the mobile app, including the feed, groups, user profiles, dashboards and reports, standard and
custom object record views, related lists, and search results. The actions that are available depend on where a user is in the app and on
how you’ve configured page layouts and publisher layouts for your organization.
Users may see some or all of these kinds of actions in the action bar (including the action menu).
• Productivity actions—The Send Email, Call, Map, View Website, and Read News actions are available on accounts, contacts, leads,
and person accounts. The Quick Message, Join Conference Call, and Map actions are available on mobile calendar events in Salesforce
Today.

Tip: In most cases, a productivity action displays only if a record includes the information that the action is keyed to. For
example, the Send Email action depends on the record including an email address. The View Website action requires the
record to include a website URL.

• Custom and standard buttons—Buttons (such as Edit, Delete, or Clone) that are included in the Buttons section on an object’s page
layout are available in the mobile app as actions in the action bar on record pages. If you haven’t customized the action order, the
button order in the button section of the page layout is used. However, the Edit button is in a fixed position.

Note: Custom links, custom buttons that are added to list views, and custom buttons that define the content source as
OnClick JavaScript aren’t supported and don’t appear in the Salesforce mobile app.

• Quick actions—If you add, remove, or reorder actions in the action bar in the global publisher layout or an object’s page layout, the
changes are reflected in the Salesforce mobile app.
• Standard Chatter actions—Actions unique to Chatter, such as Post, File, Link, or Poll.

What are the exceptions?

• On accounts, the Call action appears even when there isn’t a phone number on the record.
• On record feeds, the Follow/Unfollow button remain in the highlights area on the page.

721
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• On public and private group feeds, the Join Group and Ask to Join buttons remain in the highlights area, but the Leave Group
button is in the action bar.

What does this mean for custom branding?

There can be only one version of a custom icon. Custom action icons that you created before Winter ’15 are still supported, but they are
truncated in the action bar. To optimize your custom action icons for display in the action bar, use these guidelines.
• The icon should be 72 x 72 pixels. Use the full pixel area for the image—don’t leave spacing around the image like before.
• Make the image a PNG with a transparent background, with a file size that is less than 10k.
• Have a resolution of 72 dpi.
• Make the icon graphic white or lighter than the background color.
• Avoid heavy inner or outer shadows.
• Use simple and flat styling resembling the Salesforce mobile app icon family.

How Actions Are Ordered in the Salesforce Mobile App Action Bar
The Salesforce Mobile and Lightning Experience Actions section of a page layout and global publisher layout drives which actions
appear in the Salesforce mobile app action bar. It also enables you to customize the order of quick actions, productivity actions, and
standard and custom buttons that are available as actions.
List Item Actions in the Salesforce Mobile App
List item actions give you access to your actions in list views, task lists, and related record lists. You can use list item actions to update
records directly from lists.
How Predefined Actions Are Ordered in the Salesforce Mobile App Action Bar and List Item Actions
Your org’s page layouts and publisher layouts control the order in which actions appear in the Salesforce mobile app action bar and
list item actions. If you don’t customize the actions in the action bar on a page layout or global publisher layout, Salesforce predefines
the location of key actions.
Considerations for Actions in the Salesforce Mobile App

How Actions Are Ordered in the Salesforce Mobile App Action Bar
The Salesforce Mobile and Lightning Experience Actions section of a page layout and global publisher
EDITIONS
layout drives which actions appear in the Salesforce mobile app action bar. It also enables you to
customize the order of quick actions, productivity actions, and standard and custom buttons that Available in: both Salesforce
are available as actions. Classic (not available in all
If you customize the Salesforce Mobile and Lightning Experience Actions section of a layout, the orgs) and Lightning
mobile app reflects your customizations. Experience

If you customize the Quick Actions in the Salesforce Classic Publisher section but not the Salesforce Available in: Group,
mobile app section, the actions in the mobile app action bar are a combination of those in the Professional, Enterprise,
Quick Actions in the Salesforce Classic Publisher section plus any standard or custom buttons present Performance, Unlimited,
on the page layout. Contact Manager,
Database.com, and
When you click to override the predefined actions in the Salesforce Mobile and Lightning Experience
Developer Editions
Actions section, the custom buttons in the buttons section of the page layout aren’t automatically
included in the action list. You must add the custom buttons as actions from the Mobile & Lightning
Actions category in the palette.
If neither section is customized, the action bar inherits a default set of actions predefined by Salesforce. The sets of actions differ between
objects based on the most common or typical activities required for each object.

722
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Note: You can enable dynamic actions for custom object record pages for the Salesforce mobile app. When you enable dynamic
actions, you assign actions in the Lightning App Builder instead of the page layout and apply filters to control when and where
actions appear for users. You can assign the same dynamic actions for desktop and mobile, or assign a different set of dynamic
actions for mobile.

SEE ALSO:
How Predefined Actions Are Ordered in the Salesforce Mobile App Action Bar and List Item Actions
Salesforce Mobile App Action Bar
Considerations for Actions in the Salesforce Mobile App

List Item Actions in the Salesforce Mobile App

List item actions give you access to your actions in list views, task lists, and related record lists. You can use list item actions to update
records directly from lists.
To access list item actions, navigate to a list view or task list or open a related list from an object’s related information page. Then swipe
left on the desired record.
Hide list item actions by swiping the list item back to the right or by tapping another item in the list.

List Views
List item actions in list views don’t have the same actions that are available in the action bar when viewing an object’s record. For example,
when a user visits an opportunity record in the Salesforce mobile app, the actions in its action bar reflect the actions in the Salesforce
Mobile and Lightning Experience Actions section of the Opportunity page layout.
However, when the user swipes left on an opportunity from a list view, as you can see below, the actions that display come from the list
of predefined actions for opportunities. See How Predefined Actions Are Ordered in the Salesforce Mobile App Action Bar and List Item
Actions for the breakdown of predefined actions for each object.

Swipe a list item to the left to reveal list item Tap to show the action menu, with the
Here’s the All Opportunities list view. actions. full list of actions available for the list item.

723
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Related Lists
List item actions on related lists in the app reflect the same actions as the related list in Lightning Experience. Usually, these are the
standard actions Edit and Delete, but can vary by object. For example, in Lightning Experience, the actions available in the dropdown
menu on an Opportunity related list item are the same set of actions that Salesforce mobile app users see when swiping left on the same
record in the related list.

Note: Even if your org doesn’t have Lightning Experience enabled, the actions on related lists that you see in the Salesforce mobile
app still match the actions that would appear on the related list items in Lightning Experience if it was enabled.

724
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Note: Task and event list items are different than other objects when they display in related lists. In the mobile app, when you
tap the Tasks item from the menu, you can swipe left on an item in the My Tasks list view and see the predefined actions for tasks.
However, tasks and events in the Open Activities or Activity History related lists in the mobile app have no actions and aren’t
swipe-able.

How Predefined Actions Are Ordered in the Salesforce Mobile App Action Bar and List Item Actions
Your org’s page layouts and publisher layouts control the order in which actions appear in the Salesforce mobile app action bar and list
item actions. If you don’t customize the actions in the action bar on a page layout or global publisher layout, Salesforce predefines the
location of key actions.

Important: Predefined actions apply to the Salesforce mobile app action bar only if you haven’t customized the Salesforce Mobile
and Lightning Experience Actions section of an object’s page layout or a global publisher layout.
Predefined actions are derived from the Quick Actions in the Salesforce Classic Publisher section of the object page layout or global
publisher layout.
On object page layouts, when the Salesforce mobile app section isn’t customized:
If you customized the Quick Actions in the Salesforce Classic Publisher section, the quick actions in the action bar reflect those
customizations.
If you didn’t customize either section, the quick actions in the action bar come from the Quick Actions in the Salesforce Classic
Publisher section of the global publisher layout.

725
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

On global publisher layouts, when the Salesforce mobile app section isn’t customized:
If you customized the Quick Actions in the Salesforce Classic Publisher section, the quick actions in the action bar reflect those
customizations.
If you didn’t customize either section, the quick actions in the action bar for global pages default to a Salesforce predefined set.
Here’s the breakdown of which actions are contained in each group for each object or page. Keep in mind these considerations:
• The predefined actions in the action bar, list item actions, and associated action menus are divided into groups. The arrangement
of these groups is fixed.
• Unless they’re in an ordered list, the order of actions within the groups can vary based on the object and the actions present on the
global publisher layout or on an object’s page layout.
• Some actions are in fixed positions. For actions in a numbered list, this is the fixed order that they appear in the action bar, list item
actions, and in the respective action menus.
– For example, for the Account object, the standard Chatter Post action is in the fourth position. This position is fixed. Regardless
of where you put the Post action in the account page layout, Post always displays in the fourth position.
– However, deletion of actions is respected. So in our example, if you delete the Post action from the account page layout, the
remaining actions move up and you see Edit in the fourth position.

• Some action groups aren’t supported for every object or page.

Note: Actions on list view items reflect only the predefined set of actions for that object. For example, let’s say you’re viewing the
All Accounts list in the Salesforce mobile app. If you swipe left on an account item in the list, you see a set of actions. Those actions
come from the predefined list of actions for accounts in this chart. You always see Call, Edit, and Delete. The other actions on the
list view item follow the order and rules defined for the action groups in the chart.

Table 2: Account Object

Action Predefined Actions
Group
1 1. Call, 2. New Task, 3. New Event, 4. Post

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Account page
layout. If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the
Salesforce Classic Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page
layout.

6 Send Text (if the Phone field is populated), View Website (if the Website field is populated)

Table 3: Case Object

Action Predefined Actions
Group
1 Actions from the Quick Actions in the Salesforce Classic Publisher section of the Case page layout. If that section isn’t
customized, quick actions are inherited from the Quick Actions in the Salesforce Classic Publisher section of the global
publisher layout

726
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Predefined Actions

Group
2 Edit

3 Action group 3 isn’t supported for the Case object.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page
layout.

6 Productivity actions aren’t supported for this object.

Table 4: Contact Object

Action Predefined Actions
Group
1 1. Call, 2. Send Email, 3. New Task, 4. New Event

2 Edit

3 Remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Contact page layout.
If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the Salesforce
Classic Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.*

5 Remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.

6 Send Text

Table 5: Custom Objects

Action Predefined Actions
Group
1 The first four actions in the order defined on the page layout. If the Quick Actions in the Salesforce Classic Publisher
section of the page layout isn’t customized, then the first four actions in the order defined on the global publisher
layout.

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the page layout. If
that section isn’t customized, remaining quick actions are inherited from the Quick Actions in the Salesforce Classic
Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.*

5 Remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page layout.

6 Action group 6 isn’t supported for custom objects.

727
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Table 6: Event Object

Action Predefined Actions
Group
1 Quick actions in the order defined on the layout. Standard Chatter actions aren’t supported.

2 Edit, Delete

3–6 Action groups 3 to 6 aren’t supported for the Event object.

Table 7: Feed Object

Action Predefined Actions
Group
1 Quick actions in the order defined on the global publisher layout

2–6 Action groups 2 to 6 aren’t supported for the Feed object.

Table 8: Group Object

Action Predefined Actions
Group
1 Actions from the Quick Actions in the Salesforce Classic Publisher section of the Group page layout. If that section
isn’t customized, quick actions are inherited from the Quick Actions in the Salesforce Classic Publisher section of the
global publisher layout.

2–4 Action groups 2 to 4 aren’t supported for the Group object.

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page
layout.

6 Action group 6 isn’t supported for the Group object.

Table 9: Lead Object

Action Predefined Actions
Group
1 1. Log a Call, 2. New Task, 3. Convert (if enabled), 4. Post

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Lead page layout.
If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the Salesforce
Classic Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the Lead page layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the Lead
page layout.

6 In order: Call, Send Text, Send Email

728
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Table 10: “App Page” Lightning Page

Action Predefined Actions
Group
1 Global actions in the order defined in the Lightning page.

2–6 Action groups 2 to 6 aren’t supported for “App Page” Lightning pages.

Table 11: List View

Action Predefined Actions
Group
1 New

2–6 Action groups 2 to 6 aren’t supported for list views.

Table 12: Object Home Page (Tablet Only)

Action Predefined Actions
Group
1 1. New, 2. Sort

2–6 Action groups 2 to 6 aren’t supported for object home pages.

Table 13: Opportunity Object

Action Predefined Actions
Group
1 1. Log a Call, 2. New Task, 3. New Event, 4. Post

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Opportunity
page layout. If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the
Salesforce Classic Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the Opportunity page layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the
Opportunity page layout.

6 Action group 6 isn’t supported for the Opportunity object.

Table 14: Person Object

Action Predefined Actions
Group
1 1. Call, 2. Send Email, 3. Post

2 Action group 2 isn’t supported for the Person object.

729
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Predefined Actions

Group
3 The remaining actions in the order defined on the global publisher layout

4–6 Action groups 4 to 6 aren’t supported for the Person object.

Table 15: Person Account Object

Action Predefined Actions
Group
1 1. Call, 2. Send Email, 3. New Task, 4. New Event

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Person Account
page layout. If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the
Salesforce Classic Publisher section of the global publisher layout.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the Person Account page
layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the page
layout.

6 Read News, Send Text, View Website

Table 16: Related List (for Standard Objects)

Action Predefined Actions
Group
1 New

2–6 Action groups 2 to 6 aren’t supported for related lists.

Table 17: Salesforce Today—Main Page

Action Predefined Actions
Group
1 Quick actions in the order defined on the global publisher layout

2–6 Action groups 2 to 6 aren’t supported for the Salesforce Today main page.

Table 18: Salesforce Today—Mobile Calendar Event

Action Predefined Actions
Group
1 1. Quick Message, 2. Join Conference Call, 3. Map

2 Action group 2 isn’t supported for Salesforce Today mobile calendar events.

730
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Action Predefined Actions

Group
3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Event page
layout. If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the Salesforce
Classic Publisher section of the global publisher layout.

4–6 Action groups 4 to 6 aren’t supported for Salesforce Today mobile calendar events.

Table 19: Task Object

Action Predefined Actions
Group
1 1. Edit Comments, 2. Change Date, 3. Change Status, 4. Change Priority

2 Edit

3 The remaining quick actions from the Quick Actions in the Salesforce Classic Publisher section of the Task page layout.
If that section isn’t customized, the remaining quick actions are inherited from the Quick Actions in the Salesforce
Classic Publisher section of the global publisher layout. Standard Chatter actions aren’t supported.

4 Custom buttons that are supported in the Salesforce mobile app, in the order defined on the Task page layout.*

5 The remaining standard buttons that are supported in the Salesforce mobile app, in the order defined on the Task
page layout.

6 Action group 6 isn’t supported for the Task object.

*
Custom buttons that are added to the Button section of a page layout and that define the content source as URL or Visualforce
are supported in the Salesforce mobile app. Remember that Visualforce pages must be enabled for use in the Salesforce mobile app.
Custom links, custom buttons that are added to list views, and custom buttons that define the content source as OnClick
JavaScript aren’t available in the Salesforce mobile app.

SEE ALSO:
How Actions Are Ordered in the Salesforce Mobile App Action Bar
Salesforce Mobile App Action Bar
Considerations for Actions in the Salesforce Mobile App

731
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Considerations for Actions in the Salesforce Mobile App

• Most actions, including quick actions, productivity actions, and standard and custom buttons,
EDITIONS
are displayed in the action bar in the Salesforce mobile app.
• The Save & New action button isn’t available in the Salesforce mobile app. Available in: both Salesforce
• The Delete action is available on record pages only, not record detail pages. Classic (not available in all
orgs) and Lightning
• In most cases, a productivity action appears only if a record includes the information that the
Experience
action is keyed to. For example, the Send Email action depends on the record including an
email address. The View Website action requires the record to include a website URL. On Available in: Group,
accounts, the Call action appears even when there isn’t a phone number on the record. Professional, Enterprise,
Performance, Unlimited,
• By default, the Call productivity action in the mobile app action bar uses the global Log A Call
Contact Manager,
action layout. If you create one Log a Call action on an object, users see that custom Log a Call
Database.com, and
action’s layout when they tap Call from the object's action bar. If you create more than one
Developer Editions
Log a Call action for the same object, the Call action on that object uses the global Log a Call
action layout.
• There are a few differences between the Send Email quick action in Salesforce and the standard Email action in Case Feed:
– Users can’t switch between the rich text editor and the plain text editor in a Send Email action.
– Templates aren’t supported in the Send Email action.
– Quick Text isn’t available in the Send Email action.
– The Send Email action doesn’t support attachments.
– Users can’t save messages as drafts when using the Send Email action.
– Users can’t edit or view the From field in the Send Email action.

• If feed tracking isn’t enabled on an object, only nonstandard actions appear in the Salesforce mobile app action bar and in third-party
apps that use action lists. Nonstandard actions include Create, Update, Log a Call, custom actions, and Mobile Smart Actions.
• If you’re using record types in your org, sometimes quick actions aren't visible to your users. For more information, see Quick Actions
and Record Types on page 706.
• The Mobile Smart Actions element appears as a single action element in the page layout editor, but it expands to several actions
when it appears in the Salesforce mobile app. If the Mobile Smart Actions element is in Quick Actions in the Salesforce Classic
Publisher section when you customize the action bar section, the actions in the app use your action bar customizations. In this case,
the Mobile Smart Actions element in the Quick Actions in the Salesforce Classic Publisher section becomes irrelevant.
• To customize the actions in the Salesforce mobile app action bar for standard and custom objects, first override the predefined
actions. You can then add or remove actions from the Salesforce Mobile and Lightning Experience Actions section.
For instance, to move the Join Group, Edit Group, or Leave Group actions on groups in the Salesforce mobile app, override the
predefined actions in the Groups page layout.

• Using URL custom buttons to pass parameters to standard pages in Salesforce Classic—such as prepopulating fields when creating
a record—doesn’t work in the Salesforce mobile app.
• If you add a custom button to the Salesforce Mobile and Lightning Experience Actions section of a page layout, it has a lightning
bolt icon in the Salesforce mobile app action bar. If the Salesforce Mobile and Lightning Experience Actions section isn't customized,
the icon in the app action bar is a wrench.

SEE ALSO:
How Actions Are Ordered in the Salesforce Mobile App Action Bar
How Predefined Actions Are Ordered in the Salesforce Mobile App Action Bar and List Item Actions

732
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Buttons and Links

Custom buttons and links help you integrate Salesforce data with external URLs, applications, your
EDITIONS
company’s intranet, or other back-end office systems.
Salesforce supports these custom links and custom buttons. Available in: Salesforce
Classic
Type of Custom Link or Custom Button Setup Page Where It’s Configured
Available in: All Editions
Bookmark-style links defined in the standard Home Page Components except Database.com
custom links home page component

Full-featured custom links included in custom Custom Links USER PERMISSIONS

home page components
To create or change custom
Full-featured custom links or custom buttons Buttons, Links, and Actions (in the object’s buttons or links:
on objects management settings) • Customize Application

Custom links can link to an external URL, such as www.google.com, a Visualforce page, or your company’s intranet. Custom links
can also link to a custom s-control in the custom s-control library, such as a Java applet or Active-X control.
Custom buttons can:
• Connect users to external applications, such as a web page that displays a map to a contact’s address.
• Run an s-control from the s-control library, such as an s-control that escalates a case from the case detail page.
• Launch custom links.
You can choose the display window properties that determine how the target of a link or button is displayed to your users. Custom links
and s-controls can include Salesforce fields as tokens within the URL or custom s-control. For example, you can include an account name
in a URL that searches Yahoo: http://search.yahoo.com/bin/search?p={!Account_Name}.
You can override the default action of some standard buttons and customize the behavior of tab home pages to suit your org’s needs.

Define Custom Buttons and Links

Define the action that occurs when a user clicks a custom button or link. Custom buttons and links can streamline actions within
Salesforce or integrate Salesforce data with external URLs, applications, or systems.
Override Standard Buttons and Tab Home Pages
You can override the behavior of standard buttons—like New, View, or Edit—in Salesforce Classic, Lightning Experience, and mobile
independently. You can also override the tab home page that displays when a user clicks a standard, custom, or external object tab.
Custom Button and Link Samples
Use samples of custom Salesforce buttons and links to determine whether they can work for you.
Custom Button and Link Considerations
Keep these considerations in mind when working with custom buttons and links.
Custom Button and Link Considerations
Keep these limitations in mind when working with custom buttons and links.

733
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Viewing References to Salesforce Components

SEE ALSO:
Define Custom Buttons and Links
Adding Default Custom Links
Salesforce Classic Home Tab Page Layouts

Define Custom Buttons and Links

Define the action that occurs when a user clicks a custom button or link. Custom buttons and links
EDITIONS
can streamline actions within Salesforce or integrate Salesforce data with external URLs, applications,
or systems. Available in: Salesforce
Watch a Demo (English only) Classic (not available in all
orgs)
If you want the button or link to launch a custom page or other code, consider a Visualforce page.
1. From the management settings for the object that you want to edit, go to Buttons, Links, and Custom buttons and links
are available in: All Editions
Actions.
Visualforce pages and
Note: Custom buttons aren’t available on the User object or custom home pages. Custom s-controls are available in:
buttons and links are available for activities under the individual object management Contact Manager, Group,
settings for tasks and events. To override a standard button that applies to both tasks and Professional, Enterprise,
events, go to the object management settings for activities. Performance, Unlimited,
and Developer Editions
2. Click New Button or Link. Alternatively, click Default Custom Links to add a predefined
custom link.
3. For Display Type, select Detail Page Link, Detail Page Button, or List Button. USER PERMISSIONS

Note: If you select List Button, and your list button requires users to select individual To create or change custom
records in a list, then select Display Checkboxes (for Multi-Record Selection). When buttons or links:
you select this option, a checkbox appears next to each list item to let users select records, • Customize Application
and the list button action is applied to those records. Don’t select Display Checkboxes
(for Multi-Record Selection) if your list button doesn’t require users to select individual
records in the list. For example, your list button links to a URL that doesn’t support POST
operations, such as a URL that links to a Lightning component. In Lightning Experience,
when you select Display Checkboxes (for Multi-Record Selection), the related list
type must be set to Enhanced List. You can set the related list type from the Related
List–Single component or Related Lists component on a record page in the Lightning
App Builder.

4. Enter the button or link attributes.

Here’s an example of the attributes for a button that performs a web search for an account’s name.

734
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

5. To validate all Salesforce merge fields and functions, click Check Syntax.
6. Click Save when you’re finished, or click Quick Save to save and continue editing. If you set the content source to URL, saving
validates the URL you defined.
7. To open a button or link using settings other than the user’s default browser settings, click Window Open Properties on the button
or link’s detail page.
8. To view all references to the new button or link, click Where is this used? on its detail page.
Custom links for users are automatically added to the Custom Links section of the user detail page. You can add page buttons only
to the Button section of a page layout.

Note: A link URL can be up to 2,048 bytes. When data is substituted for the tokens in the URL, the link can exceed 3,000 bytes.
Some browsers enforce limits on the maximum URL length.
Before you can use your custom buttons and links, add them to an object’s page layout. You can then see and use the button or link on
a record detail page.

Custom Button and Link Fields

This table describes the fields that are available when you create a custom button or link.
Constructing Effective Custom URL Buttons and Links
Use these methods to construct effective custom URL buttons and links.
Editing Window Open Properties
Merge Fields for Custom Buttons and Links

735
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Adding Default Custom Links

Custom Link Best Practices
Custom buttons and links can streamline actions within Salesforce, or integrate Salesforce data with external URLs, applications, or
systems. Use these best practices to get the most out of your custom links.

SEE ALSO:
Find Object Management Settings
Custom Button and Link Considerations
Custom Button and Link Considerations
Custom Button and Link Samples

Custom Button and Link Fields

This table describes the fields that are available when you create a custom button or link.
EDITIONS
Attribute Name Description Available in: Salesforce
Label Enter the text that displays in the user interface for the custom button or Classic (not available in all
link. orgs)

Custom buttons and links

Name Accept or enter the unique name to use for the button or link when it’s
are available in: All Editions
referenced from a merge field. This name can contain only underscores
and alphanumeric characters, and must be unique in your org. It must Visualforce pages and
begin with a letter, not include spaces, not end with an underscore, and s-controls are available in:
not contain two consecutive underscores. Contact Manager, Group,
Professional, Enterprise,
Namespace Enter the prefix that uniquely identifies your package. In a packaging Performance, Unlimited,
Prefix context, a namespace prefix is a one to 15-character alphanumeric identifier and Developer Editions
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 organizations. It keeps your
managed package under your control exclusively.

Protected Optionally limit use in a subscriber org. Protected components can’t be

Component 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, after a component is marked
as unprotected and is released globally, the developer can’t delete it.

Description Enter text that distinguishes the button or link from others. This text displays
only to administrators when setting up buttons and links.

Display Type Determine where the button or link appears on page layouts.
Detail Page Link
Adds the link to the Custom Links section of your page layouts.
Detail Page Button
Adds the custom button to a record’s detail page. You can add detail
page buttons to the Button section of a page layout.

736
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Attribute Name Description

List Button
Adds the custom button to a list view, search result layout, or related list. You can add list buttons
to the Related List section of a page layout or the List View and Search Result layouts.
For list buttons, Salesforce selects the Display Checkboxes (for Multi-Record Selection) option
to include a checkbox next to each record in the list. Users can select the records they want applied
to the action on the list button. If your custom button doesn’t require the user to select records,
deselect this option.

Behavior Choose the outcome of clicking the button or link.

When applicable, some settings have default values. For example, if you choose Display in new
window, the default height of a new window is 600 pixels. See Editing Window Open Properties.

Note:
• Custom buttons that use a URL to link to a Visualforce page open the page in the same tab,
even if the Display in new window option is selected.
• Custom button links open in a new tab in Experience Builder sites, even if any of the Display
in existing window options is selected, except for those that use a URL to link to a Visualforce
page.

Content Source Choose whether to use a URL, s-control, JavaScript action, or Visualforce page as the content of the
button or link.
Salesforce checks the correctness of URLs in custom links and custom buttons. When you create or edit
custom links or buttons that contain invalid URL markup, such as scripts, Salesforce blocks the links
from rendering. Instead, an error message is shown on hover. Reconfigure the URLs to be valid and
well formed. The URL can be a relative URL or an absolute http://, https://, file://,
ftp://, or mailto:// address. Invalid URLs in custom links or custom buttons created before
Spring ’13 aren’t checked for correctness until you edit them.

Content Enter the content of the button or link for buttons and links of type URL or OnClick JavaScript.
• To insert a field, choose the field type from Select Field Type and choose a field from Insert Field.
• To insert activity merge fields, select Event or Task from Select Field Type.
• To insert an operator, choose the appropriate operator icon from the Insert Operator
dropdown list.
• To insert a function, double-click its name in the list, or select it and click Insert Selected Function.
To filter the list of functions, choose a category from the Functions dropdown list. Select a
function and click Help on this function to view a description and examples of formulas using
that function.

Tip: Internet standards require special encoding for URLs. Salesforce encodes the text from any
merge field you insert into a link. Encode extra text in your link manually. For example, to generate
the following URL:
http://www.google.com/search?q={!user.name} Steve Mark 50%

737
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Attribute Name Description

Use this content:

http://www.google.com/search?q={!user.name}+Steve+Mark+50%25

Salesforce strips double quotes from URLs when the content source is a URL. If you must use
double quotes, encode them manually. For example, to generate the URL
http://www.google.com/search?q="salesforce+foundation", use this
content:
http://www.google.com/search?q=%22salesforce+foundation%22

Link Encoding Choose the encoding setting. Encoding defaults to Unicode (UTF-8). Change the default encoding
setting if the target of a link requires data in a different format. Encoding is available if your Content
Source is URL.

Constructing Effective Custom URL Buttons and Links

Use these methods to construct effective custom URL buttons and links.
EDITIONS
Use merge fields to pass Salesforce data.
You can add merge fields to a custom link to pass data from your Salesforce records, user Available in: Salesforce
information, or company information to another website or application. Classic (not available in all
orgs)
For example, you can create custom links that search Google for an account name or look up
an address on a map. Custom buttons and links
are available in: All Editions
Visualforce pages and
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

http://google.com/search?q={!Account.Name}

http://maps.google.com?q={!Account.ShippingStreet} {!Account.ShippingCity}
{!Account.ShippingState} {!Account.ShippingPostalCode}

Note: Custom links don’t support data type conversion. When creating custom links to pass data from one Salesforce field
to another, the data must match the data type of the fields in which you are placing it. For example, if you have numeric data,
you must pass it to a numeric field.
Substitute symbols for certain characters or use URLENCODE().
Due to URL encoding standards set forth by the World Wide Web Consortium (W3C), certain “unsafe” characters, such as spaces and
punctuation marks, can’t be passed through a URL. Custom buttons and links escape these characters, so you don’t have to URL-encode
them.
If you need to encode your URL, use the URLENCODE() function in the merge field like so: {!URLENCODE(text)} and
replace text with the merge field or text string that you want to encode.

738
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

For example: If the merge field foo__c contains <B>Mark's page<b>, {!URLENCODE(foo_c)} results in:
%3CB%3EMark%27s%20page%3C%2Fb%3E.
Use URLFOR() to link to Visualforce pages.
To link to a Visualforce page, use URLFOR() with the relative path to the page, which is /apex/PageName. For example, to
link to a Visualforce page called MissionList that isn’t associated with a record, use the following syntax.
{! URLFOR( “/apex/MissionList” ) }

When you use URLFOR() with a Visualforce page, and you want to pass a record ID into the page, you must pass the ID in as a
parameter.
{! URLFOR( “/apex/Mission”, null, [id=Mission__c.Id] ) }

Use the $Action global variable and URLFOR() to point to Salesforce pages.
When creating a custom button or link that points to a page in Salesforce, use the $Action global variable to construct the link,
instead of pasting in the path to the page. Then, if your organization is moved to another server or the URL to the page changes,
the link still points to the right place.
To construct the link, use the URLFOR() formula function with the $Action variable.
{!URLFOR( $Action.Case.NewCase, Account.Id )}

This custom link on the Account object opens the New Case form, creating the case as a child of the account record. You can use
this process for any object that has a lookup to the Account object. To create a record that isn’t a child of another record, or if two
objects have no relationship, you can use $ObjectType.ObjectName as the second argument. For example:

{!URLFOR( $Action.Case.NewCase, $ObjectType.Case )}

$Action global variables expect either a record ID or the $ObjectType. For example, these formulas create links to the tab
and detail page for an account, respectively.
{!URLFOR( $Action.Account.Tab, $ObjectType.Account )}

{!URLFOR( $Action.Account.View, Some_Account_Lookup__c.Id )}

The URLFOR() function takes additional optional arguments that get passed into the destination as query string parameters. You
can use these arguments when overriding a standard action with a Visualforce page to pass in the additional parameters needed
by the Visualforce page or its controller. For example, if when closing a case you want to change the value of a custom field on the
case called Actual Delivery Date to today, you could use:
{!URLFOR($Action.Case.CloseCase, Case.Id, [ actualDeliveryDate=TODAY()] )}

You can then override the Close Case action with a Visualforce page and handle setting the value of the Actual Delivery Date field
either in that Visualforce page or its controller. See Using Query String Parameters in a Visualforce Page for more information.
Use these Lightning-friendly URL button and link methods to point to other pages in Lightning Experience.

Custom URL Button or Link Lightning Experience Behavior

External URL URL opens in new tab
www.google.com

Relative Salesforce URL, View Record home page opens in existing tab
/{!Account.Id}

739
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom URL Button or Link Lightning Experience Behavior

Relative Salesforce URL, Edit Edit overlay pops up on the existing page
/{!Account.Id}/e

Relative Salesforce URL, List Object home page opens in existing tab
/001/o

$Action URL, View Record home page opens in existing tab

{!URLFOR($Action.Account.View, Account.Id)}

$Action URL, Edit Edit overlay pops up on the existing page

{!URLFOR($Action.Account.Edit, Account.Id)}

Note: Using URL custom buttons to pass parameters to standard pages in Salesforce Classic—such as prepopulating fields
when creating a record—doesn’t work in the Salesforce mobile app.

SEE ALSO:
Custom Link Example: Link to Documents
Custom Link Example: Link to Files in Chatter
Custom Link Example: Link to Reports

Editing Window Open Properties

Custom buttons and links can open in different types of windows. If you have selected a custom
EDITIONS
button or link to open in a popup window, set the window properties. If you leave the window
properties blank, the custom button or link will use the default settings of the user’s browser. Available in: Salesforce
To edit the window open properties: Classic
1. From the management settings for the object whose button or link you want to edit, go to Available in: All Editions
Buttons, Links, and Actions, and then click the button or link name. Custom buttons are not except Database.com
available on the user object. S-controls are available in:
2. Click Window Open Properties. Contact Manager, Group,
Professional, Enterprise,
3. Edit the following properties.
Performance, Unlimited,
and Developer Editions
Window Property Description
Width The width (in pixels) of the popup.
USER PERMISSIONS
Height The height (in pixels) of the popup.
To edit custom button or link
Window Position The location on the screen where the popup properties:
should open. • Customize Application
Resizeable Allow users to resize the popup window.

740
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Window Property Description

Show Address Bar Show the browser’s address bar which contains the URL.

Show Scrollbars Show browser scrollbars for the popup.

Show Toolbars Show the browser toolbars. Toolbars normally contain navigation
buttons like Back, Forward, and Print.

Show Menu Bar Show the browser menus. The menus typically contain option
like File and Edit.

Show Status Bar Show the status bar at the bottom of the browser.

Note: Some properties may not be available depending on the behavior of the custom button or link. For example, if you
chose Execute JavaScript, no window open properties are available.

4. Save your changes.

SEE ALSO:
Define Custom Buttons and Links

Merge Fields for Custom Buttons and Links

A merge field is a field you can put in an email template, mail merge template, custom link, or
EDITIONS
formula to incorporate values from a record.
Available in: Salesforce
Syntax and Formatting Classic (not available in all
orgs)
When you insert a merge field in a custom button or link, the syntax consists of an open curly brace
and exclamation point, followed by the object name, a period, the field name, and a closing curly Custom buttons and links
brace. are available in: All Editions
Visualforce pages and
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

{!Object_Name.Field_Name}

To ensure that you’re using the correct syntax, select merge fields from the dropdown list in the editor for custom buttons and links.

Note: Custom objects named “Org”, can’t be used in a merge field. Objects named “org’ are explicitly filtered from the Select Field
Type list for a custom button.

Tips
• To insert activity merge fields, select Event or Task from the Select Field Type dropdown list.

741
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• You can add links quickly to the sidebar by using the standard home page’s Custom Links component.

Warning: The standard home page’s Custom Links component doesn’t support
– Merge fields
– Functions, such as URLFOR
– JavaScript execution
– Customizable window opening properties

SEE ALSO:
Generate Emails From Records
Custom Button and Link Considerations

Adding Default Custom Links

1. From the management settings for the appropriate object, go to Buttons, Links, and Actions
EDITIONS
or to Buttons and Links.
2. Click Default Custom Links. Available in: Salesforce
Classic
3. Next to a sample link you want to add, click Add Now!.
4. Change the default data for the link, as necessary. Available in: All Editions
except Database.com
5. Choose Save.
6. Edit the page layout for the appropriate tab to display the new link.
USER PERMISSIONS

SEE ALSO: To create or change custom

links:
Define Custom Buttons and Links
• Customize Application

Custom Link Best Practices

Custom buttons and links can streamline actions within Salesforce, or integrate Salesforce data with
EDITIONS
external URLs, applications, or systems. Use these best practices to get the most out of your custom
links. Available in: Salesforce
Note: Salesforce checks the correctness of URLs in custom links and custom buttons. When Classic (not available in all
orgs)
you create or edit custom links or buttons that contain invalid URL markup, such as scripts,
Salesforce blocks the links from rendering. Instead, an error message is shown on hover. Custom buttons and links
Reconfigure the URLs to be valid and well formed. The URL can be a relative URL or an absolute are available in: All Editions
http://, https://, file://, ftp://, or mailto:// address. Invalid URLs in
Visualforce pages and
custom links or custom buttons created before Spring ’13 aren’t checked for correctness until s-controls are available in:
you edit them. Contact Manager, Group,
Professional, Enterprise,
Best Practices for Advanced Users Performance, Unlimited,
and Developer Editions
Salesforce has no plans to change field names; however, that doesn’t guarantee that field names
won’t change in the future. Therefore, custom links that include Salesforce fields may change how
they are mapped.

742
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Pass Session IDs with SSL

Never pass session IDs to an “http” URL. Instead, pass session IDs with a secure sockets layer (SSL) “https” URL. Any data that is
passed to other applications hosted on the Internet should always use SSL since the URL may contain sensitive customer information.
Single Sign-On
Use custom links to pass a session ID to support Single Sign-On (SSO), so users can avoid multiple logins to web applications that
your organization hosts to manage Salesforce data. Construct your custom link to pass the {!User_Session_ID} merge field,
which allows users to access all authorized resources during a single authentication. External systems can access Salesforce resources
using a web service, which allows organizations to communicate data without intimate knowledge of each other's IT systems behind
a firewall.
Send the Server Date in the URL
Some integration projects need custom links to include a server date to know the Salesforce initiation date. The Salesforce server
date can be passed to external systems using custom links. For example,
http://someurl.com/somepath?current_date={!Today}. Dates use the Pacific time zone.
Avoid Double Sets of Tabs in a Browser
Unlimited Edition and Enterprise Edition users can build a custom link to perform an action that keeps users in the same browser
window and doesn’t display a double set of tabs. Create a Visualforce page that contains the following code, replacing
<REGULAR_WIL> with your regular or existing custom link.

<script language="JavaScript">
function redirect() {
parent.frames.location.replace("<REGULAR_WIL>")
}
redirect();
</script>

743
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Override Standard Buttons and Tab Home Pages

You can override the behavior of standard buttons—like New, View, or Edit—in Salesforce Classic,
EDITIONS
Lightning Experience, and mobile independently. You can also override the tab home page that
displays when a user clicks a standard, custom, or external object tab. Available in: Salesforce
Button overrides are global. For example, if you override the New button on opportunities, your Classic (not available in all
replacement action takes effect wherever that action is available, such as: orgs) and Lightning
Experience
• Opportunities home page
• Any opportunities related lists on other objects, such as accounts Available in: Enterprise,
Performance, Unlimited,
• Create New dropdown list in the Salesforce Classic sidebar
and Developer Editions
• Any browser bookmarks for this Salesforce page
Visualforce overrides also
1. From the object management settings for the object you want to set an override for, go to available in: Contact
Buttons, Links, and Actions. Manager, Group, and
2. Click Edit next to the button or tab home page you want to override. Professional Editions
Record types available in:
3. For each experience—Salesforce Classic, Lightning Experience, or mobile—click the type of
Professional, Enterprise,
override you want associated with the action.
Performance, Unlimited,
• No override (use default)—Use a custom override provided by an installed package. If and Developer Editions
there isn't one installed, the standard Salesforce behavior is used.
• Standard page—This option is available only for subscribers who are overriding the actions
on an installed custom object. If selected, the standard Salesforce behavior is used. USER PERMISSIONS
• Custom s-control—Use the behavior from an s-control. This option isn’t supported for To override standard buttons
mobile. and tab home pages:
• Customize Application
Important: Visualforce pages supersede s-controls. Organizations that haven't
previously used s-controls can’t create them. Existing s-controls are unaffected, and To reset button and tab
home page overrides:
can still be edited.
• Customize Application
• Lightning component—Use the behavior from a Lightning component. Supported only
for the Edit, New, New Event, Tab and View actions. This option isn’t supported for Salesforce
Classic.
• Lightning page—Use the behavior from the Lightning record page assigned as the org default for the object. This option is
available only for the View action in Lightning Experience.
• Visualforce page—Use the behavior from a Visualforce page.
• Use the Salesforce Classic override—Inherits the behavior from the Salesforce Classic Override setting.

Important: Before you override a standard button with a Lightning component or Visualforce page, review implementation
details in the respective developer guides.

4. Select the name of the s-control, Lightning component, Lightning page, or Visualforce page you want to run when users click the
button or tab.
When overriding the New button with a Visualforce page, you can choose to skip the record type selection page. If you do, new
records you create aren’t forwarded to the record type selection page. Salesforce assumes that your Visualforce page is already
handling record types.

Important: When a Salesforce mobile app user clicks New to create a product, the user must select a record type even if the
Skip record type selection page option is selected in Setup.

5. Click Save.

744
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Note: A standard button (New, Edit, View, Delete, and Clone) overridden with a Visualforce page doesn’t show up in the Salesforce
mobile app unless the Visualforce page is enabled for Salesforce mobile apps. Overriding standard list and tab controls isn’t
supported in mobile.

Standard Action Overrides

For standard actions, such as Delete, Edit, List, New, Tab, and View, you can provide a custom user interface for the action, called an
action override. Use action overrides when your business model requires a more customized user experience than the Salesforce
standard page provides.
Considerations for Overriding Standard Buttons
Before you override a standard button, review these considerations.
Remove Overrides for Standard Buttons and Tab Home Pages

SEE ALSO:
Considerations for Overriding Standard Buttons
Remove Overrides for Standard Buttons and Tab Home Pages
Visualforce Developer Guide: Overriding Buttons, Links, and Tabs with Visualforce
Lightning Aura Components Developer Guide: Standard Actions and Overrides Basics

Standard Action Overrides

For standard actions, such as Delete, Edit, List, New, Tab, and View, you can provide a custom user
EDITIONS
interface for the action, called an action override. Use action overrides when your business model
requires a more customized user experience than the Salesforce standard page provides. Available in: Salesforce
You can specify a different override for each user experience, with the following guidelines. Classic (not available in all
orgs) and Lightning
• Salesforce Classic—Use a Visualforce page as the action override.
Experience
• Lightning Experience and the Salesforce mobile app —You can override the Edit, New, Tab,
and View standard actions on most standard and all custom objects. Available in: Enterprise,
Performance, Unlimited,
• Lightning Experience—Use a Lightning component as the action override for the Edit, New,
and Developer Editions
and Tab actions. Use a Lightning page or a Lightning component as the action override for the
View action. Visualforce overrides also
available in: Contact
• Aura Experience Builder sites—Use a custom Lightning component to replace standard forms Manager, Group, and
when users click the New or Edit button. The action that you choose in Lightning Experience Professional Editions
is the same action that you use to override actions in Aura Experience Builder sites.
Record types available in:
• Salesforce app—Use a Lightning component as the action override. Professional, Enterprise,
• Managed packages—Developers can include action overrides as package defaults, and managed Performance, Unlimited,
package subscribers can specify local overrides as alternatives to the default overrides. and Developer Editions

Note: For Salesforce Classic, usually a Visualforce page is the only supported override option.
Under certain conditions, you can use existing s-controls as overrides for Salesforce Classic. USER PERMISSIONS
However, s-controls have been deprecated since the Spring ’09 release. We recommend using
Visualforce pages instead. To override standard
buttons:
• Customize Application

745
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Assign Action Overrides

To assign a Visualforce page or Lightning component as an override, first create the page or component (or use one created by a
Salesforce developer in your org). It’s important to understand the action override options for each user experience and how your
selections for each one can affect the others.
Assign a Lightning Record Page Override for the View Action
When you create an override for the View action for Lightning Experience, you can use either a Lightning record page or a Lightning
component. To use a Lightning record page as an override, you must activate the page in the Lightning App Builder and choose
the type of override you want.
Action Overrides in Managed Packages
In a managed package, overrides specified by the package developer are included as default overrides. The package subscriber can
specify local overrides for each user experience to use instead of the package default overrides. Package default overrides impact
the options and behaviors of local overrides.
Action Overrides in Aura Experience Builder Sites
Personalize your site users’ experience in Aura Experience Builder sites by adding a custom Lightning component to replace standard
forms when users click the New or Edit button. Use action overrides when your site and portal users require a more customized user
experience than the Salesforce standard page provides.

SEE ALSO:
Trailhead: Introduction to Creating Visualforce Pages
Lightning Aura Components Developer Guide: Override Standard Actions with Aura Components

Assign Action Overrides

To assign a Visualforce page or Lightning component as an override, first create the page or
EDITIONS
component (or use one created by a Salesforce developer in your org). It’s important to understand
the action override options for each user experience and how your selections for each one can Available in: Salesforce
affect the others. Classic (not available in all
When assigning overrides, keep in mind the following requirements. orgs) and Lightning
Experience
• Salesforce Classic—To use a Visualforce page to override an action, the Visualforce page must
use the standard controller for the object on which the action appears. To use a Visualforce Available in: Enterprise,
page to override a tab, the Visualforce page must use the standard list controller for that tab’s Performance, Unlimited,
associated object. and Developer Editions
• Lightning Experience and the Salesforce mobile app—To make a Visualforce page available Visualforce overrides also
for use as an override, select Available for Lightning Experience, Experience Builder sites, available in: Contact
and the mobile app in the Visualforce Pages setup panel. Manager, Group, and
Professional Editions
1. From Setup, select Object Manager, and select the object that you want to modify.
Record types available in:
2. In the Object Manager settings list, select Buttons, Links, and Actions. Professional, Enterprise,
3. In the row for the action you want to modify, select Edit from the dropdown menu. Performance, Unlimited,
and Developer Editions
4. Specify the override option for each user experience.

USER PERMISSIONS

To override standard
buttons:
• Customize Application

746
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Example: This Override Properties panel specifies a Visualforce page for Salesforce Classic and a Lightning component for
Lightning Experience. The mobile override specifies the Salesforce Classic override, so mobile users see the Visualforce page.

SEE ALSO:
Trailhead: Introduction to Creating Visualforce Pages
Lightning Aura Components Developer Guide: Override Standard Actions with Aura Components

Assign a Lightning Record Page Override for the View Action

When you create an override for the View action for Lightning Experience, you can use either a
EDITIONS
Lightning record page or a Lightning component. To use a Lightning record page as an override,
you must activate the page in the Lightning App Builder and choose the type of override you want. Available in: Salesforce
1. From Setup, enter Lightning App in the Quick Find box, and select Lightning App Classic (not available in all
Builder. orgs) and Lightning
Experience
2. Click Edit next to the Lightning page that you want to use as an override.
3. In the Lightning App Builder, click Activation. Available in: Enterprise,
Performance, Unlimited,
You have a few options for activating a Lightning record page as an override. and Developer Editions
• Make the page the org default for the object. Visualforce overrides also
After you activate the Lightning page as the org default, the page is selected as the Lightning available in: Contact
Experience override for the View action in the Override Properties panel. Manager, Group, and
Professional Editions
• Make the page the default object record page for specific Lightning apps.
Record types available in:
If you activate the Lightning record page for specific Lightning apps only, the page takes Professional, Enterprise,
precedence over the Lightning Experience Override setting for the View action on the object Performance, Unlimited,
in those apps. and Developer Editions

• Assign the page to a combination of Lightning apps, record types, and profiles.
USER PERMISSIONS
4. To remove the Lightning page as an override, return to the Activation page in the Lightning
App Builder, select the type of override you want to remove, and walk through the activation To override standard
wizard. buttons:
• Customize Application

747
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Example: In this Override Properties panel, the Lightning page Account_Lightning_Page_Test is the specified
Lightning Experience override for the View action.

SEE ALSO:
Create and Configure Lightning Experience Record Pages

Action Overrides in Managed Packages

In a managed package, overrides specified by the package developer are included as default
EDITIONS
overrides. The package subscriber can specify local overrides for each user experience to use instead
of the package default overrides. Package default overrides impact the options and behaviors of Available in: Salesforce
local overrides. Classic (not available in all
Several rules determine local override behaviors in a managed package. orgs) and Lightning
Experience
• For each user experience—When a package subscriber specifies a local override, the local
override takes precedence over the package default override. If no local override is specified Available in: Enterprise,
for a user experience, the package default override for that user experience is used. Performance, Unlimited,
• For Lightning Experience and the Salesforce mobile app—If no local override is specified and and Developer Editions
no package default override is specified, the local override inherits from Salesforce Classic. Either Visualforce overrides also
the Salesforce Classic local override (if it is specified) is used, or the Salesforce Classic package available in: Contact
default override (if no Salesforce Classic local override is specified) is used. Manager, Group, and
Professional Editions
• A package developer can remove or replace the default overrides when updating a managed
package. The new default overrides are available for package subscribers when they install the Record types available in:
updated package. Professional, Enterprise,
Performance, Unlimited,
Example: The Override Properties panel for a managed package identifies the override and Developer Editions
defaults and the local override options for each user experience. The available local override
options vary based on the override defaults.
• No override (use default)—Uses either the override default Visualforce page or the
USER PERMISSIONS
Salesforce standard page if no Visualforce page is specified. To override standard
• Standard page—Available for package subscribers only if the package default override buttons:
for the given user experience is a Visualforce page or Lightning component. • Customize Application

748
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• Lightning component—The specified component takes precedence over the package default override for the given user
experience.
• Use the package default override—Available for package subscribers only if the package default override for the given
user experience is a Lightning component.
• Use the Salesforce Classic override—Available for package subscribers only if the package default override for the given
user experience is the Salesforce standard page. Option inherits from the local Salesforce Classic override.

Action Overrides in Aura Experience Builder Sites

Personalize your site users’ experience in Aura Experience Builder sites by adding a custom Lightning
EDITIONS
component to replace standard forms when users click the New or Edit button. Use action overrides
when your site and portal users require a more customized user experience than the Salesforce Available in: Salesforce
standard page provides. Classic (not available in all
To override actions in an Aura Experience Builder site: orgs) and Lightning
Experience
1. From Setup, in the Quick Find box, enter Digital Experiences, and then select All
Sites. Available in: Enterprise,
Performance, Unlimited,
2. Next to the site that you want to override, click Workspaces.
and Developer Editions
3. Click Administration.
Applies to: Aura sites
4. In the Preferences section, under Experience Management, select Override standard actions
with the Lightning component.
The action that you choose in Lightning Experience is the same action that you use to override USER PERMISSIONS
actions in Experience Builder sites. To override standard
buttons:
5. Save your changes.
• Customize Application
Note: Action overrides aren’t available in Visualforce sites or Lightning Web Runtime (LWR)
sites.

749
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Considerations for Overriding Standard Buttons

Before you override a standard button, review these considerations.
EDITIONS

Implementation Tips Available in: Salesforce

Classic (not available in all
Important: Before you override a standard button with a Lightning component or Visualforce orgs) and Lightning
page, review implementation details in the respective developer guides. Experience
• If you override a standard button in Salesforce, that button is still available in Connect Offline, Available in: Enterprise,
but it retains its original behavior. Performance, Unlimited,
• The View standard button refers to all links in Salesforce that display the detail page for a record. and Developer Editions
Overriding the View standard button reroutes all of these links. Visualforce overrides also
• The View action is the only one that supports overrides with a Lightning record page. To make available in: Contact
a Lightning record page available for a View action override, activate it in the Lightning App Manager, Group, and
Builder. Activating the Lightning record page assigns it as the org default for its associated Professional Editions
object. Record types available in:
• If you have the View action overridden with a Visualforce page in Salesforce Classic, the Setup Professional, Enterprise,
menu on that object record page in Lightning Experience displays the Edit Page option. Selecting Performance, Unlimited,
Edit Page in Lightning Experience on an object page that’s overridden with a Visualforce page and Developer Editions
in Salesforce Classic lets you create a custom Lightning Experience record page for that object
in the Lightning App Builder.
USER PERMISSIONS
• If a button isn’t available for overrides, you can still hide it on the page layout.
• Button overrides affect everywhere that action or behavior is available. For example, overriding To override standard
the New button on an account also overrides the account option in the Create New dropdown buttons:
list in the Salesforce Classic sidebar. • Customize Application

• Person Account records use any standard button overrides that you make for accounts. Person
Account records also use any overrides for the View Self-Service and Enable Self-Service buttons that you make for contacts.
• If your organization uses the Console tab, overrides for the Edit and View buttons for an object don’t affect the Edit and View buttons
in the mini page layouts. Pages that display due to overrides display in the console without the header or sidebar.
• To replace a standard button with a custom button, first define the custom button, then customize the page layout to hide the
standard button and display the custom one in its place.
• When you override the Edit button with a Visualforce page, you’re also overriding default logic that checks whether the record has
been locked for approval. However, you can perform the same check by implementing the Approval.lock Apex method.

Limitations
• You can override buttons on the detail page but not the edit page of a record.
• You can only override these standard buttons: New, View, Edit, and Delete.
• For tasks in Salesforce Classic, you can only override standard buttons and links.
• You can’t change buttons on lookup dialogs, reports, or tabs. However, you can change the buttons on list view and search result
layouts under search layouts.
• Action overrides on the New standard button don't work on New Object links in lookup searches.
• For objects with multiple record types, the Outlook and Gmail integrations don’t support action overrides unless you choose to skip
the record type selection page.
• You can’t relabel or relocate standard buttons on a record detail page.

750
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

• When overriding tabs or buttons with a Lightning component, you can select only Lightning components that implement the
lightning:actionOverride interface.
• Visualforce overrides to standard actions such as View, New, Edit, and Delete aren’t supported in Experience Builder sites. When
Visualforce overrides are applied to these actions, the buttons don’t appear on record detail pages in sites.
• A standard button (New, Edit, View, Delete, and Clone) overridden with a Visualforce page doesn’t show up in the Salesforce mobile
app unless the Visualforce page is enabled for Salesforce mobile apps. Overriding standard list and tab controls isn’t supported in
mobile.
• When overriding tabs with a Visualforce page, you can select only Visualforce pages that use the standard list controller for that tab’s
associated object, pages with a custom controller, or pages with no controller.
• When overriding lists with a Visualforce page, you can select only Visualforce pages that use a standard list controller.
• When overriding buttons with a Visualforce page, you can select only Visualforce pages that use the standard controller for the
object on which the button appears. For example, if you want to use a page to override the Edit button on accounts, the page
markup must include the standardController="Account" attribute on the <apex:page> tag:
<apex:page standardController="Account">

... page content here ...

</apex:page>

SEE ALSO:
Override Standard Buttons and Tab Home Pages
Visualforce Developer Guide: Overriding Buttons, Links, and Tabs with Visualforce
Lightning Aura Components Developer Guide: Standard Actions and Overrides Basics

751
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Remove Overrides for Standard Buttons and Tab Home Pages

To remove overrides for actions that support overrides for Classic, Lightning, and mobile web:
EDITIONS
1. From the management settings for the object whose button you want to edit, go to Buttons,
Links, and Actions. Available in: Salesforce
Classic (not available in all
2. Click Edit next to the overridden button or tab link.
orgs) and Lightning
3. Select No override (use default) for the Salesforce Classic override Experience
4. To also remove overrides for Lightning Experience or Mobile, select Use the Salesforce Classic Available in: Enterprise,
override. Performance, Unlimited,
5. Click Save and Developer Editions
Visualforce overrides also
available in: Contact
Manager, Group, and
Professional Editions
Record types available in:
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To override standard buttons

and tab home pages:
• Customize Application
To reset button and tab
home page overrides:
• Customize Application

To remove overrides for actions that support only Classic:

1. From the management settings for the object whose button you want to edit, go to Buttons, Links, and Actions.
2. Click Edit next to the overridden button or tab link.
3. Select No override (use default) for Salesforce Classic Override.
4. Click Save

752
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Button and Link Samples

Use samples of custom Salesforce buttons and links to determine whether they can work for you.
EDITIONS

Custom Link Example: Link to Documents Available in: Salesforce

Use custom links to reference documents from a Salesforce record detail page. Classic (not available in all
orgs)
Custom Link Example: Link to Files in Chatter
Use custom links to reference files from Chatter. Custom buttons and links
are available in: All Editions
Custom Link Example: Link to Reports
Visualforce pages and
Use custom links to run reports with filtered results from a Salesforce record detail page. For
s-controls are available in:
example, let’s say you frequently run a mailing list report for the contacts related to an account.
Contact Manager, Group,
You can create a custom link for accounts that links directly to a report that is automatically
Professional, Enterprise,
filtered to the account you are viewing. In this case, your custom link must pass the account’s Performance, Unlimited,
unique record ID to the report. and Developer Editions
Create a Custom Button for Performing Mass Deletes
This example creates a JavaScript custom button for Salesforce Classic that can be added to
activity-related lists and list views and allows users to delete selected records at the same time. USER PERMISSIONS
Displaying Alerts To create or change custom
This example creates a button that opens a popup dialog with a welcome message containing buttons or links:
the user's first name. • Customize Application

Getting Record IDs

This example creates a button that opens a popup window listing record IDs for user selected records. This is useful when testing
to ensure you have the correct record IDs before processing them further.
Passing Record IDs to an External System Example
You can use Salesforce record IDs as unique identifiers for integrating with an external system. This example creates a button that
calls a Visualforce page to determine the record IDs of selected records and passes them in a URL query parameter to an external
Web page called “www.yourwebsitehere.com.”
Launching Record Create Page with Default Field Values
Construct custom buttons and links that pass default field values to a record create page. This feature applies to Lightning Experience
in all editions. This feature doesn’t apply to Lightning Out, Experience Builder sites, or the Salesforce mobile app.
Reopening Cases Example
This example creates a button that can be added to cases related lists so users can reopen several cases on an opportunity at once.

753
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

International Maps Example

This example creates a link that displays a country-specific Google map.

SEE ALSO:
Define Custom Buttons and Links

Custom Link Example: Link to Documents

Use custom links to reference documents from a Salesforce record detail page.
EDITIONS
1. Create a folder on the Documents tab to which all users have access.
Available in: Salesforce
2. Upload the document to that folder.
Classic (not available in all
3. From the Documents tab, choose the folder and click Go. orgs)
4. Click View next to the document. Custom buttons and links
5. Copy the document’s URL from the browser. For example, are available in: All Editions
Visualforce pages and
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

https://MyDomainName.my.salesforce.com/servlet/servlet.FileDownload?file=015300000000xvU.
6. Use everything after the domain portion of the URL to create your custom link. Using the example in the previous step, your link
would point to /servlet/servlet.FileDownload?file=015300000000xvU.

SEE ALSO:
Constructing Effective Custom URL Buttons and Links
Custom Link Example: Link to Files in Chatter
Custom Link Example: Link to Reports

754
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Link Example: Link to Files in Chatter

Use custom links to reference files from Chatter.
EDITIONS
1. Upload a file to the Files tab.
Available in: Salesforce
2. When the upload is finished, from the Upload dialog box, click Share settings.
Classic (not available in all
3. Click Anyone with link. orgs)
4. Copy the document’s URL from the Share via Link dialog box. For example, Custom buttons and links
are available in: All Editions
Visualforce pages and
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

https://MyDomainName.my.salesforce.com/sfc/p/D0000000JsES/a/D000000001dd/aiq8UPJ5q5i6Fs4Sz.IQLKUERsWYdbAm320cjqWnkfk=.
5. Use everything after the domain portion of the URL to create your custom link. Using the example in the previous step, your link
would point to
/sfc/p/D0000000JsES/a/D000000001dd/aiq8UPJ5q5i6Fs4Sz.IQLKUERsWYdbAm320cjqWnkfk=.

SEE ALSO:
Constructing Effective Custom URL Buttons and Links
Custom Link Example: Link to Documents
Custom Link Example: Link to Reports

755
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Link Example: Link to Reports

Use custom links to run reports with filtered results from a Salesforce record detail page. For example,
EDITIONS
let’s say you frequently run a mailing list report for the contacts related to an account. You can
create a custom link for accounts that links directly to a report that is automatically filtered to the Available in: Salesforce
account you are viewing. In this case, your custom link must pass the account’s unique record ID Classic (not available in all
to the report. orgs)
1. Copy the ID for the type of record by which you want to filter your report (in this example, an
Custom buttons and links
account). To do so, view the record and copy the 15-character ID from the last part of the URL. are available in: All Editions
For example,
https://MyDomainName.my.salesforce.com/001200030012j3J. Visualforce pages and
s-controls are available in:
2. From the Reports tab, create the report you want by either customizing a standard report or Contact Manager, Group,
creating a custom report. Professional, Enterprise,
3. Filter the report by the record ID you copied. For example, “Account ID equals 001200030012j3J”. Performance, Unlimited,
and Developer Editions
4. Run the report to verify that it contains the data you expect.
5. Click Customize.
USER PERMISSIONS
6. Click Save or Save As to save the report to a public folder accessible by the appropriate users.
Save doesn’t create a custom report, whereas Save As does. To create or change custom
7. Run the report and copy the report’s URL from the browser. buttons or links:
• Customize Application
8. Begin creating your custom link. Set the Content Source field to URL. In the large formula
text area, paste the report URL you copied. Remember to omit the domain portion
https://MyDomainName.my.salesforce.com.
9. Add the custom link to the appropriate page layouts.
10. Verify that the new custom link works correctly.

Tip: When creating a report for use in a custom link, set date ranges and report options generically so that report results include
data that can be useful for multiple users. For example, if you set a date range using the “Created Date” of a record, set the Start
Date far enough in the past to not exclude any relevant records and leave the End Date blank. If you scope the report to just “My”
records, the report might not include all records that a user can see. Try setting the report options to “All visible” records.

SEE ALSO:
Constructing Effective Custom URL Buttons and Links
Custom Link Example: Link to Documents
Custom Link Example: Link to Files in Chatter

756
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Create a Custom Button for Performing Mass Deletes

This example creates a JavaScript custom button for Salesforce Classic that can be added to
EDITIONS
activity-related lists and list views and allows users to delete selected records at the same time.

Note: JavaScript custom buttons are supported in all editions, in Salesforce Classic only. The Available in: Salesforce
mass delete function described here doesn’t work in editions where the API isn’t enabled. Classic (not available in all
orgs)
1. Define a button for events with the following attributes.
Custom buttons and links
• Display Type List Button
are available in: All Editions
Note: Select Display Checkboxes (for Multi-Record Selection) so users can select Visualforce pages and
multiple records in the list before clicking the button. s-controls are available in:
Contact Manager, Group,
• Behavior Execute JavaScript Professional, Enterprise,
• Content Source OnClick JavaScript Performance, Unlimited,
• Use the following sample code. and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

{!REQUIRESCRIPT("/soap/ajax/9.0/connection.js")}

var records = {!GETRECORDIDS( $ObjectType.Event )};

var taskRecords = {!GETRECORDIDS( $ObjectType.Task)};
records = records.concat(taskRecords);

if (records[0] == null) {
alert("Please select at least one record.") }
else {

var errors = [];

var result = sforce.connection.deleteIds(records);
if (result && result.length){
var numFailed = 0;
var numSucceeded = 0;
for (var i = 0; i < result.length; i++){
var res = result[i];
if (res && res.success == 'true'){
numSucceeded++;
} else {
var es = res.getArray("errors");
if (es.length > 0) {
errors.push(es[0].message);
}
numFailed++;
}
}

757
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

if (numFailed > 0){

alert("Failed: " + numFailed + "\nSucceeded: " + numSucceeded + " \n Due to: " +
errors.join("\n"));
} else {
alert("Number of records deleted: " + numSucceeded);
}
}
window.location.reload();
}

2. Add the button to your activity list views.

3. Add the button to any page layout that contains an activity-related list. The button deletes any selected task or event in the list.
You can install custom buttons from the Mass Delete app at https://appexchange.salesforce.com/.

SEE ALSO:
Custom Button and Link Samples

Displaying Alerts
This example creates a button that opens a popup dialog with a welcome message containing the
EDITIONS
user's first name.
1. Define a button with the following attributes. Available in: Salesforce
Classic (not available in all
Option Description
orgs)
Display Type Detail Page Button
Custom buttons and links
Behavior Excute JavaScript are available in: All Editions
Visualforce pages and
Content Source OnClick JavaScript
s-controls are available in:
Contact Manager, Group,
Use the following sample code.
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

alert ("Hello {!$User.FirstName}");

2. Add the button to the appropriate page layout.

SEE ALSO:
Custom Button and Link Samples

758
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Getting Record IDs

This example creates a button that opens a popup window listing record IDs for user selected
EDITIONS
records. This is useful when testing to ensure you have the correct record IDs before processing
them further. Available in: Salesforce
1. Define a button with the following attributes. Classic (not available in all
orgs)
• Display Type List Button
Custom buttons and links
Note: Select Display Checkboxes (for Multi-Record Selection) so users can select
are available in: All Editions
multiple records in the list before clicking the button.
Visualforce pages and
• Behavior Execute JavaScript s-controls are available in:
• Content Source OnClick JavaScript Contact Manager, Group,
Professional, Enterprise,
• Use the following sample code.
Performance, Unlimited,
and Developer Editions

idArray = {!GETRECORDIDS($ObjectType.Contact)};
alert("The Ids you have selected are: "+idArray);

Note: This example is for contacts. Change the object type for a different type of record.

2. Add the button to the appropriate related list on a page layout or list view layout.

SEE ALSO:
Custom Button and Link Samples

759
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Passing Record IDs to an External System Example

You can use Salesforce record IDs as unique identifiers for integrating with an external system. This
EDITIONS
example creates a button that calls a Visualforce page to determine the record IDs of selected
records and passes them in a URL query parameter to an external Web page called Available in: Salesforce
“www.yourwebsitehere.com.” Classic (not available in all
1. Create a Visualforce page that uses the GETRECORDIDS function to retrieve a list of selected orgs)
records: Custom buttons and links
are available in: All Editions
Visualforce pages and
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

<script type="text/javascript">

idArray = {!GETRECORDIDS($ObjectType.Account)};

window.location.href="http://www.yourwebsitehere.com?array="+idArray;

</script>

Note: Replace www.yourwebsitehere.com with your own URL.

2. Define a button for accounts with these attributes:

Option Description

Display Type List Button

Select Display Checkboxes (for Multi-Record Selection) so
users can select multiple records in the list before clicking the
button.

Behavior Display in existing window with sidebar.

Content Source Visualforce page.

3. Select the Visualforce page you created in the first step.

760
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

4. Add the button to the appropriate page layout or list view layout.

SEE ALSO:
Custom Button and Link Samples

Launching Record Create Page with Default Field Values

Construct custom buttons and links that pass default field values to a record create page. This feature applies to Lightning Experience
in all editions. This feature doesn’t apply to Lightning Out, Experience Builder sites, or the Salesforce mobile app.
To construct a custom button or link, encode any field that is read from a record and contains special characters, like commas. Use this
sample formula:
/lightning/o/Account/new?defaultFieldValues=
Name={!URLENCODE(Account.Name)},
OwnerId={!Account.OwnerId},
AccountNumber={!URLENCODE(Account.AccountNumber)},
NumberOfEmployees=35000,
CustomCheckbox__c={!IF(Account.SomeCheckbox__c, true, false)}

Important: The URLENCODE function works only when creating custom buttons and links. You can’t use it for custom fields.
The TEXT function is supported for custom number fields, but it returns only the numbers without any separators, like commas.

Note: Passing the RecordTypeId to defaultFieldValues isn’t yet supported. The recordTypeId influences
routing behavior, layout assignment, and page assignment, so you can see unexpected results if you try to use it.

Reopening Cases Example

This example creates a button that can be added to cases related lists so users can reopen several
EDITIONS
cases on an opportunity at once.
1. Define a button for cases with the following attributes. Available in: Salesforce
Classic (not available in all
Option Description
orgs)
Display Type List Button
Custom buttons and links
Behavior Execute JavaScript are available in: All Editions
Visualforce pages and
Content Source OnClick JavaScript
s-controls are available in:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

761
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Use this sample code:

{!REQUIRESCRIPT ("/soap/ajax/13.0/connection.js")} var records =
{!GETRECORDIDS($ObjectType.Sample)}; var newRecords = []; if
(records[0] == null) { alert("Please select at least one row") } else {
for (var n=0; n<records.length; n++) { var c = new
sforce.SObject("Case"); c.id = records[n]; c.Status = "New";
newRecords.push(c); } result = sforce.connection.update(newRecords);
window.location.reload(); }

This example references the AJAX Toolkit, which is available if API access is enabled. See
https://developer.salesforce.com/page/Integration. Notice the check for records[0] == null, which displays a message to
users when they don’t select at least one record in the list.

2. Add the button to your opportunity page layouts by editing the Cases related list.
Use this button on any page layout that contains the cases related list, such as account or contact page layouts.

SEE ALSO:
Custom Button and Link Samples

International Maps Example

This example creates a link that displays a country-specific Google map.
EDITIONS
1. Define a link for accounts with the following attributes.
Available in: Salesforce
Option Description
Classic (not available in all
Display Type Detail Page Link orgs)

Behavior Display in new window Custom buttons and links

are available in: All Editions
Content Source URL
Visualforce pages and
s-controls are available in:
Use this sample code:
Contact Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application

{!
IF(Sample.BillingCountry = "US",
"http://maps.google.com/maps?q="&Sample.BillingStreet&
"+"&Sample.BillingCity&"+"&Sample.BillingState&"+"&Sample.BillingCountry,
(IF(Sample.BillingCountry = "UK",
"http://maps.google.co.uk/maps?q="&Sample.BillingStreet

762
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

&"+"&Sample.BillingCity&"+"&Sample.BillingCountry,
"http://maps.google.com")))
}

2. Add the link to your account page layout.

SEE ALSO:
Custom Button and Link Samples

Custom Button and Link Considerations

Keep these considerations in mind when working with custom buttons and links.
EDITIONS

Implementation Tips Available in: Salesforce

Classic (not available in all
• Custom buttons display at the top and bottom of the detail page to the right of all standard orgs)
buttons.
• Custom buttons aren’t distinguished from standard buttons in any graphical way. However, Custom buttons and links
are available in: All Editions
you can recognize them by their location on the right of all standard buttons.
• If the button bar gets too wide on the detail page layout, the browser displays a horizontal Visualforce pages and
scroll bar. If the button bar gets too wide on the list view, search result, tagging result, or related s-controls are available in:
Contact Manager, Group,
list layouts, the buttons wrap.
Professional, Enterprise,
• Custom buttons are available for activities under the individual setup links for tasks and events. Performance, Unlimited,
To add a custom button to an activity list view or search layout, first create a custom list button and Developer Editions
in tasks or events. Next, add it to your activity list view or search result layouts. You can override
a button that applies to both tasks and events.
• Person Account records use the custom buttons and links you have made for accounts. USER PERMISSIONS
• If your organization uses the Console tab, list buttons are available in Mass Action. List To create or change custom
buttons don’t display in the mini page layouts. Pages that display due to custom buttons and buttons or links:
links display in the console without the header or sidebar. • Customize Application
• If you get an error message when overriding a button that appears in a list, try calling the
s-control using the URLFOR function.
• When creating custom buttons, be aware of any validation rules your organization has for records on that object. For example, some
custom list buttons that change case status conflict with a case validation rule. In this scenario, Salesforce displays the error message
for the validation rule when users click the custom button.
• To replace a standard button with a custom button, first define the custom button, then customize the page layout to hide the
standard button and display the custom one in its place.
• Visualforce pages used as custom buttons or links on detail pages must specify a standard controller of the same object.
• Visualforce pages used as custom list buttons must use a standard list controller of the same object.
• A web tab or custom link could display a blank page if the embedded site:
– Has been set to deny the loading of its content in a frame.
– Has been set to allow the loading of its content in a frame only if the same site is delivering the content.
– Contains a mix of secure and unsecure content, and the user’s browser has been configured to block mixed active content.
To resolve this issue, try these workarounds.
– Set your custom link to either open in a new window or display in the existing window without the sidebar or header.

763
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

– Move the URL from a web tab into a custom link instead. Set the URL to either open in a new window or display in the existing
window without the sidebar or header.
– If the site you’re embedding has an HTTP prefix and mixed active content, try changing the prefix to HTTPS. If the embedded
site has a valid security certificate and it hasn’t blocked itself from being displayed in frames, using HTTPS as the prefix allows
the site to display.

Best Practices
• Use formula functions in custom buttons with caution. Because functions run on the server before your HTML or JavaScript is passed
to the browser, they can only evaluate information that exists at that time. Don’t use functions like IF to evaluate conditions that
only exist when the code reaches the browser, such as the value of a JavaScript variable that your code returns.
• To prevent a user from performing a particular action, such as creating or editing, change the user’s permissions rather than hiding
the standard button. Hiding a standard button removes it from a page layout, but the link is still available and users can navigate to
the new or edit page manually.
• Use global variables to access special merge fields for components like custom buttons, links, and s-controls. For example, the
$Request global variable allows you to access query parameters inside a snippet, s-control, or custom button.
• When you create a custom list button, select Display Checkboxes (for Multi-Record Selection) only if your list button requires
users to select individual records in a list. If your list button doesn’t require users to select individual records, don’t select this option.
Don’t select Display Checkboxes (for Multi-Record Selection) if your list button links to a URL that doesn’t support POST operations,
such as a URL that links to a Lightning component.
• In Lightning Experience, when you select Display Checkboxes (for Multi-Record Selection), the related list type must be set to
Enhanced List. You can set the related list type from the Related List–Single component or Related Lists component on a record
page in the Lightning App Builder.
• If you create multiple custom list buttons on a list and select Display Checkboxes (for Multi-Record Selection)
for at least one of the list buttons, checkboxes appear next to records in the list. But those checkboxes aren’t activated for custom
list buttons without Display Checkboxes (for Multi-Record Selection) selected.

Considerations for the Salesforce Mobile App

• Custom buttons that are added to the Button section of a page layout and that define the content source as URL or Visualforce
are supported in the Salesforce mobile app. Remember that Visualforce pages must be enabled for use in the Salesforce mobile app.
Custom links, custom buttons that are added to list views, and custom buttons that define the content source as OnClick
JavaScript aren’t available in the Salesforce mobile app.

• Using URL custom buttons to pass parameters to standard pages in Salesforce Classic—such as prepopulating fields when creating
a record—doesn’t work in the Salesforce mobile app.
• Custom images used for action icons must be less than 1 MB in size.

SEE ALSO:
Custom Button and Link Considerations
Define Custom Buttons and Links
Custom Button and Link Samples

764
Extend Salesforce with Clicks, Not Code Provide Actions, Buttons, and Links

Custom Button and Link Considerations

Keep these limitations in mind when working with custom buttons and links.
EDITIONS
• A custom link’s label can’t exceed 1,024 characters.
• A link URL can be up to 2,048 bytes. When data is substituted for the tokens in the URL, the link Available in: Salesforce
can exceed 3,000 bytes. Some browsers enforce limits on the maximum URL length. Classic (not available in all
orgs)
• Custom buttons that call JavaScript aren’t supported in Lightning Experience.
• Custom buttons with a content source of OnClick JavaScript aren’t supported in the Salesforce Custom buttons and links
app. are available in: All Editions

• Using URL custom buttons to pass parameters to standard pages in Salesforce Classic—such Visualforce pages and
as prepopulating fields when creating a record—doesn’t work in the Salesforce mobile app. s-controls are available in:
Contact Manager, Group,
• On record detail pages for external objects that are associated with high-data-volume external Professional, Enterprise,
data sources, custom buttons, and links that call JavaScript aren’t supported. Performance, Unlimited,
• Custom buttons aren’t available for Web-to-Lead, Web-to-Case, the Case Teams related list, or and Developer Editions
the user object.
• Custom buttons on search results pages aren’t supported in Lightning Experience.
• When you redirect to an external website with merge fields, use the Text Field data type field. If you use the URL data type field, the
link breaks because symbols in the link are converted to hexadecimal code.
• Some URL custom buttons open links in the same tab, even if the button behavior is set to open in a new window. For example,
URL links to Visualforce pages always open in the same tab.
• Visualforce pages used as custom links on the home page can’t specify a controller.

SEE ALSO:
Custom Button and Link Considerations
Define Custom Buttons and Links

765
Extend Salesforce with Clicks, Not Code External Services

Viewing References to Salesforce Components

You can view a list of all the areas in Salesforce that reference a component. For example, view the
EDITIONS
custom links, custom buttons, or page layouts that reference another component, such as a
Visualforce page or static resource. To do this, click Where is this used? from the detail page of Available in: Salesforce
the component. Salesforce lists the type of component that references the component and the Classic
label for that component. Click any item in the list to view it directly.
Custom buttons and links
are available in: All Editions
SEE ALSO:
Visualforce pages and
Define Custom Buttons and Links custom components
available in: Contact
Manager, Group,
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or change custom

buttons or links:
• Customize Application
To create, edit, and delete
Visualforce pages and
custom components:
• Customize Application
To clone, edit, or delete static
resources:
• Customize Application

External Services
Connect your Salesforce org to an external API using zero lines of code. Use declarative tools and
EDITIONS
OpenAPI specifications to describe the external API functionality, and External Services automatically
creates invocable actions within Salesforce. Use External Services for outbound integrations from Available in: Lightning
Salesforce using low code, process-based integrations or to turbo charge your Apex integrations. Experience
Call the invocable actions natively from Apex, or create a flow or Einstein bot that interacts with
the external API source. Available in: Enterprise,
Performance, Unlimited,
With External Services, you first register OpenAPI 2.0 or OpenAPI 3.0 schemas. The operations and Developer Editions
imported from your registered schema automatically become invocable in Apex, or as External
Services action types within point-and-click automation tools such as Flow Builder, Orchestrator,
Einstein bots, or OmniStudio Assets.
External Services is best used when the externally hosted service is a RESTful service and the API specification is available in OpenAPI 2.0
or OpenAPI 3.0 JSON schema format.

Introduction Video
Watch the Introduction video to see how you can declaratively transform API specifications into invocable actions.

766
Extend Salesforce with Clicks, Not Code External Services

Watch a video

Example Use Cases

The examples in this section demonstrate typical External Services workflows.
Considerations
Here are the semantic, service, and usage constraints to keep in mind when integrating your services into External Services.
Register an External Service
Provide an API spec that describes your endpoint's services and methods. The API spec’s schema generates the external service
operations with corresponding input and output parameters. You can also edit an exisiting registration, register an external service
with a Mulesoft API, or register an external service using Flow Bulder's HTTP Callout functionality.
Use Flow to Invoke External Service Actions
In this Flow example, design and test the automation that sends a user’s information from Salesforce to the external employee
banking system. Create the variables for user phone numbers, and combine different phone numbers into one piece of data. Then
use the external service action to create the user.
Invoke External Service Callouts Using Apex
You can call external service registrations natively from Apex. Make a callout to an external service like the Apex Http Class
without the need to write boilerplate code. The registered services are strongly typed in Apex with the registration’s schema as Apex
types. These Apex types reflect your registered service’s specification, making the Apex compiler do the heavy lifting for you.
Add External Service Actions to an Einstein Bot
Integrating your Einstein bot with a registered external service is now as easy as adding an action to a dialog. You can add an external
service action to your bot from Einstein’s Bot Builder.
Invoke External Services from OmniStudio Assets
You can invoke External Services registered actions from OmniStudio Integration Procedures in OmniScripts and FlexCards.
Install or Create Packages
You can install or create packages that contain an external service. Read these tips before you begin.
Testing External Services
Test the example flow MyAtmFlow with a flow action calling the external service MyAtmExternalService by implementing
the HttpCalloutMock interface. The interface provides a test response without performing the callout to the external service
endpoint. The sample Apex unit test performs a mock test against the same HTTP callout mock implementation.
Schema Examples
Explore various scenarios with OpenAPI 2.0 and OpenAPI 3.0 compliant JSON schemas supported by External Services. The examples
cover schema elements like HTTP header as input parameters, and include example usage in Apex. Understanding the examples
helps with proper syntax and code placement.

Example Use Cases

The examples in this section demonstrate typical External Services workflows.
EDITIONS

Connect to a credit service. Available in: Lightning

Experience
To illustrate how External Services work, let’s say you want to connect Salesforce to an external
credit service. The credit service determines if credit can be extended to a Salesforce account. You Available in: Enterprise,
also want to know the payment terms. Performance, Unlimited,
and Developer Editions

767
Extend Salesforce with Clicks, Not Code External Services

First, you create a Named Credential by supplying a URL and authentication settings for the credit service. Salesforce uses these items
to make callouts to the external service. With External Services, you then select whether you get your API spec from Mulesoft Anypoint
Platform, or from an API spec provided elsewhere. To register an API spec:
1. Enter a URL (or endpoint) to the location of the hosted OpenAPI specification (”API spec”) for the external service, or provide (paste
in) the complete schema from the API spec. For Mulesoft, provide your credentials and select the API spec.
2. Select the operations from the schema you want to make available in Salesforce as invocable actions, and complete the registration.
External Services walks you through it so that you don’t directly touch the API. You can also skip writing Apex code to make the callout.
After you’ve registered your new external service, use a Salesforce point-and-click automation tool, such as Flow Builder or Einstein Bots.
Create a flow using the External Service type for flow actions automatically generated from your External Services registration. When
the flow runs, the output contains the credit decision and, if applicable, payment terms.

Automatically add a new org user to external applications.

Another use case involves saving time when you add new users to an org. For instance, you want new users to automatically become
collaborators for all external org-related applications. Create a flow using inputs such as user ID, which you can define in your API spec’s
schema. Then you add triggers in your flow. When a user is created, the triggers engage and add the new user as a collaborator to your
other applications.

Send alerts to an external application with Apex.

If your business logic requires more tailored processing needs, you can easily extend the reach of your Apex logic to external integrations
conforming to OpenAPI specifications. You can extend Apex by calling out to a registered external service. In one use case, a detailed
alert is sent to a third-party application if an urgent case is opened.

Considerations
Here are the semantic, service, and usage constraints to keep in mind when integrating your services into External Services.

OpenAPI 2.0 and 3.0 Support

Learn about valid API schema components that can be used to register a spec successfully.
Authentication
To authenticate, External Services uses defined authentication parameters in Named Credentials.
Schema Definition Support
Learn about External Services' schema limits and other considerations.
Schema Update Support
You can register an updated schema version for one currently in use in flow or Apex that includes supported components. This section
provides details about whether changes are supported.

SEE ALSO:
External Services OpenAPI 2.0 Schema
External Services OpenAPI 3.0 Schema
Using the Schema Examples

768
Extend Salesforce with Clicks, Not Code External Services

OpenAPI 2.0 and 3.0 Support

Learn about valid API schema components that can be used to register a spec successfully.
EDITIONS
Along with normal packaging support, you can use:
Available in: Lightning
• Nested parameters—rendered as Dynamic Apex-defined data type in Apex and Flow Builder.
Experience
• Named arrays, anonymous arrays, or inline arrays, supported as generic List type in Apex,
or as collection type in Flow Builder. Available in: Enterprise,
Performance, Unlimited,
• OpenAPI additionalProperties as generic Map type in Apex.
and Developer Editions
• Header parameters in HTTP requests.
• The following media types are supported:
– application/json -- Structured data in JSON format
– application/x-www-form-urlencoded -- URL encoded form
– text/plain -- Unstructured data as plain text

• Non-supported media types can be mapped to supported media types for request and response content serialization. See Media
Type Mapping in External Service Registrations on page 795.
• Form data parameters are supported.
• Supports all Java runtime supported character set encodings. UTF-8 is the default encoding.
• OpenAPI 2.0: Server and operation level consumes and produces directives.
• OpenAPI 3.0: Content media type with supported media types.

Supported Schema Format

• OpenAPI 2.0, JSON schema format
• OpenAPI 3.0, JSON schema format
• UTF-8, with full character set for names and identifiers

Unsupported Schema Formats

• Interagent hyper-schema format
• OpenAPI 2.0 schema, YAML format
• OpenAPI 3.0 schema, YAML format

Unsupported Schema Constructs

• OpenAPI 3.0: The composite schema keyword: not
• Media types such as xml, png, and pdf

769
Extend Salesforce with Clicks, Not Code External Services

Authentication
To authenticate, External Services uses defined authentication parameters in Named Credentials.
EDITIONS
External Services doesn’t respect:
Available in: Lightning
• A schema’s securityDefinitions and security sections.
Experience
• Authentication data stored in a flow. The standard HTTP request headers Accept,
Content-Type, and Authorization are handled by the External Service and can't be Available in: Enterprise,
overridden as OpenAPI operation input parameters. The Authorization header is set by the Performance, Unlimited,
Named Credential. and Developer Editions

To create a Named Credential, see Define an External Credential and a Named Credential on page
779.

Schema Definition Support

Learn about External Services' schema limits and other considerations.
EDITIONS

Limits Available in: Lightning

External Services maximum system limits for registrations, schema size, operations, objects, and Experience
properties. Available in: Enterprise,
Schema Definitions Performance, Unlimited,
Learn the basics about External Service's schema support, schema components that are ignored, and Developer Editions
and supported data types.
Character Set Encodings
Learn about request and response character set encodings.
Media Type Directives and Mapping
Learn about OpenApi 2.0 consumes/produces or OpenAPI 3.0 content media type schema directives.
Naming and Description Conventions
Learn about support for component names and descriptions defined in your schema
Operation Output Parameters
Learn about how External Services interprets an operation's output parameters.
properties and additionalProperties
In an OpenAPI specification, the named properties are accessible as Apex properties with matching property type. additionalProperties
allow for free form map or dictionary properties with a common property value type that are accessible in Apex as a Map property.
Apex Class Names and Developer Names
Learn how External Services derives Apex class names from your schema.
Apex Reserved Keywords
Learn about External Service's support for Apex reserved keywords.
Null Values
Learn null values are interpreted by External Services.
Callout and Usage Considerations
Best practices for callouts to and from External Services.

770
Extend Salesforce with Clicks, Not Code External Services

Limits
External Services maximum system limits for registrations, schema size, operations, objects, and
EDITIONS
properties.
Available in: Lightning
Limit VALUE Experience
Max External Service registrations 150 per org Available in: Enterprise,
Performance, Unlimited,
Max schema size 10,000,000 characters (10.0 MB)
and Developer Editions
Max active operations 1250 per org

Max active and inactive operations 10,000 total per org

Max active objects 1250 per org

Max active and inactive objects 10,000 total per org

Max object properties 400,000 total per org

SEE ALSO:
Considerations

Schema Definitions
Learn the basics about External Service's schema support, schema components that are ignored,
EDITIONS
and supported data types.
When you create your API spec, keep the following in mind. Available in: Lightning
Experience
• You can use the GET, PATCH, PUT, POST, and DELETE methods in a schema.
• A property must include a value. Available in: Enterprise,
Performance, Unlimited,
• Each parameter must have a name.
and Developer Editions
• Request headers are supported.
• Response headers aren’t supported.
• Form parameters are supported.
• Security settings defined in the API spec are ignored and defer to security settings in the Named Credential.
The following OpenAPI schema components are ignored:
• security requirement objects and security definitions
• tag objects
• external documentation objects
• For allOf, oneOf, and anyOf, the schema object property discriminator is supported. The
discriminator/mapping in OpenApi 3.0 is ignored The discriminator property determines the schema referenced
by its type name. For more information, see the Swagger OpenAPI 3.0 specification Inheritance and Polymorphism.
Supported data types:
• boolean
• date
• datetime

771
Extend Salesforce with Clicks, Not Code External Services

• double
• float
• integer
• long
• string
• any type (as Apex Object)
• object: top level named and nested anonymous objects
• anonymous and top-level named lists (can nest both named and anonymous arrays)
• additionalProperties as maps
• allOf as an object composition
• OpenAPI 3.0 only:
– anyOf (any of primitive, list, or object schema types; only object schemas can constitute composition types)
– oneOf (one of primitive, list, or object schema types)

SEE ALSO:
Schema Examples

Character Set Encodings

Learn about request and response character set encodings.
EDITIONS
The request body is encoded by the character set in the operation’s resolved request schema
directive. For example, application/json; charset=ISO-8859-1 encodes the HTTP Available in: Lightning
request in Latin-1 before sending it to the server. Experience
The response body is encoded by the character set in the operation’s resolved response schema Available in: Enterprise,
directive. For example, application/x-www-form-urlencoded; Performance, Unlimited,
charset=SHIFT_JIS decodes the percent URL encoded form with the Shift JIS character set. and Developer Editions
The default character set for encoding request bodies is UTF-8.
The default character set for decoding server response entities is defined by the server response’s Content-Type header. If the Content-Type
header is missing from the response, then it uses UTF-8.
Reserved HTTP request header characters aren’t escaped and are encoded by the request body’s character set.
The supported encoding set is as defined by the Java JDK. For example, for version 11, supported encoding is documented here (replace
the “11” in this URL with your Java SE Platform version number): https://docs.oracle.com/en/java/javase/11/intl/supported-encodings.html
- and it’s recommended to use the standard character set encoding name as described by the IANA Charset Registry.

SEE ALSO:
Schema Examples

772
Extend Salesforce with Clicks, Not Code External Services

Media Type Directives and Mapping

Learn about OpenApi 2.0 consumes/produces or OpenAPI 3.0 content media type schema
EDITIONS
directives.
Unsupported schema directives invalidate the API spec registration. Available in: Lightning
Experience
Schema directives incompatible with a request body or response entity schema cause errors during
callout. Available in: Enterprise,
You can register specifications with nonsupported or incompatible consumes, produces, or Performance, Unlimited,
and Developer Editions
OpenAPI 3.0 content media type directives by mapping the media types to supported media types.
For more information about media type mapping, see What is Media Type Mapping?.
Missing schema directives are defaulted to:
• application/json—if the request body or the response body schema is either an object or an array
• text/plain—if the request or response schema body is a primitive type such as a string or an integer number
If no request body parameter is defined for methods POST, PUT, and PATCH, form data request parameters are sent in the request body
as application/x-www-form-urlencoded.
The applicable media type in the OpenAPI 2.0 produces list, OpenAPI 3.0 response schema media types, or a default
(application/json or text/plain), is set as the HTTP Accept header.

What is Media Type Mapping?

You can map each nonsupported, custom media type instance (defined in your API spec) to a supported media type of the same format.
Supported media types are:
• application/json -- Structured data in JSON format.
• text/plain -- Unstructured data as plain text.
• application/x-www-form-urlencoded -- URL encoded form.
For example, if your spec includes a customized media type application/abc.api+json and the formatting adheres to
standard JSON formatting, then map this custom media type to application/json.
You can perform this mapping by either Mapping Media Types During Registration (the declarative, easy way) or, by Mapping Media
Types with Metadata API (which involves manual coding).
Custom media types with a supported media type suffix are recognized as one of the compatible supported media types. For example,
a custom or vendor media type application/vnd.api+json with media type suffix json is recognized as application/json.
Supported media type suffixes:
• json — Structured data in JSON format.
For information about OpenApi 2.0 consumes/produces or OpenAPI 3.0 content media type schema directives, see Schema
Definition Support.

773
Extend Salesforce with Clicks, Not Code External Services

Naming and Description Conventions

Learn about support for component names and descriptions defined in your schema
EDITIONS
The operation name is derived from the schema's path operationId. If missing, it's derived
from the HTTP method and resource path. Available in: Lightning
Experience
Implement case consistently for object name definitions, property names, parameter names, and
field names in a schema. Available in: Enterprise,
The derived Apex class name and Apex object property names require valid Apex identifier characters. Performance, Unlimited,
Ensure that the object name in the schema object definition section matches the naming convention and Developer Editions
and the object property names.
External Services can handle up to 1,333 characters for any optional description string used to describe operations and parameters in
your JSON schema definition. If the description string exceeds this limit, External Services stores only the first 1,333 characters of the
description. Truncating the operation or parameter description doesn’t affect the integrity of your schema definition.

SEE ALSO:
Schema Examples
Apex Class Names and Developer Names

Operation Output Parameters

Learn about how External Services interprets an operation's output parameters.
EDITIONS
Every operation captures the HTTP response code with an output parameter responseCode.
The value of responseCode reflects the HTTP response code after the external call completes. Available in: Lightning
Experience
If the operation’s response parameter (OpenAPI) is defined under an HTTP response code value or
is defined as default, then the operation output parameter name is the HTTP response code Available in: Enterprise,
value or default. For an output parameter object type, its name contains the HTTP response Performance, Unlimited,
code value. and Developer Editions
For all operations where the HTTP response codes aren't defined in the OpenAPI specification, the
default output parameter with name default and of type String returns the external call's
response as a string.

SEE ALSO:
Schema Examples

properties and additionalProperties

In an OpenAPI specification, the named properties are accessible as Apex properties with matching
EDITIONS
property type. additionalProperties allow for free form map or dictionary properties with a common
property value type that are accessible in Apex as a Map property. Available in: Lightning
properties and additionalProperties under an OpenAPI schema directive show as formal Experience
object properties and as a dictionary property. If declared under a property or additionalProperties
Available in: Enterprise,
type, then the OpenAPI parser ignores one or the other. The registration process doesn't throw an Performance, Unlimited,
error. and Developer Editions
OpenAPI named properties are properties in Apex with the same name and property type.

774
Extend Salesforce with Clicks, Not Code External Services

OpenAPI additionalProperties are grouped as the Apex property with name properties and type Map<String, Type>, where
Type is the declared additionalProperties type.
OpenAPI additionalProperties are always declared as an Apex object map property, even if it could be declared as a standalone
Apex Map type. The result is consistently handled named object properties defined together with additionalProperties.
OpenAPI properties and additionalProperties can both be declared under an OpenAPI parameter schema or schema
in the definitions section. The OpenAPI parser ignores either properties or additionalProperties if declared as an object
property type. An object property type must only define named properties or additionalProperties, but not both. To
work around, place the object property definition as a named schema under definitions and reference it by name.
The OpenAPI parser doesn't differentiate between literal declarations or untyped schemas. Declarations like
additionalProperties: true, additionalProperties: false, or additionalProperties: {} are
interpreted as untyped. Untyped additionalProperties are ignored. There isn't a workaround to define
additionalProperties that can be of any type.
Flow doesn't allow access or manipulation of Apex object types with Map properties, but transparently preserves the content when
assigned to variables of the same Apex object type. To manipulate map data structure in flow, call an Apex invocable action that can
access the map data structure. For an example with External Service maps in action, see Example 9 in External Services OpenAPI 2.0
Schema.

Apex Class Names and Developer Names

Learn how External Services derives Apex class names from your schema.
EDITIONS
The derived Apex class name for a registered API specification schema object can be a maximum
of 255 characters. Ensure that class names are the correct length. To create a shorter name if errors Available in: Lightning
are encountered during registration, choose a short service name, or edit the schema object name Experience
definition.
Available in: Enterprise,
The operation developer name is derived from the registered API specification. The object developer Performance, Unlimited,
name is derived from the Apex class name. The developer name must fit within a maximum of 80 and Developer Editions
characters. If the name is larger than 80 characters, a unique developer name is automatically derived
to fit within 80 characters. If the individual derived object or operation unique developer names in
the nested data structure don't themselves exceed 80 characters, then the nested data structure name can go up to 255 characters. If
name collision errors are encountered for existing registrations, for example, to activate additional operations, try these steps:
• If the registration has been distributed in a managed package or is in use by flows, save a new copy of the registration.
• If the registration isn’t in use, either delete and recreate the registration or make a copy, delete the original registration, and save the
copy as the original registration.

SEE ALSO:
Schema Examples
Invoke External Service Callouts Using Apex

775
Extend Salesforce with Clicks, Not Code External Services

Apex Reserved Keywords

Learn about External Service's support for Apex reserved keywords.
EDITIONS
Although not a best practice, External Services doesn’t prohibit schema entities with the same name
as the Apex reserved keywords. If your schema name conflicts with an Apex reserved keyword, Available in: Lightning
External Services creates a unique name by encoding it to be compatible with Apex identifier rules. Experience
For example, you have an account object with property name type. Because the property name Available in: Enterprise,
type conflicts with the Apex reserved keyword type, External Services encodes the property Performance, Unlimited,
name type as z0type to make it Apex compliant. During callout, the property name type and Developer Editions
is used according to the original OpenAPI schema.
Special characters that aren’t valid Apex identifiers are UTF-8 encoded. For example,
5getOpen-bankingV2.2Atms

is encoded as
x35getOpenx2dbankingV2x2e2Atms

for a valid Apex identifier.

Although the character underscore “_” is a valid Apex identifier character, it’s UTF-8 encoded and is used for separating parts
lexicographically defined in an External Services spec. For example,
fixed_array_of_AutoContext

includes the special character underscore “_”. The character underscore is used as a parts separator for External Services hierarchical
object names. In this example, the character underscore is encoded as
fixedx5farrayx5fofx5fAutoContext

for a valid Apex identifier. You don’t need to change the name in the schema, as External Services runtime translates this back to the
character underscore when calling the service.

SEE ALSO:
Schema Examples
Invoke External Service Callouts Using Apex

Null Values
Learn null values are interpreted by External Services.
EDITIONS
OpenAPI 2.0 doesn’t support the JSON schema type null. See JSON Schema - 4.2.1 Instance Data
Model. Available in: Lightning
Experience
OpenAPI 3.0 has added support to allow values to be nullable. See OpenAPI 3 - Schema Object.
External services allow null values in the request payload or the response payload for both OpenAPI Available in: Enterprise,
2.0 and 3.0 specifications regardless of whether the specification forbids or explicitly allows its use. Performance, Unlimited,
and Developer Editions
Tip: If null values aren’t allowed for your service integration, validate the request payload for
null values before invoking an external service.

776
Extend Salesforce with Clicks, Not Code External Services

Callout and Usage Considerations

Best practices for callouts to and from External Services.
EDITIONS
• External service callouts aren’t allowed when there are pending, uncommitted transactions.
Available in: Lightning
– In Flow, close your transaction, and resume Flow using the flow element Pause.
Experience
– In Apex, perform the callout before any DML statement such as inserting, updating, or
deleting objects. See Callout Limits and Limitations in Apex Developer Guide. Available in: Enterprise,
Performance, Unlimited,
• Callouts to External Services timeout after 120 seconds. and Developer Editions

Schema Update Support

You can register an updated schema version for one currently in use in flow or Apex that includes supported components. This section
provides details about whether changes are supported.

Supported
Adding:
• Actions / Operations
• Objects
• Properties
• Parameters
Deleting:
• Actions: inactive, or unused active operations
• Parameters: required parameters from operations not in use
• Parameters: optional parameters from operations in use or not in use
• Properties: required properties from objects not in use
• Properties: optional properties from objects in use or not in use
Deleted parameters or properties used in flow or Apex can lead to flow errors. Inspect your flow or Apex class for any errors due to type
changes.
Changing:
• The description or example, which doesn't affect the name
• Changing the casing of an operation, parameter, object or property name
To edit a registration, or to update a schema with a new version, see Manage External Services.

Not Supported
Deleting or omitting:
• Active actions / Operations in use by flow or Apex
• Required parameters from operations in use
• Required properties from objects in use
Changing:
• A name change is considered deleting the element with that name and adding the element with the new name.
• A required property or required parameter type change is only allowed if it's not in use.

777
Extend Salesforce with Clicks, Not Code External Services

• An optional property or optional parameter type change is allowed. Errors can result if used in flow or Apex. Inspect your flow or
Apex class for any errors due to type changes.

Register an External Service

Provide an API spec that describes your endpoint's services and methods. The API spec’s schema
EDITIONS
generates the external service operations with corresponding input and output parameters. You
can also edit an exisiting registration, register an external service with a Mulesoft API, or register an Available in: Lightning
external service using Flow Bulder's HTTP Callout functionality. Experience

Available in: Enterprise,

Define an External Credential and a Named Credential Performance, Unlimited,
First, create an external credential to specify an authentication protocol and permission set or and Developer Editions
profile to use when authenticating to an external system. Second, in order for External Services
to authenticate, create a named credential and specify it as the callout endpoint.
Register an External Service
Registering an external service takes only a few steps and no code.
Register a MuleSoft API Service
To import your MuleSoft APIs with a few clicks with External Services, connect Salesforce to MuleSoft Anypoint Platform. We
recommend using the MuleSoft Services page in Setup, which creates the credentials and permissions required for the connection
in the background. Alternatively, you can configure a MuleSoft connected app and create a set of named credentials yourself. After
you establish the connection, register each API as an external service. To use External Services for MuleSoft, you need a valid MuleSoft
license or demo account.
Register an HTTP Callout Action in a Flow
Automatically register an external service by declaratively defining an HTTP Callout action in Flow Builder.
Manage External Services
Find services that you already registered, view actions for a service, edit, clone, and delete a service. You can update a registered
schema version currently in use in flow or Apex, if the update includes supported components.
Media Type Mapping in External Service Registrations
You can register specifications with nonsupported consumes, produces, or OpenAPI 3.0 content media type directives by
mapping the media types to supported media types. Specify a mapping from a dropdown menu on the registration screen, or
provide the mapping with code by using Metadata API.
Define a Charset in the Schema
To specify a charset for external callouts, populate the Content-Type header. A charset can be set if specifically defined
in the schema.

778
Extend Salesforce with Clicks, Not Code External Services

Define an External Credential and a Named Credential

First, create an external credential to specify an authentication protocol and permission set or profile
EDITIONS
to use when authenticating to an external system. Second, in order for External Services to
authenticate, create a named credential and specify it as the callout endpoint. Available in: both Salesforce
Important: In Winter ’23, Salesforce introduced an improved named credential that is Classic (not available in all
orgs) and Lightning
extensible and customizable. We strongly recommend that you use this preferred credential
Experience
instead of legacy named credentials. For information on extensible, customizable named
credentials, see Named Credentials and External Credentials. Legacy named credentials are Available in: All Editions
deprecated and will be discontinued in a future release.
Before you begin USER PERMISSIONS
Ensure that you have the OpenAPI endpoint information for the service that you’re registering. You
To view named credentials:
use the endpoint information to set up a named credential. A named credential is the method
• View Setup and
External Services uses for authentication. A named credential specifies the URL of a callout endpoint
Configuration
(the service you want to access) and its authentication parameters. For example,
https://my_endpoint.example.com. To create, edit, or delete
named credentials:
If you use OpenAPI 2.0, your endpoint is relative to the base URL. So if your named credential URL • Customize Applications
is https://my_endpoint.example.com and the basePath is /basepath, they combine
as the final endpoint of https://my_endpoint.example.com/basepath.
If you use OpenAPI 3.0, the named credential URL is composed of the spec’s server URL’s root path. The server’s URL relative path is
combined with the named credential’s endpoint. If your named credential URL is https://my_endpoint.example.com and
the server URL is https://my_endpoint.example.com/relative/path, then the server URL’s relative path
relative/path is combined with the named credentials endpoint https://my_endpoint.example.com. You can reuse
the same named credentials for external services with the same domain.
External Services supports all named credential authoring schemes.

Note: OpenAPI security schemes are ignored.

Set up an external credential and named credential

1. Create and Edit an External Credential. An external credential represents the details of how Salesforce authenticates to an external
system via an authentication protocol. It also links to a user’s permission set. Before creating a named credential, create one or more
external credentials for it to link to.
2. Create and Edit a Named Credential. A named credential 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. Named
credentials connect to external credentials.
3. For additional information and configuration details such as per-user authorization, custom headers, and user External Credentials,
see Named Credentials and External Credentials.
Set up a named credential for the BankService examples in this document
If you’re creating a Named Credential to follow the BankService examples, use "legacy" Named Credentials. For these examples, there's
no need to set up an External Credential. When creating the Named Credential, select New Legacy from the dropdown menu next to
the New Named Credential button instead of clicking New Named Credential. Create the Name and enter the URL. Don't change any
of the other default settings. For more information, see Define a Legacy Named Credential.

779
Extend Salesforce with Clicks, Not Code External Services

Register an External Service

Registering an external service takes only a few steps and no code.
EDITIONS
You can upload your spec for registration in four different ways.
Available in: Lightning
Experience
Submit an API Spec With a Relative URL
Provide a relative URL to the spec. Available in: Enterprise,
Performance, Unlimited,
Submit an API Spec With an Absolute URL
and Developer Editions
Provide a full, absolute URL to the spec.
Paste the JSON-formatted Schema Into Your Browser
USER PERMISSIONS
Copy and paste the JSON-formatted schema into your browser.
Upload a Local File To manage connections:
Using your browser, drag and drop, or browse files to locate and upload the JSON file from your • Customize Application
computer.

SEE ALSO:
External Services
Named Credentials
Choose an Authentication Protocol
External Services OpenAPI 2.0 Schema
External Services OpenAPI 3.0 Schema
Using the Schema Examples

Submit an API Spec With a Relative URL

Provide a relative URL to the spec.
EDITIONS
To register an API spec using a relative URL:
Available in: Lightning
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
Experience
and select External Services.
2. Click New External Service. Available in: Enterprise,
Performance, Unlimited,
3. On the Select an API Source page, select whether you’re importing an API spec From Mulesoft and Developer Editions
Anypoint Platform, or From API Specification. Since we're using our own spec in this
example, select From API Specification.
USER PERMISSIONS
4. Under External Service Name, enter a unique service name.
5. Under Description, enter an optional description. A good, short description can help distinguish To manage connections:
one service from another in a long list of services. • Customize Application

6. Click under Named Credentials and select a named credential from the list.
7. Under Service Schema, select Relative URL.
8. Enter a relative URL path to the schema (endpoint) under URL. It must begin with “/” and be a relative path. For example,
/accountSchema.json

780
Extend Salesforce with Clicks, Not Code External Services

9. If one or more errors are found during the validation process, a message (or series of messages) gives specific details about the error.
You make corrections to the schema by editing it directly in the text editor and clicking Validate to revalidate you changes, or by
modifying an offline copy and re-registering it. There are two types of errors:
• Syntax or logical errors. Must be fixed to complete the registration process. To resolve an error, use the error message to discover
the type and location of the error. Make corrections, and click Validate. Syntax error messages provide line and column number
location.
• Syntax or logical warnings. It’s not necessary to fix warnings to complete a registration. But the respective schema components
are ignored by the External Services and aren’t registered. To fix warnings, use the guidance in the warning message, make
corrections, and click Validate.

10. Click Save & Next.

Note: If your schema includes non-supported media types, the system displays the Associate operations with supported
media types page. Select a valid mapping for each non-supported type, as described in Mapping Media Types During
Registration on page 796.

11. Select the operations you want to import into your external service registration. You can select up to 1250 operations per org, and
up to 1250 active objects per org. If you exceed either of these limits, divide the operations in your schema across separate registrations.
For information about limits, see Considerations on page 768. For information about “objects” in Open API schemas, see Basic Structure
(OpenAPI 2.0) and Basic Structure (OpenAPI 3.0)
12. Click Next.
13. Click Done.

Submit an API Spec With an Absolute URL

Provide a full, absolute URL to the spec.
EDITIONS
Important: Before you can use an absolute URL, you must add the URL to your Remote Sites
settings. Available in: Lightning
Experience
To register an API spec using an absolute URL:
Available in: Enterprise,
1. Make sure that the URL has been added to your Remote Sites settings.
Performance, Unlimited,
2. From Setup in Lightning Experience, enter External Services in the Quick Find box, and Developer Editions
and select External Services.
3. Click New External Service. USER PERMISSIONS
4. On the Select an API Source page, select whether you’re importing an API spec From Mulesoft
To manage connections:
Anypoint Platform, or From API Specification. Since we're using our own spec in this
• Customize Application
example, select From API Specification.
5. Under External Service Name, enter a unique service name.
6. Under Description, enter an optional description. A good, short description can help distinguish one service from another in a long
list of services.
7. Click under Named Credentials and select a named credential from the list.
8. Under Service Schema, select Absolute URL to upload and register your schema. The URL must point to a valid OpenAPI 2.0 or
3.0, and JSON-compliant schema.
9. Enter an absolute URL path to the schema under URL. For example,
https://my_endpoint.example.com/accountSchema.json. The absolute URL can point to a different domain
than the one specified in Named Credentials.

781
Extend Salesforce with Clicks, Not Code External Services

10. Press Enter on your keyboard, or click outside of the URL box. The system begins to validate the schema.
11. If one or more errors are found during the validation process, a message (or series of messages) gives specific details about the error.
You make corrections to the schema by editing it directly in the text editor and clicking Validate to revalidate you changes, or by
modifying an offline copy and re-registering it. There are two types of errors:
• Syntax or logical errors. Must be fixed to complete the registration process. To resolve an error, use the error message to discover
the type and location of the error. Make corrections, and click Validate. Syntax error messages provide line and column number
location.
• Syntax or logical warnings. It’s not necessary to fix warnings to complete a registration. But the respective schema components
are ignored by the External Services and aren’t registered. To fix warnings, use the guidance in the warning message, make
corrections, and click Validate.

12. Click Save & Next.

Note: If your schema includes non-supported media types, the system displays the Associate operations with supported
media types page. Select a valid mapping for each non-supported type, as described in Mapping Media Types During
Registration on page 796.

13. Select the operations you want to import into your external service registration. You can select up to 1250 operations per org, and
up to 1250 active objects per org. If you exceed either of these limits, divide the operations in your schema across separate registrations.
For information about limits, see Considerations on page 768. For information about “objects” in Open API schemas, see Basic Structure
(OpenAPI 2.0) and Basic Structure (OpenAPI 3.0)
14. Click Next.
15. Click Done.

Paste the JSON-formatted Schema Into Your Browser

Copy and paste the JSON-formatted schema into your browser.
EDITIONS
To register an API spec by copying and pasting it's JSON-formatted schema into your browser:
Available in: Lightning
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
Experience
and select External Services.
2. Click New External Service. Available in: Enterprise,
Performance, Unlimited,
3. On the Select an API Source page, select whether you’re importing an API spec From Mulesoft and Developer Editions
Anypoint Platform, or From API Specification. Since we're using our own spec in this
example, select From API Specification.
USER PERMISSIONS
4. Under External Service Name, enter a unique service name.
5. Under Description, enter an optional description. A good, short description can help distinguish To manage connections:
one service from another in a long list of services. • Customize Application

6. Click under Named Credentials and select a named credential from the list.
7. Under Service Schema, select Complete JSON. Provide a complete, valid OpenAPI 2.0 or 3.0, and JSON-compliant schema.
8. Paste your JSON-formatted schema into the provided text field.
9. Click Save & Next. Your uploaded schema is validated by External Services.

Note: If your schema includes non-supported media types, the system displays the Associate operations with supported
media types page. Select a valid mapping for each non-supported type, as described in Mapping Media Types During
Registration on page 796.

782
Extend Salesforce with Clicks, Not Code External Services

10. If one or more errors are found during the validation process, a message (or series of messages) gives specific details about the error.
You make corrections to the schema by editing it directly in the text editor and clicking Validate to revalidate you changes, or by
modifying an offline copy and re-registering it. There are two types of errors:
• Syntax or logical errors. Must be fixed to complete the registration process. To resolve an error, use the error message to discover
the type and location of the error. Make corrections, and click Validate. Syntax error messages provide line and column number
location.
• Syntax or logical warnings. It’s not necessary to fix warnings to complete a registration. But the respective schema components
are ignored by the External Services and aren’t registered. To fix warnings, use the guidance in the warning message, make
corrections, and click Validate.

11. Select the operations you want to import into your external service registration. You can select up to 1250 operations per org, and
up to 1250 active objects per org. If you exceed either of these limits, divide the operations in your schema across separate registrations.
For information about limits, see Considerations on page 768. For information about “objects” in Open API schemas, see Basic Structure
(OpenAPI 2.0) and Basic Structure (OpenAPI 3.0)
12. Click Next.
13. Click Done.

Upload a Local File

Using your browser, drag and drop, or browse files to locate and upload the JSON file from your
EDITIONS
computer.
To upload a local file: Available in: Lightning
Experience
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
and select External Services. Available in: Enterprise,
2. Click New External Service. Performance, Unlimited,
and Developer Editions
3. On the Select an API Source page, select whether you’re importing an API spec From Mulesoft
Anypoint Platform, or From API Specification. Since we're using our own spec in this
example, select From API Specification. USER PERMISSIONS
4. Under External Service Name, enter a unique service name. To manage connections:
5. Under Description, enter an optional description. A good, short description can help distinguish • Customize Application
one service from another in a long list of services.
6. Under Service Schema, select Upload from local. Provide a complete, valid OpenAPI 2.0 or 3.0, and JSON-compliant schema.
7. Click under Named Credentials and select a named credential from the list.
8. Either click Upload and navigate to the JSON file on your local machine, or drag and drop the file within the dotted box.
9. If one or more errors are found during the validation process, a message (or series of messages) gives specific details about the error.
You make corrections to the schema by editing it directly in the text editor and clicking Validate to revalidate you changes, or by
modifying an offline copy and re-registering it. There are two types of errors:
• Syntax or logical errors. Must be fixed to complete the registration process. To resolve an error, use the error message to discover
the type and location of the error. Make corrections, and click Validate. Syntax error messages provide line and column number
location.
• Syntax or logical warnings. It’s not necessary to fix warnings to complete a registration. But the respective schema components
are ignored by the External Services and aren’t registered. To fix warnings, use the guidance in the warning message, make
corrections, and click Validate.

10. Click Save & Next.

783
Extend Salesforce with Clicks, Not Code External Services

Note: If your schema includes non-supported media types, the system displays the Associate operations with supported
media types page. Select a valid mapping for each non-supported type, as described in Mapping Media Types During
Registration on page 796.

11. Select the operations you want to import into your external service registration. You can select up to 1250 operations per org, and
up to 1250 active objects per org. If you exceed either of these limits, divide the operations in your schema across separate registrations.
For information about limits, see Considerations on page 768. For information about “objects” in Open API schemas, see Basic Structure
(OpenAPI 2.0) and Basic Structure (OpenAPI 3.0)
12. Click Next.
13. Click Done.

Register a MuleSoft API Service

To import your MuleSoft APIs with a few clicks with External Services, connect Salesforce to MuleSoft Anypoint Platform. We recommend
using the MuleSoft Services page in Setup, which creates the credentials and permissions required for the connection in the background.
Alternatively, you can configure a MuleSoft connected app and create a set of named credentials yourself. After you establish the
connection, register each API as an external service. To use External Services for MuleSoft, you need a valid MuleSoft license or demo
account.

Connect Salesforce to MuleSoft Anypoint Exchange from Setup

Use the MuleSoft Services page in Setup to log in to MuleSoft Anypoint Exchange before importing REST APIs from Anypoint Exchange
as external services. Salesforce creates a connected app in MuleSoft and all the necessary credentials and permissions required for
the connection.
Import REST APIs for MuleSoft Services from Setup
You can import REST APIs for MuleSoft Services to create an external service in Salesforce.
Manually Connect Salesforce to MuleSoft Anypoint
To connect Salesforce to MuleSoft Anypoint Platform, we recommend using the MuleSoft Services page in Setup. This topic
demonstrates an alternative, and more complex workflow, where you can create a connected app instead. Use this workflow only
if your integration requires the use of a connected app. This manual connection is required if your MuleSoft Anypoint Platform is
configured to use single sign-on (SSO). Perform these steps before following the steps in Connect Salesforce to MuleSoft Anypoint
Exchange from Setup.
(Optional) Create a Named Credential
Create a named credential to access your MuleSoft Anypoint Platform connected app from Salesforce.

Connect Salesforce to MuleSoft Anypoint Exchange from Setup

Use the MuleSoft Services page in Setup to log in to MuleSoft Anypoint Exchange before importing
EDITIONS
REST APIs from Anypoint Exchange as external services. Salesforce creates a connected app in
MuleSoft and all the necessary credentials and permissions required for the connection. Available in: Lightning
To use the MuleSoft Services wizard, you need a valid MuleSoft license or demo account. Experience
1. From Setup, in the Quick Find box, enter MuleSoft, and then select MuleSoft > Services. Available in: Enterprise,
2. In the Login Credentials area, click Log In. Performance, Unlimited,
The Log in to MuleSoft Anypoint Platform window appears. and Developer Editions

784
Extend Salesforce with Clicks, Not Code External Services

Note: Single Sign-On (SSO) isn’t currently supported. To log in, manually enter your MuleSoft credentials.

3. Select the environment where your MuleSoft Anypoint Platform control plane is hosted. Alternatively, to use a named credential
that you previously created with login credentials for Anypoint Platform, select User-Specified and the named credential you
created following the steps in Manually Connect Salesforce to MuleSoft Anypoint Exchange.
The control plane is part of the Anypoint Platform architecture that includes Anypoint Exchange. Where the control plane is hosted
determines the login URL. For example, if the control plane is hosted on the EU Cloud, the base URL for Anypoint Exchange is
https://eu1.anypoint.mulesoft.com.

4. If you selected US Cloud or EU Cloud, click Log In. If you selected User-Specified, click Done. The MuleSoft log-in page opens on a
new tab.

Note: The remaining steps only apply if you selected US Cloud or EU Cloud.

5. Enter your username and password for Anypoint Exchange, and then click Sign In.
The Authorize App page appears.

6. Click Grant Access.

External applications like Salesforce can access Anypoint Platform APIs through a feature called Connected Apps. By granting access
to the Salesforce Platform Integration app, you allow Salesforce to access the APIs without having to create a
connected app yourself.
The MuleSoft Services page displays a confirmation message.
Import MuleSoft Anypoint Exchange REST APIs.

Note: Named credentials that are created after signing into MuleSoft services automatically have external Apex callouts enabled.

SEE ALSO:
Knowledge Article: Unable to log in to MuleSoft Anypoint platform from Salesforce org

Import REST APIs for MuleSoft Services from Setup

You can import REST APIs for MuleSoft Services to create an external service in Salesforce.
EDITIONS
To use the MuleSoft Services, you need a valid MuleSoft license or demo account.
Available in: Lightning
1. From Setup, in the Quick Find box, enter MuleSoft, and then select MuleSoft > Services.
Experience
2. In the Login Credentials area, click Log In.
Available in: Enterprise,
Note: To use the MuleSoft Services page in Setup to log in to MuleSoft AnyPoint Exchange Performance, Unlimited,
before importing REST APIs from Anypoint Exchange as external services, see Connect and Developer Editions
Salesforce to MuleSoft Anypoint Exchange from Setup.

785
Extend Salesforce with Clicks, Not Code External Services

3. In the Imported MuleSoft Services area, click Import to browse and import REST APIs for MuleSoft Services that are published to
Anypoint Exchange.
4. In the Import Service window select Operations to import and click Next.
5. Set your service details.
a. Enter a name for your external service. The name must start with a letter, can’t contain spaces or special characters, and be no
longer than 80 characters.
b. (Optional) Enter a description of your external service. If you don’t enter a description, the system-generated description is used.
c. Select a named credential to use to run the external service.

Note: MuleSoft services use this credential to run a MuleSoft API operation when the external service is called from a
flow. Select a named credential with access to run the API.

6. Click Save & Next.

Note: Clicking Save & Next creates an external service record in Salesforce. After this step, you can’t change the MuleSoft
API name or version associated with the external service. You can only change the description, named credential, and included
MuleSoft REST API operations.

7. In the Select Operations to Import window, select operations to include in your MuleSoft service.

Note: For limits, including the maximum number of operations allowed in your org, see External Services Considerations.

8. Click Finish.
Use your MuleSoft service in a flow.

Manually Connect Salesforce to MuleSoft Anypoint

To connect Salesforce to MuleSoft Anypoint Platform, we recommend using the MuleSoft Services page in Setup. This topic demonstrates
an alternative, and more complex workflow, where you can create a connected app instead. Use this workflow only if your integration
requires the use of a connected app. This manual connection is required if your MuleSoft Anypoint Platform is configured to use single
sign-on (SSO). Perform these steps before following the steps in Connect Salesforce to MuleSoft Anypoint Exchange from Setup.

Create a Connected App in MuleSoft Anypoint Platform

Set up a connected app in MuleSoft Anypoint Platform that allows Salesforce to call MuleSoft APIs.
Create an Authentication Provider
Use the ID and the secret from your MuleSoft Anypoint Platform connected app to create an authentication provider.
Update Your MuleSoft Anypoint Platform Connected App
Use the Salesforce authentication provider callback URL to update your MuleSoft Anypoint Platform connected app.

Create a Connected App in MuleSoft Anypoint Platform

Set up a connected app in MuleSoft Anypoint Platform that allows Salesforce to call MuleSoft APIs.
To use the External Services for MuleSoft wizard, you need a valid MuleSoft license or demo account.
The MuleSoft user account must have full permissions for the API Manager and Exchange in your MuleSoft Anypoint Platform org.
Complete these steps in MuleSoft Anypoint Platform.
1. Log in to MuleSoft Anypoint Platform.

786
Extend Salesforce with Clicks, Not Code External Services

2. Under Management Center, click Access Management.

3. In the Access Management menu, select Connected Apps.
4. Click Create app.
5. Enter a name for your app.
6. Ensure that App acts on behalf of a user is selected for Type.
7. Under Grant types, select Authorization Code, and then select Refresh Token.
8. In Website URL, enter https://www.salesforce.com.
9. In Redirect URIs, enter https://www.salesforce.com, and click Add.

Note: This redirect URI is a temporary value that is updated after you create an authentication provider in your Salesforce org.

10. For Who can use this application? select Members of this organization only.
11. Under Scopes, click Add Scopes.
12. In Add scopes, enable Background Access and Read-Only Access, and click Add scopes.
13. Save your changes.
14. On the Connected Apps page, click Copy Id, and paste the id into a text file.
15. Click Copy Secret, and paste it into the same text file.
Create an authentication provider.

Create an Authentication Provider

Use the ID and the secret from your MuleSoft Anypoint Platform connected app to create an
EDITIONS
authentication provider.
To use External Services for MuleSoft, you need a valid MuleSoft license or demo account. Available in: Lightning
Experience
This setup requires the ID and secret that can be copied when you created your connected app in
MuleSoft Anypoint Platform. Available in: Enterprise,
Complete these steps. Performance, Unlimited,
and Developer Editions
1. From Setup, in the Quick Find box, enter Auth. Providers, and then select Auth.
Providers.
2. Click New.
3. For Provider Type, select Open ID Connect.
4. Specify a name like MuleSoft Anypoint Platform.
5. For Consumer Key, enter the ID that you copied when you created your connected app in MuleSoft Anypoint Platform.
6. For Consumer Secret, enter the secret that you copied when you created your connected app in MuleSoft Anypoint Platform.
7. For Authorize Endpoint URL, enter https://anypoint.mulesoft.com/accounts/api/v2/oauth2/authorize.
8. For Token Endpoint URL, enter https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token.
9. Save your changes.
10. On the Auth. Provider Detail page, under Salesforce Configuration, copy the Callback URL.
Update the connected app in MuleSoft Anypoint Platform.

787
Extend Salesforce with Clicks, Not Code External Services

Update Your MuleSoft Anypoint Platform Connected App

Use the Salesforce authentication provider callback URL to update your MuleSoft Anypoint Platform connected app.
To use External Services for MuleSoft, you need a valid MuleSoft license or demo account.
This setup requires the callback URL that can be copied when you created your authentication provider in Salesforce.
Complete these steps in MuleSoft Anypoint Platform.
1. In Access Management, on the Connected Apps page, click the name of the connected app you created in MuleSoft Anypoint
Platform.
2. On the Update App page, in Redirect URIs, enter the callback URL that you copied when you created an authentication provider in
Salesforce, and click Add.
3. Delete the Redirect URI for https://www.salesforce.com.
4. Save your changes.
Create a named credential.

(Optional) Create a Named Credential

Create a named credential to access your MuleSoft Anypoint Platform connected app from Salesforce.
EDITIONS
To use the External Services for MuleSoft wizard, you need a valid MuleSoft license or demo account.
Available in: Lightning
1. From Setup, in the Quick Find box, enter Named Credentials, and then select Named
Experience
Credentials.
2. From the dropdown menu next to the New button, select New Legacy. Available in: Enterprise,
Performance, Unlimited,
3. Enter a label for your named credential. The label can contain no spaces or special characters. and Developer Editions
4. (Optional) Enter a name for your named credentials, or use the name that the system generated
based on the label you entered.
5. For URL, enter https://anypoint.mulesoft.com.
6. Select an Identity Type.
a. To require that each Salesforce user log into MuleSoft Anypoint Platform from within their personal settings to get a token for
their own use, select Per User. Perform additional steps described in Store Authentication Settings for External Systems as
needed.
b. To allow one named credential to be shared by all users in your org, select Named Principal.

7. For Authentication Protocol, select OAuth 2.0.

8. Select an Authentications Provider. For Authentication Provider, click the magnifying glass and select the name of the auth provider
that you created.
9. For Scope, enter read:full offline_access.
10. Ensure that Start Authentication Flow on Save is enabled.
11. Save your changes.

Note: If you receive the “No_Oauth_State: State wasn’t sent back” error when saving the named credential, ensure that the
selected scopes for your MuleSoft Anypoint Platform connected app are Read-Only Access and Background Access. You can
also receive the error if the read:full offline_access scope you specified has a period at the end of it.

12. (Optional) If you’re not already logged into MuleSoft Anypoint platform, log in now.

788
Extend Salesforce with Clicks, Not Code External Services

13. Grant read-only access and background access to your Salesforce user.
14. On the Named Credential Setup page, Authentication Status is now set to Authenticated.
Import MuleSoft Anypoint Platform APIs.

Register an HTTP Callout Action in a Flow

Automatically register an external service by declaratively defining an HTTP Callout action in Flow
EDITIONS
Builder.
After you configure the HTTP callout action in a flow, Flow Builder auto-generates an external service Available in: Lightning
registration, an invocable action, and Apex-defined types. You can then use the data output of the Experience
API request as input within Flow Builder and across Salesforce.
Available in: Enterprise,
Performance, Unlimited,
SEE ALSO: and Developer Editions
HTTP Callout

Manage External Services

Find services that you already registered, view actions for a service, edit, clone, and delete a service.
EDITIONS
You can update a registered schema version currently in use in flow or Apex, if the update includes
supported components. Available in: Lightning
Experience
Locate an External Service
Available in: Enterprise,
See a list of your registered external services. Performance, Unlimited,
Edit an External Service and Developer Editions
Edit an external service's named credentials, description, schema, and included operations.
Edit an External Service Created by HTTP Callout
You can edit an external service's registration details, or use the declarative editor to change the operation's configuration.
Recreate an External Service (Save As)
Clone your external service under a new name, and update the related flows.
Delete an External Service
Delete an external service permanatently.
View Actions
View actions available for an external service.
View an Action’s Unique Apex Name
Use this example to understand how External Services actions in Apex or Flow map to specific actions in an External Service registration.
An object’s unique Apex class name is specified in View Actions > More Details. This name also appears when searching for actions
in Flow Builder.
Track Usage and Limits
When you first enter External Services from Setup, five visual (flat) gauges at the top of the page show your current usage and
maximum values for each per org limit.

789
Extend Salesforce with Clicks, Not Code External Services

Locate an External Service

See a list of your registered external services.
EDITIONS
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
and select External Services. Available in: Lightning
Experience
All of your registered external services are listed.
Available in: Enterprise,
Performance, Unlimited,
and Developer Editions

Edit an External Service

Edit an external service's named credentials, description, schema, and included operations.
EDITIONS
You can register a new version of an API specification over an existing registration. This update
works only if operations and schema objects in use by flows or referenced by Apex classes aren’t Available in: Lightning
removed in the new specification. Remove the unused operations and schema objects before Experience
updating to the new API specification version.
Available in: Enterprise,
When updating a schema that has operations/objects in use by a flow, non-structural changes, Performance, Unlimited,
such as updating a description are allowed. However, it's possible that structural changes, such as and Developer Editions
updating an object's properties or parameters, don't register.

Tip: If the new schema version isn’t compatible, the edit workflow notifies you which
operations and schema objects are in use by which flows and by which Apex classes. With
this information, you know which existing references are incompatible so that you can remove
them before saving your updated registration.
For details about supported and non supported changes, see Schema Update Support.
1. From Setup, in the Quick Find box, enter External Services and select External Services.
2. Click the arrow in the service’s Actions column, and then select Edit. You can modify these service settings.
• Named Credential
• Description
• Service Schema (URL or JSON)
• Operations

3. Optionally update the schema with a new version by submitting a new schema, or by using the inline text editor to make changes.
4. Use the instructions in Register an External Service to submit an updated schema, validate, and select operations for your edited
external service.

Edit an External Service Created by HTTP Callout

You can edit an external service's registration details, or use the declarative editor to change the
EDITIONS
operation's configuration.
Available in: Lightning
Edit the Schema or Named Credential Experience
To edit the details of an external service created by HTTP Callout, you can edit the schema Available in: Enterprise,
directly, change the Description, or change the Named Credential. Performance, Unlimited,
and Developer Editions

790
Extend Salesforce with Clicks, Not Code External Services

Edit an Operation Declaratively

To edit an external service's operation created by HTTP Callout, you can use the same declarative tools you used to create the HTTP
Callout in Flow Builder.

Edit the Schema or Named Credential

To edit the details of an external service created by HTTP Callout, you can edit the schema directly,
EDITIONS
change the Description, or change the Named Credential.
1. From Setup in Lightning Experience, enter External Services in the Quick Find box, Available in: Lightning
and select External Services. Experience
2. Click the name of the external service that you want to edit. Available in: Enterprise,
3. Click the Edit button. Performance, Unlimited,
and Developer Editions
4. Optionally, change the Description, or change the Named Credential under Select a Named
Credential.
When you save your changes, the Creation source shown on the external service's detail page remains HTTP Callout in Flow
Builder, and therefore, can be edited again using the declarative tools.

5. Optionally, use the JSON schema editor to edit the schema.

If you change the schema and save it, the Creation source changes to From API specification. This external service's operation
can no longer be edited using declarative tools, but is edited like any other external service.

6. Click Save & Next.

7. Select the operation(s) to include in this registration.
8. Click Next.
9. Review your edited action, and click Finish.

Edit an Operation Declaratively

To edit an external service's operation created by HTTP Callout, you can use the same declarative
EDITIONS
tools you used to create the HTTP Callout in Flow Builder.
1. From Setup in Lightning Experience, enter External Services in the Quick Find box, Available in: Lightning
and select External Services. Experience
2. Click the name of the external service that you want to edit. Available in: Enterprise,
3. Locate the operation you want to edit. In the right-most column, pull down the arrow and Performance, Unlimited,
select Edit HTTP Callout Action. and Developer Editions

4. To edit your invocable action, configure the declarative settings in the Edit HTTP Callout
window. For more details about using the declarative editor, see steps five through the end of the section in Configure an HTTP
Callout Action.
5. Click Save.

791
Extend Salesforce with Clicks, Not Code External Services

Recreate an External Service (Save As)

Clone your external service under a new name, and update the related flows.
EDITIONS
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
and select External Services. Available in: Lightning
Experience
2. Under Actions, next to the name of the external service that you want to recreate, click Save
As. Available in: Enterprise,
3. Performance, Unlimited,
Note: External Services fills in most of the necessary information, including a modified
and Developer Editions
external service’s name, named credential used, description, and schema URL or JSON.
Modify the external service name so that it’s different from the original registration. If you don’t
USER PERMISSIONS
provide a name, External Services automatically adds the prefix CopyOf in front of the existing
external service name. To manage connections:
4. Verify or change the named credential used, description, schema URL, or JSON. • Customize Application

5. Click Save & Next.

6. If needed, modify the selected operations.
7. Click Next.
8. Click Done.
9. Update the flows that use the actions from the original external service. To locate actions for External Services registrations, filter the
actions by type, and select External Service. To find actions that aren’t from External Services registrations, filter by type, and select
Apex Action.
10. Return to External Services in Setup.
11. Under Actions, for the original external service that you recreated, click Delete.

SEE ALSO:
Register an External Service

Delete an External Service

Delete an external service permanatently.
EDITIONS
To delete an external service, click the arrow in the service’s Actions column, and select Delete.
Available in: Lightning
Experience

Available in: Enterprise,

Performance, Unlimited,
and Developer Editions

792
Extend Salesforce with Clicks, Not Code External Services

View Actions
View actions available for an external service.
EDITIONS
1. From Setup in Lightning Experience, enter External Services in the Quick Find box,
and select External Services. Available in: Lightning
Experience
2. Click the arrow in the external service’s Actions column, and select View Actions.
A list of registered actions for the external service is displayed. Available in: Enterprise,
Performance, Unlimited,
and Developer Editions

View an Action’s Unique Apex Name

Use this example to understand how External Services actions in Apex or Flow map to specific
EDITIONS
actions in an External Service registration. An object’s unique Apex class name is specified in View
Actions > More Details. This name also appears when searching for actions in Flow Builder. Available in: Lightning
For example, if your API spec defines a response accountDetails for a getAccount Experience
operation, referenced in the spec as
Available in: Enterprise,
Performance, Unlimited,
and Developer Editions

"paths": {
"/accounts/{accountName}": {
"get": {
"operationId": "getAccount",
"summary": "Retrieves an account",
"description": "Retrieves the account with specific name",
"consumes": [
"text/plain"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"type": "string",
"description": "Name of the account"
}
],
"responses": {
"200": {
"description": "The response when system finds an account with
given name",
"schema": {
"$ref": "#/definitions/accountDetails"
}

793
Extend Salesforce with Clicks, Not Code External Services

Where the definition for accountDetails is defined at the end of the spec as
"definitions": {
"accountDetails": {
"required": [
"id",
"name",
"type",
"availableBal"
],
"properties": {
"id": {
"type": "string",
"description": "id"
},
"name": {
"type": "string",
"description": "name"
},
"type": {
"type": "string",
"description": "type"
},
"availableBal": {
"type": "string",
"description": "availableBal"
}
}
},

When the spec is registered in External Services, you can see the Apex Class name during registration.

794
Extend Salesforce with Clicks, Not Code External Services

Or you can navigate to the action in External Services and then click View Actions > More Details.

External Services automatically registered our accountDetails object as BankService_accountDetails.

Now in Flow, when you add a resource for a new action, it’s clear that you’re selecting the correct action from the correct registration.

Track Usage and Limits

When you first enter External Services from Setup, five visual (flat) gauges at the top of the page
EDITIONS
show your current usage and maximum values for each per org limit.
• Total Registrations. Number of External Services registrations Available in: Lightning
• Active Operations. Number of operations selected for use across all registered specs Experience

• Total Operations. The sum of all active and inactive (not selected) operations across all Available in: Enterprise,
registered specs Performance, Unlimited,
and Developer Editions
• Active Objects. Number of objects in use across all active operations in registered specs
• Total Objects. The sum of objects in use across all active operations in registered specs, and
unused objects across all inactive operations in registered specs

Media Type Mapping in External Service Registrations

You can register specifications with nonsupported consumes, produces, or OpenAPI 3.0 content media type directives by mapping
the media types to supported media types. Specify a mapping from a dropdown menu on the registration screen, or provide the mapping
with code by using Metadata API.

795
Extend Salesforce with Clicks, Not Code External Services

Mapping Media Types During Registration

If you attempt to register a schema that includes a nonsupported media type, you’re asked to provide a mapping on the Associate
operations with supported media types page.

Note: The Associate operations with supported media types page isn’t shown during registration, unless there’s a nonsupported
media type specified in the schema.
To associate operations with a supported media type
1. Note the first nonsupported media type on the left.
2. Map the non supported media type to a supported media type by selecting a supported media type from the pull-down menu
directly to the right.
3. If there are additional nonsupported media types in the list, continue down the list and select a mapping for each nonsupported
media type listed.
4. Click Next.
Continue registration by selecting operations, as described in step #10 of Register an External Service on page 780.

Mapping Media Types with Metadata API

To manually map a media type, the nonsupported media type must be mapped to a supported media type as a mapping in the field
serviceBinding of the ExternalServiceRegistration metadata file.
To demonstrate the manual method of mapping media types, consider this Acme Bank example.
Acme bank specifies an OpenAPI 2.0 service for their credit rating service. It defines its own media type for handling the JSON compatible
payload: application/x-acme-json:
{
"swagger":"2.0",
"info":{
"description":"A service for checking credit for an account.",
"version":"1.0.0",
"title":"Credit Decision"
},
"host":"<ACME's host>",
"paths":{
"/account/credit-rating":{
"get":{
"operationId":"getCreditRating",
"summary":"Evaluates credit rating for offered payment terms.",
"consumes":[
"application/x-acme-json"
],
"produces":[
"application/x-acme-json"
],
"parameters":[{
"description":"Account",
"in":"body",
"name":"body",
"required":true,
"schema":{
"$ref":"#/definitions/Account"

796
Extend Salesforce with Clicks, Not Code External Services

}
}],
"responses":{
"200":{
"description": "Credit rating",
"schema":{
"$ref":"#/definitions/CreditRating"
}
}
}
}
}
},
"definitions":{
"Account":{
"type":"object",
"properties":{
"accountId":{
"type":"string"
},
"accountHolder":{
"type":"string"
}
}
},
"CreditRating":{
"type":"object",
"properties":{
"creditRating":{
"type":"string"
}
}
}
}
}

To map the BankService media type to the supported media type application/json, open a command-line terminal. Create a
directory in which to retrieve the external service’s metadata.
> mkdir BankService
> cd BankService

Create the manifest package.xml for the external service metadata for your BankService to retrieve from your organization:
> touch package.xml

Edit the package.xml:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>BankService</members>
<name>ExternalServiceRegistration</name>
</types>
<version>53.0</version>
</Package>

797
Extend Salesforce with Clicks, Not Code External Services

Retrieve the metadata for the external service with the Salesforce CLI command after successful authentication to your organization:
> sfdx force:mdapi:retrieve -r . -k package.xml

Unzip the package zip with the metadata and navigate to the directory with the external service:
> unzip unpackaged.zip
> cd unpackaged/externalServiceRegistrations

Edit service bindings in the external service registration metadata file BankService.externalServiceRegistration.
Don’t break the <serviceBinding> section (in bold) with line breaks as it breaks deserialization.
<?xml version="1.0" encoding="UTF-8"?>
<ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
<label>MediaTypeMap</label>
<namedCredential>BankServiceEndpoint</namedCredential>
<operations>
<active>true</active>
<name>getcreditrating</name>
</operations>
<registrationProviderType>Custom</registrationProviderType>
<schema>{
...
}
</schema>
<schemaType>OpenApi</schemaType>
<serviceBinding>{&quot;compatibleMediaTypes&quot;
:{&quot;application/x-acme-json&quot;
:&quot;application/x-acme-json&quot;}}</serviceBinding>
<status>Complete</status>
</ExternalServiceRegistration>

The service binding specifies in JSON format the nonsupported media types defined by this external service registration:
{"compatibleMediaTypes":{
"application/x-acme-json":"application/x-acme-json"
}}

Map the nonsupported media type to the supported media type for the external service payload serialization:
{"compatibleMediaTypes":{
"application/x-acme-json":"application/json"
}}

The updated metadata for the bank rating external service sample registration respects the media type mapping to the supported media
type when deployed in a package:
<?xml version="1.0" encoding="UTF-8"?>
<ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
<label>MediaTypeMap</label>
<namedCredential>BankService</namedCredential>
<operations>
<active>true</active>
<name>getcreditrating</name>
</operations>
<registrationProviderType>Custom</registrationProviderType>
<schema>{

798
Extend Salesforce with Clicks, Not Code External Services

...
}
</schema>
<schemaType>OpenApi</schemaType>
<serviceBinding>{&quot;compatibleMediaTypes&quot;
:{&quot;application/x-acme-json&quot;
:&quot;application/json&quot;}}</serviceBinding>
<status>Complete</status>
</ExternalServiceRegistration>

Don’t break the <serviceBinding> section with line breaks as it breaks deserialization.
Save the edited external service registration metadata file and deploy it:
> cd ../..
> sfdx force:mdapi:deploy -d unpackaged

For more information see

• ExternalServiceRegistration
• Salesforce DX Developer Guide

Define a Charset in the Schema

To specify a charset for external callouts, populate the Content-Type header. A charset
EDITIONS
can be set if specifically defined in the schema.
During an external callout, the Content-Type header is used to describe the media type (for Available in: Lightning
example, application/json, text/plain, etc.) of a resource that can be consumed by the operation. Experience
charset is an optional parameter of Content-Type that specifies the character encoding Available in: Enterprise,
of the media type. Performance, Unlimited,
and Developer Editions
Note: With the Spring ’23 release, charset in the Content-Type header is no longer
populated by default when making external callouts. Previously, Content-Type included
the charset=UTF-8 parameter by default.
As an example, we'll edit the BankService schema to set charset to UTF-8. As OpenAPI 2.0 and Open API 3.0 schema versions are
implemented differently, we'll use both versions.

Example: Define charset in an OpenAPI 2.0 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"
},
"securityDefinitions":{
"basicAuth":{
"type":"basic"
}
},
"security":[

799
Extend Salesforce with Clicks, Not Code External Services

{
"basicAuth":[

]
}
],
"tags":[
{
"name":"DemoBankRestServices"
}
],
"paths":{
"/accounts/{accountName}":{
"get":{
"operationId":"getAccount",
"summary":"Retrieves an account",
"description":"Retrieves the account with specific name",
"consumes":[
"text/plain; charset=UTF-8"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"accountName",
"in":"path",
"required":true,
"type":"string",
"description":"Name of the account"
}
],
"responses":{
"200":{
"description":"The response when system finds an account with
given name",
"schema":{
"$ref":"#/definitions/accountDetails"
}
},
"400":{
"description":"Error response if the account name parameter
is less than minimum characters",
"schema":{
"$ref":"#/definitions/errorModel"
}
},
"404":{
"description":"Error response if the account is not supported
by service or account is not found",
"schema":{
"$ref":"#/definitions/errorModel"
}
}

800
Extend Salesforce with Clicks, Not Code External Services

}
},
"delete":{
"operationId":"DeleteAccount",
"summary":"Deletes an account",
"description":"Deletes the account with specific name",
"consumes":[
"text/plain; charset=UTF-8"
],
"produces":[
"application/json"
],
"parameters":[
{
"name":"accountName",
"in":"path",
"required":true,
"type":"string",
"description":"Name of the account"
}
],
"responses":{
"204":{
"description":"The response when system finds an account with
given name",
"schema":{
"type":"string"
}
},
"400":{
"description":"Error response if the account name parameter
is less than minimum characters",
"schema":{
"$ref":"#/definitions/errorModel"
}
},
"404":{
"description":"Error response if the account is not supported
by service or account is not found",
"schema":{
"$ref":"#/definitions/errorModel"
}
}
}
},
"post":{
"operationId":"addAccount",
"summary":"Add an account",
"description":"Add an account to the database",
"consumes":[
"text/plain; charset=UTF-8"
],
"produces":[
"application/json"

801
Extend Salesforce with Clicks, Not Code External Services

],
"parameters":[
{
"name":"accountName",
"in":"path",
"required":true,
"type":"string",
"description":"Name of the account"
},
{
"name":"accountType",
"in":"query",
"required":true,
"type":"string",
"description":"The type of account"
}
],
"responses":{
"201":{
"description":"The response when the account does not already
exist and we can create one",
"schema":{
"$ref":"#/definitions/accountDetails"
}
},
"409":{
"description":"The response when the account already exists
and we cannot create one",
"schema":{
"$ref":"#/definitions/accountDetails"
}
},
"400":{
"description":"Error response if the account name parameter
is less than minimum characters",
"schema":{
"$ref":"#/definitions/errorModel"
}
},
"404":{
"description":"Error response if the account is not supported
by service or account is not found",
"schema":{
"$ref":"#/definitions/errorModel"
}
}
}
},
"put":{
"operationId":"updateAccount",
"summary":"Updates an account",
"description":"Updates the account with specified name",
"consumes":[
"text/plain; charset=UTF-8"

802
Extend Salesforce with Clicks, Not Code External Services

],
"produces":[
"application/json"
],
"parameters":[
{
"name":"accountName",
"in":"path",
"required":true,
"type":"string",
"description":"Name of the account"
},
{
"name":"accountType",
"in":"query",
"required":true,
"type":"string",
"description":"The type of account"
}
],
"responses":{
"200":{
"description":"The response when system finds an account with
given name",
"schema":{
"$ref":"#/definitions/accountDetails"
}
},
"400":{
"description":"Error response if the account name parameter
is less than minimum characters",
"schema":{
"$ref":"#/definitions/errorModel"
}
},
"404":{
"description":"Error response if the account is not supported
by service or account is not found",
"schema":{
"$ref":"#/definitions/errorModel"
}
}
}
}
}
},
"definitions":{
"accountDetails":{
"required":[
"id",
"name",
"type",
"availableBal"
],

803
Extend Salesforce with Clicks, Not Code External Services

"properties":{
"id":{
"type":"string",
"description":"id"
},
"name":{
"type":"string",
"description":"name"
},
"type":{
"type":"string",
"description":"type"
},
"availableBal":{
"type":"string",
"description":"availableBal"
}
}
},
"errorModel":{
"required":[
"errorCode",
"errorMessage"
],
"properties":{
"errorCode":{
"type":"string",
"description":"A service-specific error code."
},
"errorMessage":{
"type":"string",
"description":"A service-specific error code."
}
}
}
}
}

Example: Define charset in an OpenAPI 3.0 Schema

{
"openapi": "3.0.1",
"info": {
"title": "External Service for demo bank",
"description": "### External Service for demo bank",
"version": "1.0",
"x-vcap-service-name": "DemoBankRestServices"
},
"servers": [
{
"url": "/"
}
],
"security": [

804
Extend Salesforce with Clicks, Not Code External Services

{
"basicAuth": []
}
],
"tags": [
{
"name": "DemoBankRestServices"
}
],
"paths": {
"/accounts/{accountName}": {
"get": {
"summary": "Retrieves an account",
"description": "Retrieves the account with specific name",
"operationId": "getAccount",
"parameters": [
{
"name": "accountName",
"in": "path",
"description": "Name of the account",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The response when system finds an account with given name",

"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountDetails"
}
}
}
},
"400": {
"description": "Error response if the account name parameter is less than
minimum characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
},
"404": {
"description": "Error response if the account is not supported by service
or account is not found",
"content": {
"application/json": {

805
Extend Salesforce with Clicks, Not Code External Services

"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
}
}
},
"put": {
"summary": "Updates an account",
"description": "Updates the account with specified name",
"operationId": "updateAccount",
"parameters": [
{
"name": "accountName",
"in": "path",
"description": "Name of the account",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accountType",
"in": "query",
"description": "The type of account",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded; charset=UTF-8": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "The response when system finds an account with given name",

"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountDetails"
}
}
}
},
"400": {

806
Extend Salesforce with Clicks, Not Code External Services

"description": "Error response if the account name parameter is less than

minimum characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
},
"404": {
"description": "Error response if the account is not supported by service
or account is not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
}
}
},
"post": {
"summary": "Add an account",
"description": "Add an account to the database",
"operationId": "addAccount",
"parameters": [
{
"name": "accountName",
"in": "path",
"description": "Name of the account",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accountType",
"in": "query",
"description": "The type of account",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded; charset=UTF-8": {
"schema": {
"type": "string"
}
}

807
Extend Salesforce with Clicks, Not Code External Services

}
},
"responses": {
"201": {
"description": "The response when the account does not already exist and
we can create one",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountDetails"
}
}
}
},
"400": {
"description": "Error response if the account name parameter is less than
minimum characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
},
"404": {
"description": "Error response if the account is not supported by service
or account is not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
},
"409": {
"description": "The response when the account already exists and we cannot
create one",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountDetails"
}
}
}
}
}
},
"delete": {
"summary": "Deletes an account",
"description": "Deletes the account with specific name",
"operationId": "DeleteAccount",
"parameters": [

808
Extend Salesforce with Clicks, Not Code External Services

{
"name": "accountName",
"in": "path",
"description": "Name of the account",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The response when system finds an account with given name",

"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Error response if the account name parameter is less than
minimum characters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
},
"404": {
"description": "Error response if the account is not supported by service
or account is not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorModel"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"accountDetails": {
"required": [
"availableBal",
"id",

809
Extend Salesforce with Clicks, Not Code External Services

"name",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id"
},
"name": {
"type": "string",
"description": "name"
},
"type": {
"type": "string",
"description": "type"
},
"availableBal": {
"type": "string",
"description": "availableBal"
}
}
},
"errorModel": {
"required": [
"errorCode",
"errorMessage"
],
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "A service-specific error code."
},
"errorMessage": {
"type": "string",
"description": "A service-specific error code."
}
}
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
}
}
}

810
Extend Salesforce with Clicks, Not Code External Services

Use Flow to Invoke External Service Actions

In this Flow example, design and test the automation that sends a user’s information from Salesforce to the external employee banking
system. Create the variables for user phone numbers, and combine different phone numbers into one piece of data. Then use the external
service action to create the user.

End-to-end Example with Flow

In this Flow example, design and test the automation that sends a user’s information from Salesforce to the external employee
banking system. Create the variables for user phone numbers, and combine different phone numbers into one piece of data. Then
use the external service action to create the user.
View an Action’s Unique Apex Name in Flow
Map an action in Flow to an action in your external service. When searching for an External Service action in Flow Builder, you see
the unique Apex name in the list of actions.

SEE ALSO:
External Services
Build a Flow

End-to-end Example with Flow

In this Flow example, design and test the automation that sends a user’s information from Salesforce to the external employee banking
system. Create the variables for user phone numbers, and combine different phone numbers into one piece of data. Then use the external
service action to create the user.
1. Define a named credential
For this simplified example, use "legacy" Named Credentials. Instead of clicking New Named Credential, select New Legacy from
the dropdown menu next to the New Named Credential button. For the named credential that your org uses to access the banking
system, assign the Bank label. Assign a placeholder URL, such as https://api.example.com. Use example.com
because you paste in the schema at registration time, instead of using a URL to point to an API spec.
In the case where you use a URL, the named credential URL corresponds to the declared host of the API spec and one of its transfer
protocol schemes or URL protocols. The URL can point to a different endpoint as long as it hosts the same external service. The base
path is added to the named credential URL on callout.

2. Register the employee banking system’s external service, using the steps described in Register an External Service on page 780 as a
guide. Use the BankService name and the Bank named credential, and then copy the schema from the “External Services API
Spec Example 2”, found in the topic External Services OpenAPI 2.0 Schema on page 833.
3. Create a flow.
This example uses static values for simplicity. In contrast, a production flow with user data includes elements to get user records,
store values to variables, and communicate these values to the external service.

4. To handle the multiple phone numbers nested below the BankService_Phone value, add the two variable resources.
a. Click Manager, and then click New Resource.
b. For the resource type, select Variable.
c. For the API name, enter WorkPhone.
d. For the data type, select Apex-Defined.
e. For the Apex class, select ExternalService__BankService_Phone.

811
Extend Salesforce with Clicks, Not Code External Services

f. Click Done.
g. Repeat these steps using the API name CellPhone.

5. Add the variable resource that acts as the array for the phone number values.
a. Click New Resource.
b. For the resource type, select Variable.
c. For the API name, enter Phones.
d. For the data type, select Apex-Defined, and select the Allow multiple values (collection) option.
e. For the Apex class, select ExternalService__BankService_Phone.

812
Extend Salesforce with Clicks, Not Code External Services

f. Click Done.

6. Add the variable resource that stores the user’s name.

a. Click New Resource.
b. For the resource type, select Variable.
c. For the API name, enter User.
d. For the data type, select Apex-Defined.
e. For the Apex class, select ExternalService__BankService_User.
f. Click Done.

7. Assign values to the work phone variable.

a. From the Toolbox, click Elements.
b. Drag an Assignment element to the canvas.
c. For Label, enter Assign Work Phone, and let the API name autopopulate.
d. Click Search variables, select WorkPhone, then select phone. The variable {!WorkPhone.phone} appears.
e. For Value, enter 1234567890.
f. Click Add Assignment.

813
Extend Salesforce with Clicks, Not Code External Services

g. Click Search variables, select WorkPhone, then select typeofphone. The variable {!WorkPhone.typeofphone}
appears.
h. For Value, enter Work.

i. Click Done.
j. Connect the Start element to this assignment element.

8. Assign values to the cell phone variable.

a. Drag an Assignment element to the canvas.
b. For Label, enter Assign Cell Phone, and let the API name autopopulate.
c. Click Search variables, select CellPhone, then select phone. The variable {!CellPhone.phone} appears.
d. For Value, enter 0987654321
e. Click Add Assignment.
f. Click Search variables, select CellPhone, then select typeofphone. The variable {!CellPhone.typeofphone} appears.
g. For Value enter Cell.
h. Click Done.
i. Connect the last element to this one.

814
Extend Salesforce with Clicks, Not Code External Services

9. Assign multiple phone values to the single phone array variable.

a. Drag an Assignment element to the canvas.
b. For Label, enter Assign Phones, and let the API name autopopulate.
c. Click Search variables then select Phones. The variable {!Phones} appears.
d. Change the Operator to Add.
e. For Value, select Workphone.
f. Click Add Assignment.
g. Click Search variables then select Phones again.
h. Change the Operator to Add.
i. For Value select Cellphone.

j. Click Done.
k. Connect the last element to this one.

10. Assign the user values.

a. Drag an Assignment element to the canvas.

815
Extend Salesforce with Clicks, Not Code External Services

b. For Label, enter Assign User, and let the API name autopopulate.
c. Click Search variables, select User, then id. The variable {!User.id} appears.
d. For Value, enter 1234.
e. Click Add Assignment.
f. Click Search variables, select User, then name. The variable {!User.name} appears.
g. For Value, enter Maria.
h. Click Add Assignment.
i. Click Search variables, select User, then phones. The variable {!User.phones} appears.
j. For Value, select Phones.

k. Click Done.
l. Connect the last element to this one.

11. To create users on the external bank system, add the action generated by your external service schema.

816
Extend Salesforce with Clicks, Not Code External Services

a. Drag an Action element to the canvas.

b. Filter the actions by type, and select External Service.
c. Select postUser.
d. For Label, enter Create a new user, and let the API name autopopulate.
e. Next to >_user, click the toggle to include input values.
f. From the lookup, select User.

g. Click Done.
h. Connect the last element to this one. Your canvas includes these elements.

12. Save and debug the flow. A successful debug includes the assignment and External Service callout.

817
Extend Salesforce with Clicks, Not Code External Services

View an Action’s Unique Apex Name in Flow

Map an action in Flow to an action in your external service. When searching for an External Service
EDITIONS
action in Flow Builder, you see the unique Apex name in the list of actions.
When you add a resource for a new action, you can select the correct action from the correct Available in: Lightning
registration by virtue of its automatically generated Apex name. Experience

Available in: Enterprise,

Performance, Unlimited,
and Developer Editions

818
Extend Salesforce with Clicks, Not Code External Services

Invoke External Service Callouts Using Apex

You can call external service registrations natively from Apex. Make a callout to an external service like the Apex Http Class without
the need to write boilerplate code. The registered services are strongly typed in Apex with the registration’s schema as Apex types. These
Apex types reflect your registered service’s specification, making the Apex compiler do the heavy lifting for you.

External Service Registrations in Apex

See how registered external service schema types map to Apex types under the namespace ExternalService.
Use Apex to Create a Callout to an External Service
Design and test the automation that sends a user’s information from Salesforce to the external employee banking system. Using the
examples provided, create the variables for user phone numbers, and combine different phone numbers into one piece of data.
Then use the external service action to create the user.
View Apex Names in Apex Class Viewer
View all External Services auto-generated Apex classes in the Apex Class viewer in Setup.

External Service Registrations in Apex

See how registered external service schema types map to Apex types under the namespace
EDITIONS
ExternalService.
The example Apex types in this section refer to the Example 1: Basic OpenAPI Spec with Request Available in: Lightning
and Response (OAS 2.0) with a registered name "CreditScore". Experience

Available in: Enterprise,

Performance, Unlimited,
and Developer Editions

819
Extend Salesforce with Clicks, Not Code External Services

External Service
The external service registration with name ServiceName is the Apex class ExternalService.ServiceName making the
external service callable in Apex. To call operations on the external service in Apex, instantiate an instance with the default constructor.
For example, create an instance of CreditScore to make callouts:
ExternalService.CreditScore creditScore = new ExternalService.CreditScore();

External Service Operation

A registered external service’s derived operation name is declared as an Apex method on the Apex external service class.
• The operation input parameters are declared in the method’s request class in the order of declaration in the external service’s
specification and the corresponding parameter data type in Apex.
• The operation output parameters with successful HTTP response codes are declared in the method’s return response class. The API
specification’s HTTP response codes are declared in the response class. The response class’ property ResponseCode captures
the callout’s HTTP response code value.
• The operation output parameters with HTTP error response codes are declared in the method’s exception class for HTTP error codes.
The API specification’s HTTP error response codes are declared in the response exception class. The property ResponseCode
captures the callout’s HTTP error response code value. The property DefaultResponse the operation’s default response message
value for non declared HTTP response codes.
For example, the CreditScore’s operation getAccountLastCreditRating is declared as Apex method on the Apex class
ExternalService.CreditScore with corresponding input arguments, return response type and exception object:

global class CreditScore {

global getAccountLastCreditRating_Response getAccountLastCreditRating(
getAccountLastCreditRating_Request input) {...}

global class getAccountLastCreditRating_Request {

global accountId accountId {get; set;}
}

global class getAccountLastCreditRating_Response {

global Integer ResponseCode {get; set;}
CreditScore_creditRating Code200 {get; set}
}

global class getAccountLastCreditRating_ResponseException {

global Integer ResponseCode {get; set;}
global String DefaultResponse {get; set;}
global String Code405 {get; set;}
}
}

In the example, the method getAccountLastCreditRating throws exception

getAccountLastCreditRating_ResponseException that you can catch to process HTTP error codes.
To get the account’s last credit rating in Apex:
public class CreditScoreRater {
// Application domain exception
public class CreditScoreException extends Exception {}

820
Extend Salesforce with Clicks, Not Code External Services

public String rateCreditScore(String accountIdentifier) {

ExternalService.CreditScore creditScore = new ExternalService.CreditScore();

// Set the account ID

ExternalService.CreditScore_accountId accountId =
new ExternalService.CreditScore_accountId();
accountId.accountIdString = accountIdentifier;

// Call to get the last credit rating

try {
// Construct the request
ExternalService.CreditScore.getAccountLastCreditRating_Request request =
new ExternalService.CreditScore.getAccountLastCreditRating_Request();
// Set the request input parameters: The request body
request.body = accountId;

// Call the external credit rating service

ExternalService.CreditScore.getAccountLastCreditRating_Response response =
creditScore.getAccountLastCreditRating(request);

// Get the credit rating response for HTTP status code 200
ExternalService.CreditScore_creditRating creditRating = response.Code200;

// The rating
return creditRating.creditRatingString;

// Handle callout error and translate to application domain exception

} catch (ExternalService.CreditScore.getAccountLastCreditRating_ResponseException

e) {
// Invalid input is flagged with status code 405
if (e.ResponseCode == 405) {
throw new CreditScoreException('Invalid input for account: ' +
accountId.accountIdString);
}

// Handle generic callout error - for example internal server error code 500
throw new CreditScoreException('Unknown error: ' + e.ResponseCode + ': '
+ e.DefaultResponse);
}
}
}

External Service Data Types

OpenAPI schema data types are mapped to their corresponding Apex types as follows:

OpenAPI 2/3 Data Types (type, format) Apex Type

integer Integer

integer, int32 Integer

integer, int64 Long

821
Extend Salesforce with Clicks, Not Code External Services

OpenAPI 2/3 Data Types (type, format) Apex Type

number, float Double

number, double Double

string String

string, byte Blob

string, binary Blob

string, date Date

string, date-time Datetime

boolean Boolean

array List<>

object Apex Property Class, Map<>

Array
The OpenAPI type array is mapped as Apex List<ElementType>. The items type is mapped to ElementType.

Object
The OpenAPI type object is mapped as a named Apex class where the Apex class properties match the OpenAPI properties
by property name and type. additionalProperties are mapped as Apex Map<String, ValueType>. The
additionalProperties name is the map key, the additionalProperties type is the map’s ValueType.

Object Naming
OpenAPI schema object types defined as a named reference with definitions in OpenAPI 2 or schema components in OpenAPI
3 map to the Apex Property Class type: ExternalService.<Service Name>_<Reference Name>. For example, the
credit score’s creditRating object schema is ExternalService.CreditScore_creditRating.
Schema object types anonymously declared inline instead of a named schema reference must be identifiable as an Apex property class
by name with this naming scheme:
• Operation request body object schema:
– ExternalService.<Service Name>_<Operation Name>_IN

• Operation response object schema with successful HTTP status code (< 300):
– ExternalService.<Service Name>_<Operation Name>_OUT_<Response Code>

• Operation response object schema with error HTTP status code (>= 300):
– ExternalService.<Service Name>_<Operation Name>_EXC_<Response Code>

• Object schema as property type of another schema object:

– ExternalService.<Service Name>_<Property's Object Name>_<Property Name>

• Polymorphic object schema in allOf schema composition with discriminator:

822
Extend Salesforce with Clicks, Not Code External Services

– ExternalService.<Service Name>_<Composition Schema Reference Name>_KT_PT

Array item type with anonymous object schema - Apex Properties Class for list ElementType:
• Element type for named schema referenced array:
– ExternalService.<Service Name>_VT_<Array Reference Name>

• Element type for anonymous schema array follows the object schema naming scheme
Object’s additionalProperties type with anonymous object schema - Apex Properties Class for map ValueType:
• Map value type for additionalProperties in named reference object schema:
– ExternalService.<Service Name>_KT_VN_<additonalProperties' Object Reference Name>

• Map value type for addtionalProperties in anonymous object schema:

– <additionalProperties' Anonymous Object Name>_KT_V

For more object schema type examples, see: Schema Examples.

Variable Naming
When Salesforce maps variable names from your schema into Apex variable names, certain characters are translated.

Schema Variable Translates Into Apex As Example

_ (underscore) x5f account_type (schema)
accountx5ftype (Apex)

- (hyphen) x2d account-status (schema)

accountx2dstatus (Apex)

(reserved keyword) prepended with z0 User (schema)

z0User (Apex)

Use Apex to Create a Callout to an External Service

Design and test the automation that sends a user’s information from Salesforce to the external
EDITIONS
employee banking system. Using the examples provided, create the variables for user phone
numbers, and combine different phone numbers into one piece of data. Then use the external Available in: Lightning
service action to create the user. Experience
1. Define a named credential
Available in: Enterprise,
For this simplified example, use "legacy" Named Credentials. Instead of clicking New Named Performance, Unlimited,
Credential, select New Legacy from the dropdown menu next to the New Named Credential and Developer Editions
button. For the named credential that your org uses to access the banking system, assign the
Bank label. Assign a placeholder URL, such as https://api.example.com. Use
example.com because you paste in the schema at registration time, instead of using a URL to point to an API spec.

823
Extend Salesforce with Clicks, Not Code External Services

In the case where you use a URL, the named credential URL corresponds to the declared host of the API spec and one of its transfer
protocol schemes or URL protocols. The URL can point to a different endpoint as long as it hosts the same external service. The base
path is added to the named credential URL on callout.

2. Register the employee banking system’s external service, using the steps described in Register an External Service on page 780 as a
guide. Use the BankService name and the Bank named credential, and then copy the schema from the “External Services API
Spec Example 2”, found in the topic External Services OpenAPI 2.0 Schema on page 833.
3. Create the Apex class BankService:

public class BankService {

}

4. To store the user details, add a member variable:

public class BankService {
private ExternalService.BankService_z0User user;
}

5. To initialize an empty user with an empty list of phones, add a method:

public class BankService {
private ExternalService.BankService_z0User user;

private void setEmptyUser() {

if (this.user == null) {
this.user = new ExternalService.BankService_z0User();
this.user.phones = new List<ExternalService.BankService_Phone>();
}
}
}

6. To assign the work phone value, add a method:

public class BankService {
private ExternalService.BankService_z0User user;

public void setWorkPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Work';
this.user.phones.add(phone);
}

private void setEmptyUser() {

if (this.user == null) {
this.user = new ExternalService.BankService_z0User();
this.user.phones = new List<ExternalService.BankService_Phone>();
}
}
}

824
Extend Salesforce with Clicks, Not Code External Services

7. To assign the cell phone value, add a method:

public class BankService {
private ExternalService.BankService_z0User user;

public void setWorkPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Work';
this.user.phones.add(phone);
}

public void setCellPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Cell';
this.user.phones.add(phone);
}

private void setEmptyUser() {

if (this.user == null) {
this.user = new ExternalService.BankService_z0User();
this.user.phones = new List<ExternalService.BankService_Phone>();
}
}
}

8. To assign a user, add a method:

public class BankService {
private ExternalService.BankService_z0User user;

public void setUser(Integer userId, String userName) {

setEmptyUser();
this.user.id = userId;
this.user.name = userName;
}

public void setWorkPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Work';
this.user.phones.add(phone);
}

public void setCellPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =

825
Extend Salesforce with Clicks, Not Code External Services

new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Cell';
this.user.phones.add(phone);
}

private void setEmptyUser() {

if (this.user == null) {
this.user = new ExternalService.BankService_z0User();
this.user.phones = new List<ExternalService.BankService_Phone>();
}
}
}

9. Create a custom exception class, since you can’t throw built-in Apex exceptions.
Public class BankServiceException extends Exception{}

For more information, see Create Custom Exceptions in Apex Developer Guide.

10. To create users on the external bank system, add a method to call the external BankService:
public class BankService {
private ExternalService.BankService_z0User user;

public void createUser() {

if (this.user == null || this.user.id == null) {
throw new BankServiceException('Set the user to create first');
}

ExternalService.BankService bankService = new ExternalService.BankService();

try {
ExternalService.BankService.postUsers_Request request = new
ExternalService.BankService.postUsers_Request();
request.z0user = this.user;
bankService.postUsers(request);
} catch (ExternalService.BankService.postUsers_ResponseException e) {
throw new BankServiceException('Couldn\'t create user with ID: ' +
this.user.id);
}
}
public void setUser(Integer userId, String userName) {
setEmptyUser();
this.user.id = userId;
this.user.name = userName;
}

public void setWorkPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Work';
this.user.phones.add(phone);
}

826
Extend Salesforce with Clicks, Not Code External Services

public void setCellPhone(String phoneNumber) {

setEmptyUser();
ExternalService.BankService_Phone phone =
new ExternalService.BankService_Phone();
phone.phone = phoneNumber;
phone.typeofphone = 'Cell';
this.user.phones.add(phone);
}

private void setEmptyUser() {

if (this.user == null) {
this.user = new ExternalService.BankService_z0User();
this.user.phones = new List<ExternalService.BankService_Phone>();
}
}
}

11. Open the developer console and debug by calling the BankService with some sample values with a code snippet in an
anonymous execution class. Have the debug logs open and compare with this sample callout log:
BankService bankService = new BankService();
bankService.setWorkPhone('1234567890');
bankService.setCellPhone('0987654321');
bankService.setUser(1234, 'Maria');
bankService.createUser();

View Apex Names in Apex Class Viewer

View all External Services auto-generated Apex classes in the Apex Class viewer in Setup.
EDITIONS
As an example, let’s examine the BankServices’ Apex classes.
Available in: Lightning
1. From Setup, in the Quick Find box, enter Apex Classes, and then select Apex Classes.
Experience
2. Scroll down to Dynamic Apex Classes.
Available in: Enterprise,
3. To filter the view, click Create New View. Performance, Unlimited,
4. Enter a View Name. and Developer Editions
5. Under Filter By Additional Fields (optional), select
a. Field - Class Name
b. Operator - starts with
c. Value - “BankService”

6. Save your changes.

Now the list includes only classes that begin with “BankService”.
To see the external service associated with your class, click Open under the Action column.
To see details about the Apex class, click the Class Name. In this example, click BankService. In this detailed view, you can see all of the
Apex names. The order of components is the same as they appeared in the original JSON-formatted schema. Operations, Requests, and
Responses are highlighted in all caps to make it easier to browse the Apex code. In this partial snippet, you can view the details for
BankService_accountDetails.

827
Extend Salesforce with Clicks, Not Code External Services

Add External Service Actions to an Einstein Bot

Integrating your Einstein bot with a registered external service is now as easy as adding an action to a dialog. You can add an external
service action to your bot from Einstein’s Bot Builder.
Sometimes the data that your Einstein bot uses to personalize customer requests is stored outside of Salesforce. For example, a banking
customer wants to update their account password and billing address in a single bot conversation. Or a retail customer starts a return
process for a purchase and expects the bot to return a unique tracking number. Now you can automate these multi-platform requests
directly from the Bot Builder, without writing a single line of code.

SEE ALSO:
Add an External Service Action

Invoke External Services from OmniStudio Assets

You can invoke External Services registered actions from OmniStudio Integration Procedures in OmniScripts and FlexCards.
There are two ways that OmniStudio can invoke External Services' registered actions.
1. Create a custom Apex Class that implements System.Callable
Create a method with methods and parameters, and then call the External Services API. For example:
public with sharing class RemoteActionClass implements System.Callable
{
public Object call(String action, Map<String,Object> args)
{
Map<String,Object> inputMap = (Map<String,Object>) args.get('input');
Map<String,Object> outputMap = (Map<String,Object>) args.get('output');

828
Extend Salesforce with Clicks, Not Code External Services

Map<String,Object> options = (Map<String,Object>) args.get('options');

action == 'Methodname'

Object result = Call External Services API;

outputMap.put('result', result);

return outputMap;
}

For more details, see Workflow for Remote Action Apex Class Example.
2. Use an Integration Procedure with a Remote Action
For details about the syntax to call an External Services invocable action with a Remote Action, see: Create a Remote Action for an
Invocable Action.

SEE ALSO:
Remote Action for Integration Procedures
Remote Action Properties for Integration Procedures
Trailhead: OmniStudio Integration Procedures

Install or Create Packages

You can install or create packages that contain an external service. Read these tips before you begin.
EDITIONS

Consuming an External Services Package Available in: Lightning

Experience
Any flow within the package or newly added flows outside the package can reference external
service actions. Available in: Enterprise,
Performance, Unlimited,
and Developer Editions
Creating an External Services Package
To ensure that subscriber orgs that install a package can use the External Service actions from the
External Services registration: Add named credential components to the external services registration package. Alternatively, a subscriber
can create a named credential in the subscriber org using the same name as the one specified in the external services registration that
references it.

SEE ALSO:
External Services
Components Available in First-Generation Managed Packages

829
Extend Salesforce with Clicks, Not Code External Services

Testing External Services

Test the example flow MyAtmFlow with a flow action calling the external service MyAtmExternalService by implementing
the HttpCalloutMock interface. The interface provides a test response without performing the callout to the external service
endpoint. The sample Apex unit test performs a mock test against the same HTTP callout mock implementation.
Test the example flow MyAtmFlow with a flow action calling the external service MyAtmExternalService by implementing
the HttpCalloutMock interface that provides a test response without performing the callout to the external service endpoint. The sample
Apex unit test performs a mock test against the same HTTP callout mock implementation.
{
"swagger": "2.0",
"basePath": "/",
"info": {
"version": "1.0",
"title": "My ATM External Service Demo",
"description": "Demo ATM OpenAPI service for mock testing"
},
"paths": {
"/accounts/{accountId}": {
"get": {
"operationId": "getBalance",
"summary": "Get account balance",
"description": "Get the current account balance for the given account ID and pin",

"consumes": [
"text/plain"
],
"produces": [
"application/json"
],
"parameters": [{
"name": "accountId",
"in": "path",
"required": true,
"type": "string",
"description": "Account ID"
}, {
"name": "pin",
"in": "header",
"required": true,
"type": "integer",
"description": "Account holder's PIN"
}],
"responses": {
"200": {
"description": "The response when system finds an account with given name",
"schema": {
"required": [
"accountId",
"name",
"type",
"availableBal"
],
"type": "object",

830
Extend Salesforce with Clicks, Not Code External Services

"properties": {
"accountId": {
"type": "string",
"description": "Unique account ID"
},
"name": {
"type": "string",
"description": "Account name"
},
"type": {
"type": "string",
"description": "Account type",
"example": "Checking"
},
"availableBal": {
"type": "integer",
"description": "Available balance"
}
}
}
},
"401": {
"description": "Invalid authentication or invalid account"
}
}
}
}
}
}

MyAtmExternalService is registered with a Named Credential MyAtmNamedCredential, has operation getBalance

with String accountId as path parameter and Integer pin as header parameter. Its output is a JSON data structure with the account
ID, account holder, balance, and account type.
The HTTP callout mock implementation reacts to an expected test request by responding with the appropriate HTTP response output:
global class MyAtmHttpCalloutMock implements HttpCalloutMock {
global HTTPResponse respond(HTTPRequest request) {
// Assert expected request test data
System.assertEquals('GET', request.getMethod());
System.assertEquals('callout:MyAtmNamedCredential/A123-456', request.getEndpoint());

System.assertEquals('1234', request.getHeader('pin'));

// Send response test data

HttpResponse response = new HttpResponse();
response.setHeader('Content-Type', 'application/json');
response.setBody('{"availableBal": 0, "name": "Account Holder", ' +
'"type": "Checking", "accountId": "A123-456"}');
response.setStatusCode(200);
return response;
}
}

831
Extend Salesforce with Clicks, Not Code External Services

The flow test class sets up the HTTP callout mock for the external service action it’s calling. It creates a flow interview with input parameter
values to test, runs the flow interview, and then asserts the actual flow output parameters with expected test values:
@IsTest
public class MyAtmFlowTest {
@IsTest
static public void testMyAtmFlow() {
// Set HTTP callout mock to match flow's external service action invocation
Test.setMock(HttpCalloutMock.class, new MyAtmHttpCalloutMock());

// Set flow input variables and create the flow interview

Map<String, Object> inputVariables = new Map<String, Object>();
inputVariables.put('accountId', 'A123-456');
inputVariables.put('pin', 1234);
Flow.Interview myAtmFlow = Flow.Interview.createInterview('MyAtmFlow',
inputVariables);

// Start flow interview with set input variables

myAtmFlow.start();

// Assert flow output variables

ExternalService.MyAtmExternalService_getBalance_OUT_200 expected =
new ExternalService.MyAtmExternalService_getBalance_OUT_200();
expected.availableBal = 0;
expected.name = 'Account Holder';
expected.type = 'Checking';
expected.accountId = 'A123-456';
System.assertEquals(expected.toString(),
(String)myAtmFlow.getVariableValue('myFlowOutput'));
}
}

The Apex test class sets up the HTTP callout mock for the external service method it’s calling. It calls directly the external service in Apex
with input parameter values to test and then asserts the actual output parameters with expected test values. This Apex test class illustrates
how you can test an external service directly, for example, to assert an expected behavior for a registered service. Application code using
external services in Apex can perform unit testing following the same pattern:
@IsTest
public class MyAtmApexTest {
@IsTest
static public void testMyAtmCallout() {
// Set HTTP callout mock
Test.setMock(HttpCalloutMock.class, new MyAtmHttpCalloutMock());

// Call with the expected mock accountId and pin

ExternalService.MyAtmExternalService myAtm =
new ExternalService.MyAtmExternalService();
ExternalService.MyAtmExternalService.getBalance_Request request =
new ExternalService.MyAtmExternalService.getBalance_Request();
request.accountId = 'A123-456';
request.pin = 1234;
ExternalService.MyAtmExternalService_getBalance_OUT_200 actual =
myAtm.getBalance(request).Code200;

832
Extend Salesforce with Clicks, Not Code External Services

// Assert the response variables

ExternalService.MyAtmExternalService_getBalance_OUT_200 expected =
new ExternalService.MyAtmExternalService_getBalance_OUT_200();
expected.availableBal = 0;
expected.name = 'Account Holder';
expected.z0type = 'Checking';
expected.accountId = 'A123-456';
System.assertEquals(expected.toString(), actual.toString());
}
}

Schema Examples
Explore various scenarios with OpenAPI 2.0 and OpenAPI 3.0 compliant JSON schemas supported by External Services. The examples
cover schema elements like HTTP header as input parameters, and include example usage in Apex. Understanding the examples helps
with proper syntax and code placement.

External Services OpenAPI 2.0 Schema

This section features External Services OpenAPI 2.0 schema examples.
External Services OpenAPI 3.0 Schema
This section features External Services OpenAPI 3.0 schema examples.
Using the Schema Examples
See how the respective Open API 2.0 and 3.0 examples are implemented with Apex.

External Services OpenAPI 2.0 Schema

This section features External Services OpenAPI 2.0 schema examples.
EDITIONS

Example 1: Basic OpenAPI Spec with Request and Response (OAS 2.0) Available in: Lightning
Experience
Here’s an example of an API spec that contains a supported JSON schema for OpenAPI 2.0. The
parameters (in bold) contain the definition for the accountId input. The responses (also in bold) Available in: Enterprise,
contain the definition for the output, which is creditRating. Parameters and responses Performance, Unlimited,
translate to inputs and outputs, respectively, for your flow actions. and Developer Editions

{
"swagger":"2.0",
"info":{
"description":"A service for checking credit for an account.",
"version":"1.0.0",
"title":"Credit Decision",
"termsOfService":"http://swagger.io/terms/",
"contact":{
"email":"[email protected]"
},
"license":{
"name":"Apache 2.0",
"url":"http://www.apache.org/licenses/LICENSE-2.0.html"
}

833
Extend Salesforce with Clicks, Not Code External Services

},
"host":"<YourHostName>",
"paths":{
"/account/lastCreditRating":{
"get":{
"summary":"Evaluates credit rating and decides what payment terms to offer.",

"description":"",
"consumes":[
"application/json",
"application/xml"
],
"produces":[
"application/xml",
"application/json"
],
"parameters":[{
"in":"body",
"name":"body",
"description":"Specifies input parameters to calculate payment term",
"required":true,
"schema":{
"$ref":"#/definitions/accountId"
}
}],
"responses":{
"200":{
"description":"success",
"schema":{
"$ref":"#/definitions/creditRating"
}
},
"405":{
"description":"Invalid input"
}
}
}
}
},
"definitions":{
"accountId":{
"type":"object",
"properties":{
"accountIdString":{
"type":"string"
}
},
"xml":{
"name":"accountId"
}
},
"creditRating":{
"type":"object",
"properties":{

834
Extend Salesforce with Clicks, Not Code External Services

"creditRatingString":{
"type":"string"
}
},
"xml":{
"name":"creditRating"
}
}
}
}

Example 2: Named Object Schema Reference (OAS 2.0)

Basic Setup
• For the named credential that your org uses to access the banking system, assign the Bank label and a placeholder URL, such as
https://api.example.com. Use example.com because you’ll paste in the schema at registration time, instead of using
a URL to point to an API spec.
• Register the employee banking system’s external service. Use the Bank name and the Bank named credential, and then copy
and paste in the following schema.
• The banking system's external service shows two ways to define parameters with object types: a named object type under a
“definitions” block or an anonymously declared object type inline.

Note: The defined or derived parameter object type name, or a property with an object type, must be fewer than 255 characters
to be used in Apex or Flow Builder.

Here’s a schema with the named object type defined under the “definitions” block. The phone object type's name is
ExternalService__Bank_Phone in Apex or Flow Builder.

{
"swagger": "2.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"host": "api.example.com",
"basePath": "/v1",
"schemes": [
"https"
],
"definitions": {
"User": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones":{
"type":"array",
"items":{

835
Extend Salesforce with Clicks, Not Code External Services

"type": "object",
"$ref": "#/definitions/Phone"
}
}
}
},
"Phone":{
"properties":{
"typeofphone":{
"type":"string"
},
"phone":{
"type":"string"
}
}
}
},
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [{
"in": "path",
"name": "userId",
"required": true,
"type": "integer"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/User"
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"parameters": [{
"in": "body",
"name": "user",
"schema": {
"$ref": "#/definitions/User"
}
}],
"responses": {
"200": {
"description": "OK"
}
}
}
}

836
Extend Salesforce with Clicks, Not Code External Services

}
}

Example 3: Nested Anonymous Object Schema (OAS 2.0)

Here’s an API spec with a JSON schema with anonymous object types defined inline. The derived phone object type's name is
ExternalService__Bank_getUsers_OUT_200_phones.

Note: For anonymous object types, Salesforce automatically derives object type names based on the external service, parent
operation, operation parameter, parent object, and object property names. The derived name must be fewer than 255 characters.
For more information, see "External Service Apex Class Names and Developer Names" in Considerations.
{
"swagger": "2.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"host": "api.example.com",
"basePath": "/v1",
"schemes": [
"https"
],
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [{
"in": "path",
"name": "userId",
"required": true,
"type": "integer"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type":"array",
"items": {
"type": "object",
"properties": {
"typeofphone": {
"type":"string"
},

837
Extend Salesforce with Clicks, Not Code External Services

"phone": {
"type":"string"
}
}
}
}
}
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"parameters": [{
"in": "body",
"name": "user",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type":"array",
"items": {
"type": "object",
"properties": {
"typeofphone": {
"type":"string"
},
"phone": {
"type":"string"
}
}
}
}
}
}
}],
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}

838
Extend Salesforce with Clicks, Not Code External Services

Example 4: Apex Object Class Naming (OAS 2.0)

Here's an API spec registered with external service name BankingAutomaticTellerMachine. However, the derived object names must
be no longer than 255 characters:
• ExternalService__BankingAutomaticTellerMachine_VeryImportantCustomer_phone
• ExternalService__BankingAutomaticTellerMachine_getBalanceAccountTypeChecking_OUT_200
To use Apex or Flow Builder, you must shorten the external service schema name and the schema (shown in Example 5).

Tip: If the derived object name is longer than 255 characters, try one of the following methods to resolve the issue.
• Shorten the external service name.
• If the object is declared inline under an operation parameter, shorten the operation name by adding an operationId to the
schema.
• If the object is declared inline under a parent object property, shorten the parent object name in the schema.
• Declare the nested object as a top-level object under schema “definitions”.

{
"swagger": "2.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"parameters": [{
"in": "path",
"name": "accountId",
"required": true,
"type": "integer"
}],
"responses": {
"200": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/definitions/VeryImportantCustomer"
}
}
}
}
}
}
}
},
"definitions": {
"VeryImportantCustomer": {
"type": "object",
"properties": {
"name": {
"type": "string"
},

839
Extend Salesforce with Clicks, Not Code External Services

"phone": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}

Example 5: Shortening Apex Object Class Names (OAS 2.0)

Here's an example of an API spec with a schema that results in shortened names. It's registered with the shortened name BankAtm.
Shorten the external service schema name to BankAtm, the schema object name to VIP and add operationId as getBalance:
• ExternalService__BankAtm_VIP_phone
• ExternalService__BankAtm_getBalance_200
{
"swagger": "2.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"operationId": "getBalance",
"parameters": [{
"in": "path",
"name": "accountId",
"required": true,
"type": "integer"
}],
"responses": {
"200": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/definitions/VIP"
}
}
}
}
}
}
}
},
"definitions": {
"VIP": {

840
Extend Salesforce with Clicks, Not Code External Services

"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}

Example 6: Inline Arrays (OAS 2.0)

Here's an example with an inline array definition.
{
"swagger": "2.0",
"host": "Employees.org",
"basePath": "/",
...
"paths": {
"/employees/{employeeId}": {
"get": {
"operationId": "getEmployee",
"parameters": [{
"in": "path",
"name": "employeeId",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"schema": {
"type": "object",
"properties": {
"employee": {"$ref": "#/definitions/Employee"},
"manager": {"$ref": "#/definitions/Employee"},
"team": {
"type": "array",
"items": {"$ref": "#/definitions/Employee"}
}
}
}
}
}
}
}

841
Extend Salesforce with Clicks, Not Code External Services

},
"definitions": {
"Employee" : {
"type": "object",
"properties": {
"employeeId": {"type": "string"},
"firstName": {"type": "string"},
"middleName": {"type": "string"},
"lastName": {"type": "string"},
"dateOfHire": {"type": "date"}
}
}
}
}
}

Example 7: HTTP Header Parameters (OAS 2.0)

Here’s how a header parameter is declared in an OpenAPI schema. In Apex or Flow, the name “apiKey” shows up as a string parameter.
Now when you set any string value in Apex or a flow to apiKey, it functions as an HTTP parameter when making a callout request.
{
"swagger": "2.0",
"info": {
"description": "A service for checking credit for an account.",
"version": "1.0.0",
"title": "Credit Decision",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host": "<YourHostName>",
"paths": {
"/account/lastCreditRating": {
"get": {
"summary": "Evaluates credit rating and decides what payment terms to offer.",
"description": "",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [{
"name": "body",
"description": "Specifies input parameters to calculate payment term",
"in": "body",

842
Extend Salesforce with Clicks, Not Code External Services

"required": true,
"schema": {
"$ref": "#/definitions/accountId"
}
},{
"name": "apiKey",
"description": "Your API Key for calling the credit rating service",
"in": "header",
"type": "string"
}],
"responses": {
"200": {
"description": "success",
"schema": {
"$ref": "#/definitions/creditRating"
}
},
"405": {
"description": "Invalid input"
}
}
}
}
},
"definitions": {
"accountId": {
"type": "object",
"properties": {
"accountIdString": {
"type": "string"
}
},
"xml": {
"name": "accountId"
}
},
"creditRating": {
"type": "object",
"properties": {
"creditRatingString": {
"type": "string"
}
},
"xml": {
"name": "creditRating"
}
}
}
}

843
Extend Salesforce with Clicks, Not Code External Services

Example 8: URL Encoded Form Media Type (OAS 2.0)

Request and response form data is declared alongside the matching consumes and produces directives.
{
"swagger": "2.0",
"info": {
"description": "Apply here for your next mortgage",
"version": "1.0.0",
"title": "My Mortgage Buddy",
"contact": {
"email": "[email protected]"
}
},
"host": "MyMortgageBuddy.org",
"basePath": "/mortgages",
"paths": {
"/apply": {
"post": {
"operationId": "applyMortgage",
"consumes": [
"application/x-www-form-urlencoded; charset=utf-8"
],
"produces": [
"application/x-www-form-urlencoded; charset=utf-8"
],
"parameters": [{
"description": "Desired mortgage terms",
"name": "terms",
"in": "formData",
"type": "array",
"items": {
"type": "integer"
},
"collectionFormat": "multi",
"required": true
},{
"description": "Full Name",
"name": "fullName",
"in": "formData",
"type": "string",
"required": true
},{
"description": "Loan amount",
"name": "loanAmount",
"in": "formData",
"type": "number",
"required": true
}],
"responses": {
"200": {
"description": "200",
"schema": {
"type": "object",
"properties": {

844
Extend Salesforce with Clicks, Not Code External Services

"formApplicationId": {
"type": "string"
},
"loanOfficerFullName": {
"type": "string"
}
}
}
}
}
}
}
}
}

Example 9: allOf and additionalProperties Schema Directives (OAS 2.0)

This JSON schema definition highlights the constructs allOf for schema object composition and additionalProperties for
dictionary values. The sample schema is registered as external service MyBank with named credential MyBank. The registration is
invoked by a sample flow that accesses the dictionary properties with an Apex invocable action. A flow Apex unit test ties it all together.
The schema defines a banking service that gets customer details for a customer ID.
• The Customer schema object has dictionary properties of type schema object CreditRating. In Apex, the class
ExternalService.MyBank_Customer has property properties of type Map<String,
ExternalService_CreditRating> with the customer’s credit ratings.
• Phones and Emails compose their own properties together with the common allOf properties from the schema object Contact.
{
"swagger": "2.0",

"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and additionalProperties schema
constructs",
"version": "1.0.0"
},

"host": "api.mybank.com",
"basePath": "/v1",
"schemes": [
"https"
],

"definitions": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},

845
Extend Salesforce with Clicks, Not Code External Services

"phones": {
"type":"array",
"items": {
"$ref": "#/definitions/Phone"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
}
},
"additionalProperties": {
"$ref": "#/definitions/CreditRating"
},
"required": [
"id",
"name"
]
},

"Contact": {
"type": "object",
"properties": {
"primary": {
"type": "boolean"
},
"timeOfDay": {
"type": "string"
}
},
"required": [
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/definitions/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type":"string"
},
"phoneNumber":{
"type":"string"
}
}
}
]
},

846
Extend Salesforce with Clicks, Not Code External Services

"Email": {
"allOf": [
{
"$ref": "#/definitions/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type":"string"
}
}
}
]
},

"CreditRating": {
"type": "object",
"properties": {
"rating": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
}
},

"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [{
"in": "path",
"name": "customerId",
"required": true,
"type": "integer"
}],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Customer"
}
}
}
}
}
}
}

847
Extend Salesforce with Clicks, Not Code External Services

To use allOf composition and additionalProperties, see For Examples 9: allOf Composition and additionalProperties Use
in Flow with Apex Unit Tests on page 874.

Example 10: allOf and Discriminator Directives (OAS 2.0)

To specify a general extensible list of contacts for a customer, the discriminator directive can be combined with allOf to
declare whether a contact is an email or a phone number:
{
"swagger": "2.0",

"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and discriminator",
"version": "1.0.0"
},
"host": "api.mybank.com",
"basePath": "/v1",
"schemes": [
"https"
],
"definitions": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"contacts": {
"type":"array",
"items": {
"$ref": "#/definitions/Contact"
}
}
},
"required": [
"id",
"name"
]
},

"Contact": {
"type": "object",
"discriminator": "contactType",
"properties": {
"contactType": {
"type": "string"
},
"primary": {
"type": "boolean"
},

848
Extend Salesforce with Clicks, Not Code External Services

"timeOfDay": {
"type": "string"
}
},
"required": [
"contactType",
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/definitions/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type":"string"
},
"phoneNumber":{
"type":"string"
}
}
}
]
},
"Email": {
"allOf": [
{
"$ref": "#/definitions/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type":"string"
}
}
}
]
}
},

"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [{
"in": "path",
"name": "customerId",
"required": true,
"type": "integer"
}],

849
Extend Salesforce with Clicks, Not Code External Services

"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Customer"
}
}
}
}
}
}
}

To use composition and polymorphic OpenAPI schema constructs, see For Examples 10: Polymorphism with allOf and Discriminator on
page 880.

Array Definition (OAS 2.0)

External Services supports inline array definitions and referenceable named arrays. List types in External Services are identified by their
object element type.
Supported Inline Array Definition with Reference to Array Items Definition
{
"swagger": "2.0",
...
"name": "myObjects",
"in": "body",
"schema": {
"type": "array",
"items": {
"$ref": "#definitions/MyObject"
}
}
...
"definitions": {
"MyObject": {
"type": "object",
"properties": {...}
}
}
}

In Apex and Flow Builder, declare a variable for the myObjects parameter by marking the variable as a collection and picking its Apex
element type ExternalService__RegistrationName_MyObject.
Inline Array Definition with Inline Array Items Definition
{
"swagger": "2.0",
...
"name": "myObjects",
"in": "body",
"schema": {
"type": "array",
"items": {

850
Extend Salesforce with Clicks, Not Code External Services

"type": "object",
"properties": {...}
}
}
...
"definitions": {
...
}
}

In Apex and Flow Builder, declare a collection variable for the myObjects parameter and Apex element type
ExternalService__RegistrationName_OperationName_IN_myObjects.
Referenceable Array Definition with Reference to Array Item Definitions
{
"swagger": "2.0",
...
"name": "myObjects",
"in": "body",
"schema": {
"$ref": "#definitions/MyObjectList"
}
...
"definitions": {
"MyObjectList": {
"type": "array",
"items": {
"$ref": "#definitions/MyObject"
}
}
"MyObject": {
"type": "object",
"properties": {...}
}
}
}

In Apex and Flow Builder, declare a collection variable for the myObjects parameter and Apex element type
ExternalService__RegistrationName_MyObject.
Referenceable Array Definition with Inline Array Items Definition
{
"swagger": "2.0",
...
"name": "myObjects",
"in": "body",
"schema": {
"$ref": "#definitions/MyObjectList"
}
...
"definitions": {
"MyObjectList": {
"type": "array",
"items": {

851
Extend Salesforce with Clicks, Not Code External Services

"type": "object",
"properties": {...}
}
}
}
}

In Apex and Flow Builder, declare a collection variable for the myObjects parameter and Apex element type
ExternalService__RegistrationName_MyObjectList.

SEE ALSO:
External Services OpenAPI 3.0 Schema
Using the Schema Examples
Considerations

External Services OpenAPI 3.0 Schema

This section features External Services OpenAPI 3.0 schema examples.
EDITIONS

Example 1: Basic OpenAPI Spec with Request and Response (OAS 3.0) Available in: Lightning
Experience
Here’s an example of an API spec that contains a supported JSON schema for OpenAPI 3.0. The
parameters contain the definition for the accountId input. The responses contain the definition Available in: Enterprise,
for the output, which is creditRating. Parameters, requests, and responses translate to inputs Performance, Unlimited,
and outputs, respectively, for your flow actions. and Developer Editions

{
"openapi": "3.0.0",
"info": {
"description": "A service for checking credit for an account.",
"version": "1.0.0",
"title": "Credit Decision",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "https://<YourHostName>"
}
],
"paths": {
"/account/lastCreditRating": {
"get": {
"summary": "Evaluates credit rating and decides what payment terms to offer.",
"description": "",

852
Extend Salesforce with Clicks, Not Code External Services

"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
}
},
"description": "Specifies input parameters to calculate payment term",
"required": true
},
"responses": {
"200": {
"description": "success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
}
}
},
"405": {
"description": "Invalid input"
}
}
}
}
},
"components": {
"schemas": {
"accountId": {
"type": "object",
"properties": {
"accountIdString": {
"type": "string"
}
},
"xml": {
"name": "accountId"
}
},
"creditRating": {

853
Extend Salesforce with Clicks, Not Code External Services

"type": "object",
"properties": {
"creditRatingString": {
"type": "string"
}
},
"xml": {
"name": "creditRating"
}
}
}
}
}

Example 2: Named Object Schema Reference (OAS 3.0)

Basic Setup
• For the named credential that your org uses to access the banking system, assign the Bank label and a placeholder URL, such as
https://api.example.com. Use example.com because you’ll paste in the schema at registration time, instead of using
a URL to point to an API spec.
• Register the employee banking system’s external service. Use the Bank name and the Bank named credential, and then copy
and paste in the following schema.
• The banking system's external service shows two ways to define parameters with object types: a named object type under a
“components/schema” block or an anonymously declared object type inline.

Note: The defined or derived parameter object type name, or a property with an object type, must be fewer than 255 characters
to be used in Apex or Flow Builder.

Here’s a schema with the named object type defined under the “components/schema” block. The phone object type's name is
ExternalService__Bank_Phone in Apex or Flow Builder.

{
"openapi": "3.0.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.example.com/v1"
}
],
"components": {
"schemas": {
"User": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"

854
Extend Salesforce with Clicks, Not Code External Services

},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phone"
}
}
}
},
"Phone": {
"properties": {
"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"requestBody": {
"content": {

855
Extend Salesforce with Clicks, Not Code External Services

"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}

Example 3: Nested Anonymous Object Schema (OAS 3.0)

Here’s an API spec with a JSON schema with anonymous object types defined inline. The derived phone object type's name is
ExternalService__Bank_getUsers_OUT_200_phones.

Note: For anonymous object types, Salesforce automatically derives object type names. The derived names are based on the
external service, parent operation, operation parameter, parent object, and object property names. Each derived name must be
fewer than 255 characters. For more information, see Schema Definition Support.
{
"openapi": "3.0.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.example.com/v1"
}
],
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {

856
Extend Salesforce with Clicks, Not Code External Services

"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {

857
Extend Salesforce with Clicks, Not Code External Services

"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}

Example 4: Apex Object Class Naming (OAS 3.0)

Here's an API spec registered with the external service name BankingAutomaticTellerMachine. However, the derived object names
must be no longer than 255 characters:
• ExternalService__BankingAutomaticTellerMachine_VeryImportantCustomer_phone
• ExternalService__BankingAutomaticTellerMachine_getBalanceAccountTypeChecking_OUT_200
To use Apex or Flow Builder, you must shorten the external service schema name and the schema (shown in Example 5).

Tip: If the derived object name is longer than 255 characters, try one of the following methods to resolve the issue.
• Shorten the external service name.
• If the object is declared inline under an operation parameter, shorten the operation name by adding an operationId to the
schema.
• If the object is declared inline under a parent object property, shorten the parent object name in the schema.
• Declare the nested object as a top-level object under schema “components/schemas”.

{
"openapi": "3.0.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {

858
Extend Salesforce with Clicks, Not Code External Services

"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/components/schemas/VeryImportantCustomer"
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"VeryImportantCustomer": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}
}

Example 5: Shortening Apex Object Class Names (OAS 3.0)

Here's an example of an API spec with a schema that results in shortened names. It's registered with the shortened name BankAtm.
Shorten the external service schema name to BankAtm, the schema object name to VIP and add operationId as getBalance:

859
Extend Salesforce with Clicks, Not Code External Services

• ExternalService__BankAtm_VIP_phone
• ExternalService__BankAtm_getBalance_200
{
"openapi": "3.0.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"operationId": "getBalance",
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/components/schemas/VIP"
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"VIP": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {

860
Extend Salesforce with Clicks, Not Code External Services

"number": {
"type": "string"
}
}
}
}
}
}
}
}

Example 6: Inline Arrays (OAS 3.0)

Here's an example with an inline array definition.
{
"openapi": "3.0.0",
...
"paths": {
"/employees/{employeeId}": {
"get": {
"operationId": "getEmployee",
"parameters": [
{
"in": "path",
"name": "employeeId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"employee": {
"$ref": "#/components/schemas/Employee"
},
"manager": {
"$ref": "#/components/schemas/Employee"
},
"team": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
}
}
}
}

861
Extend Salesforce with Clicks, Not Code External Services

}
}
}
}
}
}
},
"components": {
"schemas": {
"Employee": {
"type": "object",
"properties": {
"employeeId": {"type": "string"},
"firstName": {"type": "string"},
"middleName": {"type": "string"},
"lastName": {"type": "string"},
"dateOfHire": {"type": "date"}
}
}
}
}
}

Example 7: HTTP Header Parameters (OAS 3.0)

Here’s how a header parameter is declared in an OpenAPI schema. In Apex or Flow, the name “apiKey” shows up as a string parameter.
Now when you set any string value in Apex or a flow to apiKey, it functions as an HTTP parameter when making a callout request.
{
"openapi": "3.0.0",
"info": {
"description": "A service for checking credit for an account.",
"version": "1.0.0",
"title": "Credit Decision",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "https://<YourHostName>"
}
],
"paths": {
"/account/lastCreditRating": {
"get": {
"summary": "Evaluates credit rating and decides what payment terms to offer.",
"description": "",
"parameters": [

862
Extend Salesforce with Clicks, Not Code External Services

{
"name": "apiKey",
"description": "Your API Key for calling the credit rating service",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
}
},
"description": "Specifies input parameters to calculate payment term",
"required": true
},
"responses": {
"200": {
"description": "success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
}
}
},
"405": {
"description": "Invalid input"
}
}
}
}
},
"components": {
"schemas": {
"accountId": {
"type": "object",
"properties": {
"accountIdString": {

863
Extend Salesforce with Clicks, Not Code External Services

"type": "string"
}
},
"xml": {
"name": "accountId"
}
},
"creditRating": {
"type": "object",
"properties": {
"creditRatingString": {
"type": "string"
}
},
"xml": {
"name": "creditRating"
}
}
}
}
}

Example 8: URL Encoded Form Media Type (OAS 3.0)

Request and response form data is declared with media type application/x-www-form-urlencoded.
{
"openapi": "3.0.0",
"info": {
"description": "Apply here for your next mortgage",
"version": "1.0.0",
"title": "My Mortgage Buddy",
"contact": {
"email": "[email protected]"
}
},
"servers": [
{
"url": "https://MyMortgageBuddy.org/mortgages"
}
],
"paths": {
"/apply": {
"post": {
"operationId": "applyMortgage",
"requestBody": {
"content": {
"application/x-www-form-urlencoded; charset=utf-8": {
"schema": {
"type": "object",
"properties": {
"terms": {
"description": "Desired mortgage terms",
"type": "array",

864
Extend Salesforce with Clicks, Not Code External Services

"items": {
"type": "integer"
}
},
"fullName": {
"description": "Full Name",
"type": "string"
},
"loanAmount": {
"description": "Loan amount",
"type": "number"
}
},
"required": [
"terms",
"fullName",
"loanAmount"
]
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/x-www-form-urlencoded; charset=utf-8": {
"schema": {
"type": "object",
"properties": {
"formApplicationId": {
"type": "string"
},
"loanOfficerFullName": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}

Example 9: allOf and additionalProperties Schema Directives (OAS 3.0)

This JSON schema definition highlights the constructs allOf for schema object composition and additionalProperties for
dictionary values. The sample schema is registered as external service MyBank with named credential MyBank.
The schema defines a banking service that gets customer details for a customer ID.

865
Extend Salesforce with Clicks, Not Code External Services

• The Customer schema object has dictionary properties of type schema object CreditRating. In Apex, the class
ExternalService.MyBank_Customer has property properties of type Map<String,
ExternalService_CreditRating> with the customer’s credit ratings.
• Phones and Emails compose their own properties together with the common allOf properties from the schema object
Contact.

{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and additionalProperties",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],
"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"

866
Extend Salesforce with Clicks, Not Code External Services

},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phone"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
}
}
},
"additionalProperties": {
"$ref": "#/components/schemas/CreditRating"
},
"required": [
"id",
"name"
]
},
"Contact": {
"type": "object",
"properties": {
"primary": {
"type": "boolean"
},
"timeOfDay": {
"type": "string"
}
},
"required": [
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}

867
Extend Salesforce with Clicks, Not Code External Services

}
]
},
"Email": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
}
]
},
"CreditRating": {
"type": "object",
"properties": {
"rating": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
}
}
}
}

To use allOf composition and additionalProperties, see For Examples 9: allOf Composition and additionalProperties Use
in Flow with Apex Unit Tests on page 874.

Example 10: allOf and Discriminator Directives (OAS 3.0)

To specify a general extensible list of contacts for a customer, the discriminator directive can be combined with allOf to
declare whether a contact is an email or a phone number:
{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and discriminator",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],

868
Extend Salesforce with Clicks, Not Code External Services

"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
},
"required": [
"id",
"name"
]
},
"Contact": {
"type": "object",

869
Extend Salesforce with Clicks, Not Code External Services

"discriminator": {
"propertyName": "contactType"
},
"properties": {
"contactType": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"timeOfDay": {
"type": "string"
}
},
"required": [
"contactType",
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
}
]
},
"Email": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
}
]
}
}

870
Extend Salesforce with Clicks, Not Code External Services

}
}

To use composition and polymorphic OpenAPI schema constructs, see For Examples 10: Polymorphism with allOf and Discriminator on
page 880.

Example 11: anyOf, oneOf, and Discriminator Directives (OAS 3.0)

anyOf and oneOf directives model types with parts of a common schema type. anyOf and oneOf can be combined with the
schema construct discriminator for polymorphic types.
• Social Security Number
• The driver's license number
• The customer's first and last name with optional middle name
In the example, a customer can be identified by one or more of the following allowed identifiers:
The schema mandates both the customer's first and last name, or to choose any other allowed identification.
This example also highlights a variation of the Contact type polymorphism with oneOf and discriminator from Example 10
with allOf:
{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with oneOf, anyOf and discriminator",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],
"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"

871
Extend Salesforce with Clicks, Not Code External Services

}
}
}
}
}
}
}
},

"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/SSN"
},
{
"$ref": "#/components/schemas/DriversLicense"
},
{
"$ref": "#/components/schemas/FullName"
}
]
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
},
"required": [
"id"
]
},

"SSN": {
“type”: “object”,
“properties”: {
“ssn”: {
“type”: “string”
}
“required”: {
“ssn”
]
},
"DriversLicense": {
“type”: “object”,
“properties”: {
“dl”: {
“type”: “string”

872
Extend Salesforce with Clicks, Not Code External Services

},
“required”: {
“dl”
]
},
"FullName": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
},

"Contact": {
"oneOf": [
{
"$ref": "#/components/schemas/Phone"
},
{
"$ref": "#/components/schemas/Email"
}
],
"discriminator": {
"propertyName": "contactType"
}
},
"Phone": {
"type": "object",
"properties": {
"contactType": {
"type": "string"
},
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
},
"Email": {
"type": "object",
"properties": {

873
Extend Salesforce with Clicks, Not Code External Services

"contactType": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
}
}

To use composition and polymorphic OpenAPI schema constructs, see For Example 11 (Open API 3.0): AnyOf, OneOf, and Discriminator
on page 881.

SEE ALSO:
Schema Examples
Using the Schema Examples

Using the Schema Examples

See how the respective Open API 2.0 and 3.0 examples are implemented with Apex.
EDITIONS

For Examples 9: allOf Composition and additionalProperties Use in Flow with Available in: Lightning
Apex Unit Tests Experience

The External Services registration MyBank from Example 9 (from both OpenAPI 2.0 and 3.0 Available in: Enterprise,
examples) is invoked by a sample flow that accesses the dictionary properties with an Apex invocable Performance, Unlimited,
action. A flow Apex unit test ties it all together. and Developer Editions

public class MyBankGetCreditRatings {

@InvocableMethod(
label='Get Credit Ratings'
description='A list of credit ratings for a customer'
category='MyBank'
)
public static List<CustomerCreditRatings>
getCreditRatings(List<Customer> inCustomers) {

List<CustomerCreditRatings> outCreditRatingsList =
new List<CustomerCreditRatings>();
for (Customer inCustomer: inCustomers) {
ExternalService.MyBank_Customer customer = inCustomer.customer;
CustomerCreditRatings outCreditRatings = new CustomerCreditRatings();
outCreditRatings.customerId = customer.id;
outCreditRatings.creditRatings =
new List<ExternalService.MyBank_CreditRating>();

Map<String, ExternalService.MyBank_CreditRating> creditRatings =

customer.properties;
for (String ratingProperty: creditRatings.keySet()) {

874
Extend Salesforce with Clicks, Not Code External Services

ExternalService.MyBank_CreditRating creditRating =
creditRatings.get(ratingProperty);
outCreditRatings.creditRatings.add(creditRating);
}

outCreditRatingsList.add(outCreditRatings);
}

return outCreditRatingsList;
}

public class Customer {

@InvocableVariable(
label='Customer'
description='Banking customer'
required=true
)
public ExternalService.MyBank_Customer customer;
}

public class CustomerCreditRatings {

@InvocableVariable(
label='Customer ID'
description='Bank customer ID'
required=true
)
public Integer customerId;

@InvocableVariable(
label='Credit Ratings'
description='Credit ratings for a customer'
required=true
)
public List<ExternalService.MyBank_CreditRating> creditRatings;
}
}

The flow starts by calling the external MyBank service action getCustomerById to get the customer details given a customer ID.
The Apex invokable flow action getCreditRatings gets the list of credit ratings from the customer details. Phone and email
contact details are formatted as a list of customer contacts by looping through the phones and emails properties and assigning
the formatted value to the contacts list.

875
Extend Salesforce with Clicks, Not Code External Services

The HTTP callout mock asserts an expected request and responds with a sample customer as application/json:
public class MyBankGetCustomerCalloutMock implements HttpCalloutMock {
public HTTPResponse respond(HTTPRequest request) {
// Assert expected request test data: customer ID in the request path
System.assertEquals('GET', request.getMethod());
System.assertEquals('callout:MyBank/v1/customers/42', request.getEndpoint());

// Send response test data: customer details with sample ratings

// as additional properties and sample contacts
HttpResponse response = new HttpResponse();
response.setHeader('Content-Type', 'application/json');
response.setBody('{' +
'"id": 42, "name": "Foo Bar", "phones": [' +
' {"primary": true, "timeOfDay": "Daytime", ' +
' "typeOfPhone": "Mobile", "phoneNumber": "555-5555"},' +
' {"primary": false, "timeOfDay": "Evening", ' +
' "typeOfPhone": "Landline", "phoneNumber": "222-5555"}' +
'], "emails": [' +
' {"primary": true, "timeOfDay": "AllDay", "email": "[email protected]"}' +
'],' +
'"rating1": {"rating": "Rating 1", "score": 0.95}, ' +
'"rating2": {"rating": "Rating 2", "score": 0.78}' +
'}');
response.setStatusCode(200);
return response;
}
}

Tip: You can also use JSON to serialize a sample response matching the external service response type if the HTTP response media
type is application/json and the JSON properties are compliant with Apex identifier characters:
ExternalService.MyBank_Customer customer = new ExternalService.MyBank_Customer();
customer.id = 42;
...
customer.properties = new Map<String, ExternalService.MyBank_CreditRating>();
ExternalService.MyBank_CreditRating creditRating = new ExternalService.MyBank_CreditRating();
creditRating.rating = 'Rarging 1';

876
Extend Salesforce with Clicks, Not Code External Services

creditRating.score = 0.95;
customer.properties.put('rating1', creditRating);
...
response.setBody(System.JSON.serialize(customer));
....

The Apex unit test sets up the HTTP callout mock and asserts the expected credit ratings and customer contacts:
@IsTest
public class MyBankFlowTest {
@IsTest
static public void testGetCustomer() {
// Set HTTP callout mock to match flow's external service action invocation
Test.setMock(HttpCalloutMock.class, new MyBankGetCustomerCalloutMock());

// Set flow input variables and create the flow interview

Map<String, Object> inputVariables = new Map<String, Object>();
inputVariables.put('customerId', 42);
Flow.Interview myBankFlow = Flow.Interview.createInterview('MyBank', inputVariables);

// Start flow interview with set input variables

myBankFlow.start();

// Assert customer's expected credit ratings

List<ExternalService.MyBank_CreditRating> creditRatings =
(List<ExternalService.MyBank_CreditRating>)myBankFlow.
getVariableValue('creditRatings');
System.assertEquals(2, creditRatings == null ? 0 : creditRatings.size());
ExternalService.MyBank_CreditRating actualRating = creditRatings.get(1);
ExternalService.MyBank_CreditRating expectedRating =
new ExternalService.MyBank_CreditRating();
expectedRating.rating = 'Rating 2';
expectedRating.score = 0.78;
System.assertEquals(expectedRating.toString(), actualRating.toString());

// Assert customer's contacts:

List<String> contacts = (List<String>)myBankFlow.getVariableValue('*contacts*');
System.assertEquals(3, contacts == null ? 0 : contacts.size());
System.assertEquals('Phone Number: 555-5555', contacts.get(0));
System.assertEquals('Phone Number: 222-5555', contacts.get(1));
System.assertEquals('Email: [email protected]', contacts.get(2));
}
}

For another example of a flow Apex unit test, see Testing External Services on page 830.

For Examples 9: allOf Composition and additionalProperties Use in Apex with Apex Unit Tests
The External Services registration MyBank from Example 9 (from both OpenAPI 2.0 and 3.0 examples) is invoked by a sample Apex
class that accesses the dictionary properties. An Apex unit test ties it all together.

877
Extend Salesforce with Clicks, Not Code External Services

The class CustomerCreditRating captures the customer’s detail suitable for further processing. It’s possible to directly use the
external service’s response output data structure. As a good practice, decouple your business relevant data structure from external
dependencies:
public class CustomerCreditRating {
public Integer Id {get; private set;}
public String Name {get; private set;}

private List<String> emails;

private List<String> phoneNumbers;
private Map<String, Integer> ratings;

public CustomerCreditRating(Integer customerId, String name) {

this.Id = customerId;
this.Name = name;
this.emails = new List<String>();
this.phoneNumbers = new List<String>();
this.ratings = new Map<String, Integer>();
}

public void addEmail(String email) {

emails.add(email);
}

public void addPhoneNumber(String phoneNumber) {

this.phoneNumbers.add(phoneNumber);
}

public List<String> getContacts() {

List<String> contacts = new List<String>();
for (String phoneNumber: phoneNumbers) {
contacts.add('Phone Number: ' + phoneNumber);
}
for (String email: emails) {
contacts.add('Email: ' + email);
}
return contacts;
}

public void addRating(String ratingType, Integer ratingScore) {

ratings.put(ratingType, ratingScore);
}

public Set<String> getRatingTypes() {

return ratings.keySet();
}

public Integer getRatingScore(String ratingType) {

return ratings.get(ratingType);
}
}

The Apex class MyBankCustomerCreditRating starts by calling the external MyBank service action getCustomerById
to get the customer details given a customer ID. The Apex method getCreditRating gets the credit rating from the customer

878
Extend Salesforce with Clicks, Not Code External Services

details. Phone and email contact details are formatted as a list of customer contacts by looping through the phones and emails
properties and assigning the formatted value to the contacts list:
public class MyBankCustomerCreditRating {
public class MyBankException extends Exception {}

public CustomerCreditRating getCreditRating(Integer customerId) {

// Get customer credit rating from an external bank rating service
// Construct the external service registration MyBank
ExternalService.MyBank myBank = new ExternalService.MyBank();

// Make the callout to get the customer by ID.

// The response is the customer detail for HTTP code 200
ExternalService.MyBank_Customer customer;
try {
ExternalService.MyBank.getCustomersByCustomerId_Request request =
new ExternalService.MyBank.getCustomersByCustomerId_Request();
request.customerId = customerId;
customer = myBank.getCustomersByCustomerId(request).Code200;
} catch (ExternalService.MyBank.getCustomersByCustomerId_ResponseException e) {
// An HTTP failure code is thrown as exception -
// captured and translated to a meaningful error
throw new MyBankException(
'Credit rating not available for customer ID: '
+ customerId);
}

// Gather the customer name, contacts and credit ratings

// from the callout's response data
CustomerCreditRating customerRating =
new CustomerCreditRating(customerId, customer.name);
for (ExternalService.MyBank_Email email: customer.emails) {
customerRating.addEmail(email.email);
}
for (ExternalService.MyBank_Phone phone: customer.phones) {
customerRating.addPhoneNumber(phone.phoneNumber);
}
for (String ratingType: customer.properties.keySet()) {
ExternalService.MyBank_CreditRating rating =
customer.properties.get(ratingType);
Integer ratingPercent = (Integer)(rating.score * 100.0);
customerRating.addRating(ratingType, ratingPercent);
}

return customerRating;
}
}

You can share the same HTTP mock callout class for your Apex integration. The corresponding Apex unit test class tests the Apex credit
rating logic:
@IsTest
public class MyBankCustomerRatingTest {
@IsTest
static public void testGetCustomerRating() {

879
Extend Salesforce with Clicks, Not Code External Services

// Set HTTP callout mock to match Apex's external service callout

Test.setMock(HttpCalloutMock.class, new MyBankGetCustomerCalloutMock());

// Call the Apex MyBankCustomerRating class

MyBankCustomerCreditRating myBankCreditRating = new MyBankCustomerCreditRating();

CustomerCreditRating creditRating = myBankCreditRating.getCreditRating(42);

// Assert customer's expected credit ratings

System.assertEquals(2, creditRating.getRatingTypes().size());
Integer actualRatingScore = creditRating.getRatingScore('rating2');
Integer expectedRatingScore = 78;
System.assertEquals(expectedRatingScore, actualRatingScore);

// Assert customer's contacts:

List<String> contacts = creditRating.getContacts();
System.assertEquals(3, contacts.size());
System.assertEquals('Phone Number: 555-5555', contacts.get(0));
System.assertEquals('Phone Number: 222-5555', contacts.get(1));
System.assertEquals('Email: [email protected]', contacts.get(2));
}
}

For Examples 10: Polymorphism with allOf and Discriminator

The discriminator directive can be combined with allOf to define the composition's polymorphic type. Polymorphic types
are marked with the suffix _KT_PT in the Apex object name. Work with polymorphic extension types through its polymorphic object
type.
This example illustrates how to interact with polymorphic types in Apex with the OpenAPI spec from Example 10. Contact is the base
type. Phone and Email are polymorphic extension types modeling contact types that can be assigned to a list of contacts for a customer:
// The customer
ExternalService.MyBank_Customer customer = new ExternalService.MyBank_Customer();

// The primary phone contact wrapped as polymorphic type Contact_KT_PT

ExternalService.MyBank_Phone mobile = new ExternalService.MyBank_Phone();
mobile.primary = true;
mobile.typeOfPhone = 'Mobile';
mobile.phoneNumber = '555-5555';
ExternalService.MyBank_Contact_KT_PT cMobile =new ExternalService.MyBank_Contact_KT_PT();
cMobile.phone = mobile; // cMobile is a phone contact

// Customer's secondary home phone contact

ExternalService.MyBank_Phone home = new ExternalService.MyBank_Phone();
home.primary = false;
home.typeOfPhone = 'Home';
home.phoneNumber = '444-4444';
ExternalService.MyBank_Contact_KT_PT cHome = new ExternalService.MyBank_Contact_KT_PT();
cHome.phone = home; // cHome is a phone contact

// Customer's email
ExternalService.MyBank_Email email = new ExternalService.MyBank_Email();
email.primary = true;

880
Extend Salesforce with Clicks, Not Code External Services

email.email = '[email protected]';
ExternalService.MyBank_KT_PT cEmail = new ExternalService.MyBank_Contact_KT_PT();
cEmail.email = email; // cEmail is an email contact

// Adding mobile, home phone and email as contacts to the customer contacts list
customer.contacts = new List<ExternalService.MyBank_Contact_KT_PT>();
customer.contacts.add(cMobile);
customer.contacts.add(cHome);
customer.contacts.add(cEmail);

// Send an email to a customer's primary email contacts

for (ExternalService.MyBank_Contact_KT_PT contact: customer.contacts) {
if (contact.email != null && contact.email.primary) {
String emailAddress = contact.email.email;
// Sending email to email address
...
}
}

For Example 11 (Open API 3.0): AnyOf, OneOf, and Discriminator

oneOf or anyOf define the composition's type - either one of the schema constructs can be used or any of them. Composition
schema types can be accessed through the corresponding composition type's properties as follows:
• A named schema Name referenced as composition schema: anyOfName or oneOfName.
• An inline composition schema object: anyOfObject or oneOfObject. If more than one inline object is declared in the
composition, then the declaration order is added as a sequence number suffix. For example, oneOfObject1, oneOfObject2
for first and second composition type respectively.
• An inline composition schema array: anyOfArray or oneOfArray. If more than one inline array is declared in the composition,
then the declaration order is added as a sequence number suffix. For example oneOfArray1, oneOfArray2.
• An inline composition primitive type: anyOfTypeName or oneOfTypeName. If the same type is referenced in the inline
composition, then like types are suffixed with their declaration order in the spec - for example anyOfString1, anyOfString2.
This example illustrates how to interact with anyOf and oneOf types in Apex with the OpenAPI spec from Example 11. Contact
is the base type. Phone and Email are polymorphic extension types modeling contact types that can be assigned to a list of contacts
for a customer. A customer can be identified by any one of social security number, driver's license or first and last name and optional
middle name:
ExternalService.MyBank_Customer customer = new ExternalService.MyBank_Customer();

// Setting the customer ID

customer.id = new ExternalService.MyBank_Customer_id();
// Setting the social security security number
customer.id.anyOfSSN.ssn = '555-55-5555';
// Setting the customer's first and last name without a middle name
customer.id.anyOfFullName = new ExternalService.MyBank_FullName();
customer.id.anyOfFullName.firstName = 'Somefirstname';
customer.id.anyOfFullName.lastName = 'Somelastname';

// Customer contacts
ExternalService.MyBank_Phone mobile = new ExternalService.MyBank_Phone();
mobile.typeOfPhone = 'Mobile';
mobile.phoneNumber = '555-5555';

881
Extend Salesforce with Clicks, Not Code External Services

ExternalService.MyBank_Contact cMobile = new ExternalService.MyBank_Contact();

cMobile.oneOfPhone = mobile;

ExternalService.MyBank_Phone home = new ExternalService.MyBank_Phone();

home.typeOfPhone = 'Home';
home.phoneNumber = '444-4444';
ExternalService.MyBank_Contact cHome = new ExternalService.MyBank_Contact();
cHome.oneOfPhone = home;

ExternalService.MyBank_Email email = new ExternalService.MyBank_Email();

email.email = '[email protected]';
ExternalService.MyBank_Contact cEmail = new ExternalService.MyBank_Contact();
cEmail.oneOfEmail = email;

customer.contacts = new List<ExternalService.MyBank_Contact>();

customer.contacts.add(cMobile);
customer.contacts.add(cHome);
customer.contacts.add(cEmail);

// Sending the customer's known identities to the customer's email address

String emailContact = null;
for (ExternalService.MyBank_Contact contact: customer.contacts) {
if (contact.oneOfEmail != null) {
emailContact = contact.oneOfEmail.email;
}
}
if (emailContact != null) {
String subject = 'Your identity';
String body = 'These are the identities we\'ve found: \n';
if (customer.id.anyOfSSN != null) {
body += ' - Social Security Number: ' + customer.id.anyOfSSN.ssn + '\n';
}
if (customer.id.anyOfDriversLicense != null) {
body += ' - Driver\'s License: ' + customer.id.anyOfDriversLicense.dl + '\n';
}
if (customer.id.anyOfFullName != null) {
body += ' - First name: ' + customer.id.anyOfFullName.firstName + '\n';
if (customer.id.anyOfFullName.middleName != null) {
body += ' Middle name: ' + customer.id.anyOfFullName.middleName + '\n';
}
body += ' Last name: ' + customer.id.anyOfFullName.lastName + '\n';
}
...
}

SEE ALSO:
External Services OpenAPI 2.0 Schema
External Services OpenAPI 3.0 Schema

882
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Access External Data With Salesforce Connect

Salesforce Connect lets your users view, search, and modify data that’s stored outside your Salesforce org. Instead of copying the data
into standard or custom objects, use external objects to access the data in real time via web service callouts.

Salesforce Connect
Salesforce Connect provides seamless integration of data across system boundaries by letting your users view, search, and modify
data that’s stored outside your Salesforce org. For example, perhaps you have data that’s stored on premises in an enterprise resource
planning (ERP) system. Instead of copying the data into your org, you can use external objects to access the data in real time via web
service callouts.
External Data Sources With Salesforce Connect
Salesforce Connect uses external data sources to access data that's stored outside your Salesforce org. You must configure an external
data source and synchronize it to map its tables with external objects in Salesforce.
Salesforce Platform Features Supported by Salesforce Connect
Salesforce Connect provides seamless integration with the Salesforce Platform and enables users to view, search, and modify external
object data.
Access Data in Another Salesforce Org with the Cross-Org Adapter for Salesforce Connect
Connect your users to data that's stored in another Salesforce org.
Access External Data with OData Adapters for Salesforce Connect
Connect your users to data that's exposed via the Open Data Protocol.
Access External Data with a Custom Adapter for Salesforce Connect
Connect your users to any data anywhere by developing your own custom adapter with the Apex Connector Framework.
Access External Data with the Salesforce Connect Adapter for Amazon DynamoDB
Connect your users to data that's stored in Amazon DynamoDB.
Access External Data with the Salesforce Connect Adapter for Amazon Athena
Provide your users access to Amazon Athena’s capability to analyze data directly in Amazon Simple Storage Service (Amazon S3)
and integrate AWS-hosted data in Salesforce applications.
Access External Data with the Salesforce Connect Adapter for GraphQL
Connect your users to external data sources that expose their capabilities via GraphQL.

883
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce Connect
Salesforce Connect provides seamless integration of data across system boundaries by letting your
EDITIONS
users view, search, and modify data that’s stored outside your Salesforce org. For example, perhaps
you have data that’s stored on premises in an enterprise resource planning (ERP) system. Instead Available in: both Salesforce
of copying the data into your org, you can use external objects to access the data in real time via Classic (not available in all
web service callouts. orgs) and Lightning
Traditionally, we’ve recommended importing or copying data into your Salesforce org to let your Experience (not for
users access that data. For example, extract, transform, and load (ETL) tools can integrate third-party high-data-volume external
systems with Salesforce. However, doing so copies data into your org that you don’t need or that objects)
quickly becomes stale. Available in: Developer
In contrast, Salesforce Connect maps Salesforce external objects to data tables in external systems. Edition
Instead of copying the data into your org, Salesforce Connect accesses the data on demand and in Available for an extra cost
real time. The data is never stale, and we access only what you need. We recommend that you use in: Enterprise, Performance,
Salesforce Connect when: and Unlimited Editions
• You have a large amount of data that you don’t want to copy into your Salesforce org.
• You need small amounts of data at any one time.
• You want real-time access to the latest data.
Even though the data is stored outside your org, Salesforce Connect provides seamless integration with the Lightning Platform. External
objects are available to Salesforce tools, such as global search, lookup relationships, record feeds, and the Salesforce mobile app. External
objects are also available to Apex, SOSL, SOQL queries, Salesforce APIs, and deployment via the Metadata API, change sets, and packages.
For example, you store product order information in a back-office ERP system. You want to view those orders as a related list on each
customer record in your Salesforce org. Salesforce Connect enables you to set up a lookup relationship between the customer object
(parent) and the external object (child) for orders. Then you can set up the page layouts for the parent object to include a related list
that displays child records.
Going a step further, you can update the orders directly from the related list on the customer record. By default, external object records
are read only. But you can define the external data source to enable writable external objects.
For information about using Apex DML write operations on external object records, see the Apex Developer Guide.

Note: If transmitting potentially sensitive information, including sensitive or regulated data such as personal health data or
financial data, Salesforce recommends that customers encrypt their external data sources at rest. Transmissions through the
Salesforce Connect service are already encrypted using mTLS.

Example: This screenshot shows how Salesforce Connect can provide a seamless view of data across system boundaries. A record
detail page for the Business_Partner external object includes two related lists of child objects. The external lookup relationships
and page layouts enable users to view related data from inside and from outside the Salesforce org on a single page.
• Account standard object (1)
• Sales_Order external object (2)

884
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce Connect Adapters

Salesforce Connect uses a protocol-specific adapter to connect to an external system and access its data. When you define an external
data source in your organization, you specify the adapter in the Type field.
Salesforce Connect Adapters Included per Add-On License
Using Salesforce Connect to access external data in an org requires one or more Salesforce Connect add-on licenses.
General Limits for Salesforce Connect
Understand the limits that are applicable to all Salesforce Connect adapters.
Salesforce Connect Learning Map
Follow along the Salesforce Connect learning map to explore all the relevant trails, docs, and reference resources you need to
integrate external data sources into your apps!

SEE ALSO:
External Data Sources With Salesforce Connect
External Object Relationships
Salesforce Platform Features Supported by Salesforce Connect

885
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce Connect Adapters

Salesforce Connect uses a protocol-specific adapter to connect to an external system and access
EDITIONS
its data. When you define an external data source in your organization, you specify the adapter in
the Type field. Available in: both Salesforce
These adapters are available for Salesforce Connect. Classic (not available in all
orgs) and Lightning
Salesforce Description When to Use Experience (not for
Connect high-data-volume external
Adapter objects)

Cross-org Uses the Lightning Platform REST API to To seamlessly connect data between Available in: Developer
access data that’s stored in other your Salesforce orgs. For example, Edition
Salesforce orgs. provide your service representatives a Available for an extra cost
unified view of customer transactions by in: Enterprise, Performance,
integrating data from different Salesforce and Unlimited Editions
orgs.

OData 2.0 Uses Open Data Protocol to access data To integrate external data sources into
OData 4.0 that’s stored outside Salesforce. The your org that support the ODATA
external data must be exposed via OData protocol and publish an OData provider.
OData 4.01 producers. For example, give your account
executives a unified data view by pulling
data from legacy systems such as SAP,
Microsoft, and Oracle in real time.

Custom Uses the Apex Connector Framework to To develop your own adapter with the
adapter develop your own custom adapter when Apex Connector Framework when the
created via the other available adapters aren’t other available adapters aren’t suitable
Apex suitable for your needs. for your needs. For example, when you
A custom adapter can obtain data from want to retrieve data via callouts from a
anywhere. For example, some data can REST API.
be retrieved from anywhere in the
Internet via callouts, while other data can
be manipulated or even generated
programmatically.

Salesforce Connects Amazon DynamoDB data To integrate AWS data natively with
Connect sources to Salesforce through external Salesforce business applications.
Adapter for objects.
Amazon The data stored in Amazon DynamoDB
DynamoDB can leverage the flexible data storage
option of DynamoDB and Salesforce
Platform capabilities.

Salesforce Takes advantage of Amazon Athena’s To integrate AWS data natively with
Connect capability to run queries against data Salesforce and run interactive ad hoc
Adapter for directly in Amazon Simple Storage queries.
Amazon Service (S3) without having to manage
Athena RDBMS infrastructure or ETL tools.

886
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce Description When to Use

Connect
Adapter
Salesforce Uses GraphQL APIs to provide a modern way to integrate To access and integrate data from external sources that
Connect Adapter applications. expose their capabilities via GraphQL.
for GraphQL

SEE ALSO:
Salesforce Connect Adapters Included per Add-On License
Salesforce Platform Features Supported by Salesforce Connect

Salesforce Connect Adapters Included per Add-On License

Using Salesforce Connect to access external data in an org requires one or more Salesforce Connect
EDITIONS
add-on licenses.
Each Salesforce Connect add-on license includes a set number of connections per adapter type. A Available in: both Salesforce
Salesforce Connect add-on license is associated with a single Salesforce org. Classic (not available in all
orgs) and Lightning
Salesforce Connect Adapter Number of Connections per License Experience (not for
high-data-volume external
Cross-org 5 objects)
OData 2.0, OData 4.0, OData 4.01, a custom 1 Available in: Developer
adapter, Salesforce Connect adapter for Amazon Edition
DynamoDB, Salesforce Connect adapter for Available for an extra cost
Amazon Athena, or Salesforce Connect adapter in: Enterprise, Performance,
for GraphQL. and Unlimited Editions

The number of Salesforce Connect add-on licenses you need depends on where the data is stored
and which type of connections are required. Some common data integration scenarios and the number of licenses required:
• Your primary Salesforce org accesses data stored in six other Salesforce orgs. You need two Salesforce Connect add-on licenses. Both
Salesforce Connect add-on licenses are assigned to the primary org.
• Your primary Salesforce org accesses data stored in one secondary Salesforce org. The secondary org accesses the primary org data.
You need two Salesforce Connect add-on licenses, one for each org.
• Your primary Salesforce org accesses data stored in five other Salesforce orgs and one external data source. You need one Salesforce
Connect add-on license, which is assigned to the primary org.

SEE ALSO:
Salesforce Connect Adapters
Salesforce Platform Features Supported by Salesforce Connect

887
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

General Limits for Salesforce Connect

Understand the limits that are applicable to all Salesforce Connect adapters.
EDITIONS
When a Salesforce Connect adapter sends a query for a field value that’s equal to an empty string,
the query is converted to filter for a null value in the external system. Available in: both Salesforce
Classic (not available in all
The assigned user license determines the maximum number of custom objects that each user can
orgs) and Lightning
access. You can also grant object permissions up to that same number of external objects. External
Experience (not for
objects don’t count toward the amount for custom objects.
high-data-volume external
objects)
Maximum external objects per org. 2001
Available in: Developer
If the default value for external objects in your org is 100, create a support
Edition
case to increase your org limit to 200.
Available for an extra cost
Maximum joins per query across external objects and other types of objects. 4 in: Enterprise, Performance,
and Unlimited Editions
Maximum length of the OAuth token that’s issued by the external system. 4,000 characters

Maximum new rows retrieved by SOSL and Salesforce searches per hour. 100,000
This limit doesn’t apply to high-data-volume external data sources.

Maximum new rows retrieved or created per hour. 100,000

This limit doesn’t apply to:
• High-data-volume external data sources
• Rows that are retrieved only as search results and aren’t opened or edited
• Other rows that have already been retrieved

Maximum page size for server-driven paging. 2,000 rows

1
The amount of 200 external objects applies regardless of how many Salesforce Connect add-ons you purchase for your org. External
objects don’t count toward the amount for custom objects.

Callout Limits for Salesforce Connect Adapters

Salesforce Connect accesses the external data in real time via Web service callouts to external data sources.
• Cross-org adapter: No callout limits. However, each callout counts toward the API usage limits of the provider org. See API Request
Limits and Allocations.
• OData 2.0 and OData 4.0 adapter
– 20,000 OData callouts per hour for Enterprise, Performance, and Unlimited editions. If you require higher limits, create a support
case.
– 1,000 OData callouts per hour for Developer Edition.

• OData 4.01 adapter: No callout limits.

• Custom adapter: See Callout Limits and Limitations and Execution Governors and Limits in the Apex Developer Guide.
• Salesforce Connect adapter for Amazon DynamoDB and for Amazon Athena: No callout limits. However, each callout counts towards
charges applied by AWS for related resource usage.

888
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

• Salesforce Connect adapter for GraphQL: No callout limits. However, callouts may incur charges from the hosting provider of the
external data source.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect

Salesforce Connect Learning Map

Follow along the Salesforce Connect learning map to explore all the relevant trails, docs, and reference resources you need to integrate
external data sources into your apps!
The learning map guides you through every step of your journey.
• Get Started: Get a 360-degree view of your customer data within Salesforce using Salesforce Connect and experience integration
of data across system boundaries.
• Configure & Connect: Connect to any database and give users of Salesforce applications seamless access to handle the data stored
in external data sources.
• Integrate & Build: Integrate with external systems to build a single view of customer data and give that data native platform ability
inside Salesforce.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect

External Data Sources With Salesforce Connect

Salesforce Connect uses external data sources to access data that's stored outside your Salesforce
EDITIONS
org. You must configure an external data source and synchronize it to map its tables with external
objects in Salesforce. Available in: both Salesforce
Classic (not available in all
Identity Type for External Data Sources orgs) and Lightning
On the external data source configured for Salesforce Connect, the Identity Type field Experience (not for
high-data-volume external
specifies whether your organization uses one set or multiple sets of credentials to access the
objects)
external system. Each set of credentials corresponds to a login account on the external system.
Sync an External Data Source for Salesforce Connect Available in: Developer
Edition
When you validate and sync an external data source, it creates or overwrites Salesforce external
objects that map to the external system’s schema. Syncing doesn’t copy any data into your Available for an extra cost
Salesforce org or write data from your org to the external system. in: Enterprise, Performance,
and Unlimited Editions
External Objects in Salesforce Connect
External objects behave similar to custom objects except that they map to data stored outside
Salesforce in an external data source. Each external object maps to a data table, and the object
fields map to accessible table columns.
Record IDs for Salesforce Connect External Objects
The first time a data row is retrieved from an external system, the external object record is assigned a Salesforce ID. Each record ID
remains associated with the same external data row, unless the external object is deleted from the org.

889
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Writable External Objects in Salesforce Connect

Select Writable External Objects when you define an external data source and use Salesforce Connect external objects to create,
update, and delete data. External objects are read only by default.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
Work with External Data Sources

Identity Type for External Data Sources

On the external data source configured for Salesforce Connect, the Identity Type field
EDITIONS
specifies whether your organization uses one set or multiple sets of credentials to access the external
system. Each set of credentials corresponds to a login account on the external system. Available in: both Salesforce
If you select Named Principal, your organization uses only one login account on the external Classic (not available in all
system. orgs) and Lightning
Experience (not for
If you select Per User, your organization uses multiple login accounts on the external system. Each
high-data-volume external
of your users can have a unique set of credentials, or you can group your users—for example, by objects)
function or business unit—and have each group share a set of credentials. After you grant user
access to the external data source through permission sets or profiles, users can set up and manage Available in: Developer
their own authentication settings for the external system. Edition
Available for an extra cost
Note: For an external data source with Per User Identity Type, site members in
in: Enterprise, Performance,
Experience Cloud can’t set up their own credentials. However, as an admin you can set up
and Unlimited Editions
and manage each user’s authentication settings for external systems from Lightning Experience
or Salesforce Classic.

To access the external system’s... The system uses the credentials that are defined in the...
Data External data source definition User’s personal authentication settings for
(search or view external objects) the external system

Metadata External data source definition External data source definition

(sync to create external objects)

890
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Tip: Train your users on how to set up their authentication settings for external systems. Make sure that they know which credentials
to enter for each external system. If you’re using OAuth 2.0, test the OAuth flow for potentially confusing prompts or redirects, and
train your users as needed. OAuth flows vary, depending on your external system, authentication provider, and specified scopes.

SEE ALSO:
Define an External Data Source for Salesforce Connect—Cross-Org Adapter
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Define an External Data Source for Salesforce Connect—Custom Adapter
Grant Access to Authentication Settings for External Data Sources
Store Authentication Settings for External Systems

Sync an External Data Source for Salesforce Connect

When you validate and sync an external data source, it creates or overwrites Salesforce external
EDITIONS
objects that map to the external system’s schema. Syncing doesn’t copy any data into your Salesforce
org or write data from your org to the external system. Available in: both Salesforce
Syncing fails if it causes your org to exceed 200 external objects. Syncing also fails if it tries to create Classic (not available in all
an external object with an API name that conflicts with an existing object in the org. In such cases, orgs) and Lightning
determine whether the existing object is needed. Experience (not for
high-data-volume external
• If the object isn’t needed, delete that object, and sync again. objects)
• If the object is needed, change the API name of the existing object to no longer conflict with
the table that you're trying to sync. However, if the existing object is an external object that Available in: Developer
Edition
was previously synced, you can’t resync it. Manually update the external object and its fields as
needed for schema changes on the external system. Available for an extra cost
in: Enterprise, Performance,
Tip: We recommend that you create your external data sources and external objects in a and Unlimited Editions
Developer Edition org. Then use managed packages to deploy the external data sources and
external objects to your other orgs. Doing so prevents your external object names from
conflicting with other objects in your org by applying a namespace prefix.
When an external object is created via syncing, its Deployment Status is set to In Development. When you’re ready to expose the external
object to users, set the status to Deployed.
If the external system’s schema changes, the modifications aren’t automatically synced to your Salesforce org. To reflect the changes in
the external system, resync the objects. After resyncing, all users who have the same profile as the user who initiated the resync are
granted field-level access to the external objects. When you resync an external object:
• The Display URL Reference Field is set to None.
• If a custom field has the Is Name Field attribute, the attribute is removed. The External ID standard field is used as the name field of
the external object.
• The Deployment Status doesn’t change.

891
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

To understand how syncing affects relationship fields on external objects, see Relationships on External Objects.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
Deployment Status for Custom Objects and External Objects
Validate and Sync an External Data Source

External Objects in Salesforce Connect

External objects behave similar to custom objects except that they map to data stored outside
EDITIONS
Salesforce in an external data source. Each external object maps to a data table, and the object
fields map to accessible table columns. Available in: both Salesforce
As with custom objects, you must create custom tabs to display external object data in Salesforce. Classic (not available in all
When you add a custom tab to an app in Salesforce Classic, it appears as a tab. When you add a orgs) and Lightning
custom tab to an app in Lightning Experience, it appears as an item in the app’s navigation bar and Experience (not for
in the App Launcher. See Create a Custom Object Tab. high-data-volume external
objects)
To know the field types that you can create for external objects, see Custom Field Types. Some
special behavior for text and number fields on external objects. Available in: Developer
Edition
• Text fields: Ensure that the field length matches the length of the associated field on the external
object to avoid any display or edit issues. Available for an extra cost
in: Enterprise, Performance,
• Number fields: Ensure that the specified length can contain all digits to the left of the decimal
and Unlimited Editions
point in external values. If the numeric value from an external system doesn’t fit within the
length of the associated number field on the external object, the value is blank in your Salesforce
org. If you notice blank numeric field values, adjust Length and Decimal Places for
the number field on the external object to accommodate more digits to the left of the decimal point. If the digits to the right of the
decimal point in the external values don’t fit within the specified decimal places, the value is truncated.
When a custom field on an external object record is displayed, leading, and trailing spaces are removed from the field value. Keep this
behavior in mind when you filter by a field that contains leading or trailing spaces. For example, include the leading and trailing spaces
in the following SOQL query to match the values that are stored in the external system. However, the spaces aren’t displayed in the
query results.
SELECT FirstName__c FROM Buyers__x WHERE FirstName__c = ' Test '

Note: Formulas and Roll-up Summary fields can’t reference fields on external objects.

Features Not Supported

• Set up Data with External Objects
– Merge Fields
– Schema Builder
– Validation Rules
– Custom fields
• Field types not supported
– Auto-Number (available only with the cross-org adapter for Salesforce Connect)

892
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

– Currency (available only with the cross-org adapter for Salesforce Connect)
– Formula
– Geolocation
– Master-Detail Relationship
– Picklist and Picklist (Multi-select) (available only with the cross-org adapter for Salesforce Connect)
– Roll-up Summary
– Text (Encrypted)
– Text Area (Rich)

• Lookup filter on relationship fields

• Default field values

• Record-level security to manage data access for external objects

• Record types to customize external data
• Productivity Tools
– Activities, Events, and Tasks
– Attachments
– Files (only for cross-org adapter)
– Notes

To understand specific behavior and limitations, refer to considerations that apply to the corresponding Salesforce Connect adapter.

SEE ALSO:
External Object Relationships
Considerations for Object Relationships
External Data Sources With Salesforce Connect
Manage Custom Objects

Record IDs for Salesforce Connect External Objects

The first time a data row is retrieved from an external system, the external object record is assigned
EDITIONS
a Salesforce ID. Each record ID remains associated with the same external data row, unless the
external object is deleted from the org. Available in: both Salesforce
Note: Salesforce IDs aren’t assigned to external object records that are associated with Classic (not available in all
orgs) and Lightning
high-data-volume external data sources.
Experience

SEE ALSO: Available in: Developer

Edition
Salesforce Connect
Available for an extra cost
External Data Sources With Salesforce Connect
in: Enterprise, Performance,
Record IDs and External IDs for External Objects in Salesforce Connect—Cross-Org Adapter and Unlimited Editions

893
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Writable External Objects in Salesforce Connect

Select Writable External Objects when you define an external data source and use Salesforce
EDITIONS
Connect external objects to create, update, and delete data. External objects are read only by default.

Note: For external data sources of Amazon Athena type, writable external objects aren’t Available in: both Salesforce
supported. Classic (not available in all
orgs) and Lightning
External systems execute write operations initiated from Salesforce and also handle write conflicts, Experience (not for
if any. high-data-volume external
• It can take some time for changes to external object records to take effect. If you don’t see objects)
recent changes when you view or query an external object record, try again later. Available in: Developer
• It can’t be guaranteed that all write operations that are initiated from Salesforce are applied in Edition
case of write conflicts. Available for an extra cost
If Salesforce attempts to save changes to an external object and a standard or custom object in the in: Enterprise, Performance,
same transaction, an error occurs. As a best practice, we recommend you use a separate transaction and Unlimited Editions
to access or modify data in an external system.
Write operations on external object records initiated from different contexts can occur in varying
order. When you create, update, or delete external object records via the user interface, processes or flows, operations occur synchronously.
When Apex is used to perform external records operations, operations occur asynchronously and an active background queue minimizes
potential save conflicts. To monitor an asynchronous job progress, use BackgroundOperation.

Note: When a custom field on an external object record is edited, leading and trailing spaces are removed from the field value.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
External Data Sources With Salesforce Connect
Apex Developer Guide: Writable External Objects

Salesforce Platform Features Supported by Salesforce Connect

Salesforce Connect provides seamless integration with the Salesforce Platform and enables users
EDITIONS
to view, search, and modify external object data.
Review the considerations for each Salesforce Connect adapter that you use to know more about Available in: both Salesforce
Salesforce Platform feature support. Classic (not available in all
orgs) and Lightning
Experience (not for
Reports
high-data-volume external
Depending on network latency and the availability of the external system, reports that include objects)
an external object can take a long time to run.
Available in: Developer
Record Feed Edition
View the Chatter feed associated with external object records you follow to see updates about
Available for an extra cost
the record. Following records helps keep you up to date on important changes to the external
in: Enterprise, Performance,
objects.
and Unlimited Editions

894
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Quick Actions
External objects support quick actions, except when the actions involve features or functionality that are incompatible with external
objects.
Flows and Processes
You can build flows and processes that include external objects and automate your organization’s repetitive business tasks.
Salesforce App
You can view and search external objects from the Salesforce mobile app, Salesforce on the go!
Salesforce Console
You can access external objects from the Salesforce console only in Salesforce Classic. Other consoles, such as the Salesforce console
in Lightning Experience, aren’t supported.
More Features Supported by Salesforce Connect
External objects are available to Salesforce APIs, SOQL queries, SOSL and Salesforce searches, packages, Metadata API, change sets,
and Lightning Experience app.

SEE ALSO:
Salesforce Connect
External Data Sources With Salesforce Connect

Reports
Depending on network latency and the availability of the external system, reports that include an
EDITIONS
external object can take a long time to run.
When you run a report that includes external objects, your org performs a request callout for each Available in: both Salesforce
external object in the report. And if it’s a joined report, your org performs separate request callouts Classic (not available in all
for each block. If the URL of a report callout approaches or exceeds 2 KB, the request is split into orgs) and Lightning
multiple HTTP calls, with each URL being less than 2 KB. Experience (not for
high-data-volume external
A report that includes an external object fetches up to 20,000 records for the primary object. If the objects)
report is customized to include child objects, the total number of rows can be greater or less than
10,000, depending on how many child records are fetched. To obtain more relevant external object Available in: Developer
rows, try customizing the report. Edition

For custom reports that include external objects as the primary object: Available for an extra cost
in: Enterprise, Performance,
• If the deployment status of the external object changes, custom report type’s Deployment and Unlimited Editions
Status changes similarly from Deployed to In Development. See Deployment Status
for Custom Objects and External Objects.
• If the external object is deleted, custom report type and reports created from it are deleted.
For large external data sources, report callouts typically access only a subset of the external data. If the report includes summary fields
and formulas, those aggregate values likely reflect only a subset of your data. To improve the accuracy of the aggregate values and
obtain more relevant data, try customizing the report.
As is true for all callouts for external objects, report callouts are limited by the Salesforce Connect adapters in use.
• Cross-org adapter: No callout limits. However, each callout counts toward the API usage limits of the provider org. See API Request
Limits and Allocations.
• OData 2.0 and OData 4.0 adapter

895
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

– 20,000 OData callouts per hour for Enterprise, Performance, and Unlimited editions. If you require higher limits, create a support
case.
– 1,000 OData callouts per hour for Developer Edition.

• OData 4.01 adapter: No callout limits.

• Custom adapter: See Callout Limits and Limitations and Execution Governors and Limits in the Apex Developer Guide.

Features Not Supported

• Converted currency fields
• Cross filters
• Buckets and bucket fields
• Historical trend reporting

SEE ALSO:
Reports and Dashboards Limits, Limitations, and Allocations
Troubleshoot Reports
External Object Relationships
Salesforce Platform Features Supported by Salesforce Connect

Record Feed
View the Chatter feed associated with external object records you follow to see updates about the
EDITIONS
record. Following records helps keep you up to date on important changes to the external objects.
Available in: both Salesforce
Features Not Supported Classic (not available in all
orgs) and Lightning
• Field history tracking. Experience (not for
• External objects that map to high-data-volume external data sources. high-data-volume external
objects)
SEE ALSO: Available in: Developer
Records and List Views Edition
Salesforce Connect Available for an extra cost
in: Enterprise, Performance,
Salesforce Platform Features Supported by Salesforce Connect
and Unlimited Editions

896
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Quick Actions
External objects support quick actions, except when the actions involve features or functionality
EDITIONS
that are incompatible with external objects.
With custom quick actions, you can make your users’ navigation and workflow as smooth as possible Available in: both Salesforce
by giving them convenient access to information that’s most important. For example, you can let Classic (not available in all
users quickly create or update records, send emails, and more in the context of the external object. orgs) and Lightning
Experience (not for
high-data-volume external
Features Not Supported objects)
• Log a Call action: Creating tasks isn’t available for external objects.
Available in: Developer
• Predefined Field Values for Quick Action Fields: Formulas can’t reference external object fields. Edition
Available for an extra cost
SEE ALSO: in: Enterprise, Performance,
Action Types and Unlimited Editions

Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect

Flows and Processes

You can build flows and processes that include external objects and automate your organization’s
EDITIONS
repetitive business tasks.
If a flow or a process accesses standard or custom objects along with external objects, you must Available in: both Salesforce
commit the changes to the standard or custom object before accessing the external objects. We Classic (not available in all
recommend using a separate transaction to access data from the external system. orgs) and Lightning
Experience (not for
• In Flow Builder, add a screen, local action, or Pause element that pauses until a flow-based time
high-data-volume external
occurs. See Flow Elements. objects)
• In Process Builder, add a scheduled action. See Add Actions to Your Process.
Available in: Developer
To understand how processes interact with external objects, see Compatibility Considerations for Edition
Processes.
Available for an extra cost
To know the limits while building flows with external objects, see External Object Considerations in: Enterprise, Performance,
for Flows. and Unlimited Editions

Features Not Supported

These automation tool features aren’t available for external objects in Salesforce Connect.
• Approval Processes
• Workflow Rules

SEE ALSO:
Flow Builder Tour
Process Builder
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect

897
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce App
You can view and search external objects from the Salesforce mobile app, Salesforce on the go!
EDITIONS
As with custom objects, external objects must be assigned to tabs that users can access, and object
permissions must be granted via profiles or permission sets. When you search for an external object, Available in: both Salesforce
click More in the Recent section to view the search results. Classic (not available in all
orgs) and Lightning
When external objects are used with Salesforce for iOS and Salesforce mobile web on iOS devices,
Experience (not for
you must select Enable Search in the associated external data sources. Only then external objects
high-data-volume external
appear in these apps. This requirement doesn’t apply to custom adapters for Salesforce Connect. objects)

Available in: Developer

SEE ALSO:
Edition
Salesforce Mobile App
Available for an extra cost
Salesforce Connect in: Enterprise, Performance,
Salesforce Platform Features Supported by Salesforce Connect and Unlimited Editions

Salesforce Console
You can access external objects from the Salesforce console only in Salesforce Classic. Other consoles,
EDITIONS
such as the Salesforce console in Lightning Experience, aren’t supported.
External objects haven’t been fully adapted to a console and can cause unexpected behaviors. Available in: both Salesforce
Unlike other objects that haven’t been fully adapted to a console, external objects aren’t marked Classic (not available in all
with asterisks in the console setup area. orgs) and Lightning
Experience (not for
high-data-volume external
SEE ALSO: objects)
Salesforce Console in Salesforce Classic
Available in: Developer
Salesforce Classic Console Limitations Edition
Salesforce Connect
Available for an extra cost
Salesforce Platform Features Supported by Salesforce Connect in: Enterprise, Performance,
and Unlimited Editions

More Features Supported by Salesforce Connect

External objects are available to Salesforce APIs, SOQL queries, SOSL and Salesforce searches,
EDITIONS
packages, Metadata API, change sets, and Lightning Experience app.
Available in: both Salesforce
API Query Classic (not available in all
orgs) and Lightning
• To know how Salesforce Connect accesses the external data in real time via Web service callouts, Experience (not for
see query(), queryAll(), and queryMore(). high-data-volume external
• To understand the limitations that apply to queryAll() and queryMore() calls on objects)
external data, see External Objects in the SOAP API Developer Guide.
Available in: Developer
• To implement server-driven or client-driven paging for external object data that’s obtained by Edition
a custom adapter, see Paging with the Apex Connector Framework.
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

898
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

SOQL
• To know about the specific limits SOQL applies to external objects, see External objects in SOQL Limits on Objects.
• To understand the limitations for external objects when you design SOQL relationship queries, see Understanding Relationship Query
Limitations.

SOSL and Salesforce Searches

• To know about the specific limits SOSL applies to external objects in search results, see SOSL Limits on External Object Search Results.
• To learn about how to add RETURNING clause to a SOSL query with external objects, see RETURNING FieldSpec.
• To understand how search works with external objects, look for external objects in Searchable Fields by Object in Lightning Experience
and Searchable Fields by Object in Salesforce Classic.
• (Salesforce Classic only) Search results for external object display only the top 25 rows.

Packaging
• To understand how packaging affects external data sources and external objects, see Special Behavior of Components in Packages.
• To know what components are automatically included in the package when you add external data sources and external objects,
see Components Automatically Added to Packages.
• To learn about the behavior of external data sources and external objects with permission sets or profile settings, see About Permission
Sets and Profile Settings.

Deployment via the Metadata API

In Metadata API, external objects are represented as CustomObject.

Change Sets
External objects are included in the Custom Object component.

Lightning Experience App

When you access external objects from the Lightning Experience app, the associated external data sources must have the High Data
Volume option deselected. This requirement doesn’t apply to the cross-org adapter for Salesforce Connect.

SEE ALSO:
Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
Writable External Objects in Salesforce Connect

Access Data in Another Salesforce Org with the Cross-Org Adapter for Salesforce
Connect
Connect your users to data that's stored in another Salesforce org.

899
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Cross-Org Adapter for Salesforce Connect

Collaborate more effectively and improve processes by connecting the data across your Salesforce orgs. With the cross-org adapter,
Salesforce Connect uses Lightning Platform REST API calls to access records in other Salesforce orgs. Nevertheless, setup is quick and
easy with point-and-click tools.
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter
Provide users with seamless access to data in your other Salesforce orgs so that they have a complete view of the business. Setting
up the cross-org adapter for Salesforce Connect is quick and easy with point-and-click tools.
Considerations for Salesforce Connect—Cross-Org Adapter
Understand the special behaviors, limits, and recommendations for using the cross-org adapter for Salesforce Connect.

Cross-Org Adapter for Salesforce Connect

Collaborate more effectively and improve processes by connecting the data across your Salesforce
EDITIONS
orgs. With the cross-org adapter, Salesforce Connect uses Lightning Platform REST API calls to access
records in other Salesforce orgs. Nevertheless, setup is quick and easy with point-and-click tools. Available in: both Salesforce
Your users and the Lightning Platform interact with other orgs’ data via external objects. The Classic (not available in all
cross-org adapter for Salesforce Connect converts each of those interactions into a Lightning orgs) and Lightning
Platform REST API call. Experience (not for
high-data-volume external
Suppose that you store your inventory of products in one Salesforce org. You want your regional objects)
and local branch offices, who have their own orgs, to see the latest information about your stock.
With the cross-org adapter for Salesforce Connect, those other organizations can easily access your Available in: Developer
data while respecting access restrictions that you control. Edition

The cross-org adapter makes a Lightning Platform REST API call each time that: Available for an extra cost
in: Enterprise, Performance,
• A user clicks an external object tab for a list view. and Unlimited Editions
• A user views a record detail page of an external object.
• A user views a record detail page of a parent object that displays a related list of child external
object records.
• A user performs a Salesforce global search.
• A user creates, edits, or deletes an external object record.
• A user runs a report.
• The preview loads in the report builder.
• An external object is accessed via flows, processes, APIs, Apex, SOQL, or SOSL.
• You validate or sync an external data source.
To set up Salesforce Connect with the cross-org adapter, you use only point-and-click tools.

Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter

The provider org stores the data that the subscriber org accesses.
API Names for External Objects and Custom Fields in Salesforce Connect—Cross-Org Adapter
If external objects and custom fields are created in the subscriber org via syncing, their API names are derived from the corresponding
API names in the provider org.
Record IDs and External IDs for External Objects in Salesforce Connect—Cross-Org Adapter
External object record IDs are derived from the corresponding record IDs in the provider organization. External ID values in external
object records match the record IDs in the provider organization.

900
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

User Access to External Data in Salesforce Connect—Cross-Org Adapter

A user’s access to external data is determined by settings on both subscriber and provider orgs.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter
Considerations for Salesforce Connect—Cross-Org Adapter

Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter

The provider org stores the data that the subscriber org accesses.
EDITIONS
You define the external data source and external objects in the subscriber org. Manually create the
external objects and their fields, or automatically create them by syncing the provider org’s metadata. Available in: both Salesforce
When users view or search those external objects in the subscriber org, the data is obtained from Classic (not available in all
the provider org and displayed in the subscriber org. When users create or edit external object orgs) and Lightning
records in the subscriber org, the data is saved in the provider org. Experience (not for
high-data-volume external
• An org can serve as both a subscriber and a provider. objects)
• A subscriber org can access data from multiple provider orgs.
Available in: Developer
• A provider org can let multiple subscriber orgs access its data. Edition
Available for an extra cost
SEE ALSO: in: Enterprise, Performance,
Cross-Org Adapter for Salesforce Connect and Unlimited Editions

API Names for External Objects and Custom Fields in Salesforce Connect—Cross-Org Adapter
If external objects and custom fields are created in the subscriber org via syncing, their API names
EDITIONS
are derived from the corresponding API names in the provider org.
Each external object’s API name ends with __x. Custom fields on external objects use the traditional Available in: both Salesforce
__c suffix in the API name. Specifically for objects and custom fields that are synced with the Classic (not available in all
cross-org adapter for Salesforce Connect: orgs) and Lightning
Experience
• For an API name with no suffix in the provider org, the API name is reused in the subscriber org,
but with an applied __x suffix for an object or __c suffix for a field. Available in: Developer
• For an API name with a suffix in the provider org, the API name is reused in the subscriber org. Edition
But one of the underscores (_) from the original suffix is removed, and a new __x or __c Available for an extra cost
suffix is applied. in: Enterprise, Performance,
and Unlimited Editions
Example: If you sync the provider org’s Account object, the subscriber org creates:
• An external object with the API name Account__x
• Custom fields including one with the API name Account__x.Name__c
If you sync the provider org’s CustObj__c object, the subscriber org creates:
• An external object with the API name CustObj_c__x
• Custom fields including one with the API name CustObj_c__x.Name__c
If the provider org’s object has a custom field, the subscriber org creates the custom field on
the equivalent external object, for example:

901
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

• Account__x.MyCustField_c__c
• CustObj_c__x.MyOtherCustField_c__c
If you sync the provider org’s Account__x external object, the subscriber org creates:
• An external object with the API name Account_x__x
• Custom fields including one with API name Account_x__x.Name_c__c

SEE ALSO:
Cross-Org Adapter for Salesforce Connect

Record IDs and External IDs for External Objects in Salesforce Connect—Cross-Org Adapter
External object record IDs are derived from the corresponding record IDs in the provider organization.
EDITIONS
External ID values in external object records match the record IDs in the provider organization.
Each object in Salesforce has an object ID with a key prefix as the first three characters. When an Available in: both Salesforce
external object is created, it’s assigned a unique key prefix. Classic and Lightning
Experience
Each external object record has a record ID that uses the same key prefix as the external object ID.
The rest of the external object record ID matches the original record ID that’s in the provider Available in: Developer
organization, excluding its original key prefix. Edition
Each record ID that comes from the provider organization becomes a case-insensitive 18-character Available for an extra cost
alphanumeric string in the subscriber organization. in: Enterprise, Performance,
and Unlimited Editions
The original record ID is available in the subscriber organization as the value of the External ID
standard field on the external object record.
Each external object has an External ID standard field. Its values uniquely identify each
external object record in your org. When the external object is the parent in an external lookup relationship, the External ID standard
field is used to identify the child records.

Example: You sync the provider organization’s Account object, and the subscriber organization’s Account__x object is
assigned the key prefix x00. An account in the provider organization with the ID 001B0000003SVC7IAO appears in the subscriber
organization with the ID x00B0000003SVC7IAO and the external ID 001B0000003SVC7IAO.

SEE ALSO:
Cross-Org Adapter for Salesforce Connect

902
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

User Access to External Data in Salesforce Connect—Cross-Org Adapter

A user’s access to external data is determined by settings on both subscriber and provider orgs.
EDITIONS
The credentials that are used by the subscriber org to connect to the provider org are associated
with a user in the provider org. We refer to this user as the connected user. Available in: both Salesforce
Classic (not available in all
A user in the subscriber org can access only data that the connected user can access within the
orgs) and Lightning
provider org. In other words, the subscriber org’s user access respects the connected user’s access
Experience (not for
restrictions, which are determined by these settings in the provider org.
high-data-volume external
• Object-level security—permission sets and profiles objects)
• Field-level security—permission sets and profiles Available in: Developer
• Record-level security—organization-wide sharing settings, role hierarchies, and sharing rules Edition
In the subscriber org, grant users access to external objects via permission sets and profiles. Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions
SEE ALSO:
Cross-Org Adapter for Salesforce Connect
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter

Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter
USER PERMISSIONS EDITIONS

To create and edit external data sources: Customize Application Available in: both Salesforce
Classic and Lightning
To create and edit external objects: Customize Application
Experience
To define or change object-level help: Customize Application
Available in: Developer
To create and edit custom fields: Customize Application Edition
Available for an extra cost
To edit permission sets and user profiles: Manage Profiles and Permission Sets
in: Enterprise, Performance,
To edit another user’s authentication settings Manage Users and Unlimited Editions
for external systems:

Provide users with seamless access to data in your other Salesforce orgs so that they have a complete view of the business. Setting up
the cross-org adapter for Salesforce Connect is quick and easy with point-and-click tools.
Setting up Salesforce Connect with the cross-org adapter involves these high-level steps.
1. Define an external data source of type Salesforce Connect: Cross-Org.
Create an external data source for each provider org.

2. Create the external objects.

Perform this task only if you don’t sync to automatically create the external objects. In the subscriber org, create an external object
for each object in the provider org that you want to access.

3. Create help content for the external objects.

Help your users distinguish between external objects and the other objects in the subscriber org, which can have similar names and
types of data. On the subscriber org, create Visualforce pages to describe the external objects. When your users click Help for this
Page on an external object, they read your custom help content.

903
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

4. Add custom fields and relationships to the external objects.

Create relationships between objects. If you didn’t sync to automatically create the external objects and their fields on the subscriber
org, create a custom field for each of the provider org’s fields that you want to access.

5. Enable user access to external objects.

Grant object permissions through permission sets or profiles.

6. Enable user access to the fields on the external objects.

Grant field permissions through permission sets or profiles.

7. If the external data source uses per-user authentication:

a. Let users authenticate to the external system.
Grant users access to authentication settings for the external data source through permission sets or profiles.

b. Set up each user’s authentication settings.

You or your users can perform this task.

Tip: Train your users on how to set up their authentication settings for external systems. Make sure that they know which
credentials to enter for the provider org. If you’re using OAuth 2.0, the OAuth flow displays the Salesforce login page twice:
first to log in to the provider org to obtain an access token, and then to log back in to the subscriber org. Test the OAuth
flow for potentially confusing prompts or redirects, and train your users as needed. OAuth flows vary, depending on your
external system, authentication provider, and specified scopes.

SEE ALSO:
Cross-Org Adapter for Salesforce Connect
Considerations for Salesforce Connect—Cross-Org Adapter
Developer Guide: Visualforce Developer Guide
External Object Relationships
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter

904
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define an External Data Source for Salesforce Connect—Cross-Org Adapter

Give your users seamless access to data across your Salesforce orgs.
EDITIONS
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources. Available in: both Salesforce
Classic and Lightning
2. Click New External Data Source, or click Edit to modify an existing external data source.
Experience
3. Complete the fields.
Available in: Developer
Edition
Field Description
Available for an extra cost
Label A user-friendly name for the external data source. The label is displayed in: Enterprise, Performance,
in the Salesforce user interface, such as in list views. and Unlimited Editions
If you set Identity Type to Per User, this label appears when
your users view or edit their authentication settings for external
systems. USER PERMISSIONS

To create and edit external

Name A unique identifier that’s used to refer to this external data source
data sources:
definition through the API.
• Customize Application
The name 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.

Type Select Salesforce Connect: Cross-Org.

Connect to Determines which URL is used to connect to the provider org.

URL If you selected Connect to Custom URL, enter the login URL for
the provider org.

API Version Select an API version that the provider org supports. The API version
determines which of the provider org’s objects, fields, and types you
can access from the subscriber org.

Connection Number of seconds to wait for a response from the provider org before
Timeout timing out. By default, the value is set to the maximum of 120 seconds.

Writable Lets the Lightning platform and users in this org create, update, and
External delete records for external objects associated with the external data
Objects source. The external object data is stored outside the org. By default,
external objects are read only.

Enable Search Determines whether global searches in the subscriber org also search
the external objects’ data, which is stored in the provider org.
When selected, you can control which external objects are searchable
by selecting or deselecting Allow Search on each external object.
Only text, text area, and long text area fields on external objects can
be searched. If an external object has no searchable fields, searches
on that object return no records.

905
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Identity Type Determines whether the subscriber org uses one set or multiple sets of credentials to access the
provider org. See Identity Type for External Data Sources.

4. Select the authentication protocol.

• If you select Password Authentication, enter the username and password for accessing the external system.
• If you select OAuth 2.0, complete the following fields.

Field Description
Authentication Select a Salesforce authentication provider. See “Configure a Salesforce Authentication Provider”
Provider in the Salesforce Help.

Note: On a production org, an external data source can’t use an authentication provider
that directs authorization or token requests to a sandbox org. Similarly, on a sandbox
org, an external data source can’t use an authentication provider that directs
authorization or token requests to a production org.

Scope Specifies the scope of permissions to request for the access token. Your authentication provider
determines the allowed values. See Use the Scope Parameter.

Note:
– The value that you enter replaces the Default Scopes value that’s defined
in the specified authentication provider.
– Whether scopes are defined can affect whether each OAuth flow prompts the user
with a consent screen.
– We recommend that you request a refresh token or offline access. Otherwise, when
the token expires, you lose access to the external system.

Start To authenticate to the external system and obtain an OAuth token, select this checkbox. This
Authentication Flow authentication process is called an OAuth flow.
on Save When you click Save, the external system prompts you to log in. After successful login, the
external system grants you an OAuth token for accessing its data from this org.
Redo the OAuth flow when you need a new token—for example, if the token expires—or if
you edit the Scope or Authentication Provider fields. When the token expires,
the external system returns a 401 HTTP error status.

5. Click Save.
6. Click Validate and Sync, and confirm that the connection is successful.
If you instead receive an error message, refer to the following documents.
• “Status Codes and Error Responses” in the REST API Developer Guide
• The “API Fault Element,” “ExceptionCode,” “Error,” and “StatusCode” sections of “Core Data Types Used in API Calls” in the SOAP
API Developer Guide

906
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

7. Optionally, select tables and click Sync to do the following for each selected table.
• Automatically create a Salesforce external object.
• Automatically create a custom field for each table column that’s compatible with a Salesforce metadata field type.

Note: Before you sync, make sure that you understand the considerations that are described in these topics.
• Sync an External Data Source for Salesforce Connect
• Sync Considerations for Salesforce Connect—Cross-Org Adapter

You can instead choose to manually create the external objects and custom fields that map to the external data. Doing so lets you
customize the external object names, decide which table columns to create custom fields for, and customize the custom field names.
However, this approach takes longer and requires manual maintenance.

SEE ALSO:
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter
Store Authentication Settings for External Systems
API Names for External Objects and Custom Fields in Salesforce Connect—Cross-Org Adapter
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter
Developer Guide: REST API Developer Guide

Considerations for Salesforce Connect—Cross-Org Adapter

Understand the special behaviors, limits, and recommendations for using the cross-org adapter for
EDITIONS
Salesforce Connect.
Also review the considerations that apply to all Salesforce Connect adapters. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Salesforce Compatibility Considerations for Salesforce Connect—Cross-Org Adapter
Experience (not for
Some Salesforce features and functionality have special behaviors or aren’t available for external high-data-volume external
objects that are associated with an external data source of type Salesforce Connect: objects)
Cross-Org.
Available in: Developer
Sync Considerations for Salesforce Connect—Cross-Org Adapter Edition
When you validate and sync an external data source of type Salesforce Connect:
Available for an extra cost
Cross-Org, some special behaviors and limitations apply.
in: Enterprise, Performance,
Writable External Objects Considerations for Salesforce Connect—Cross-Org Adapter and Unlimited Editions
Some behaviors and limitations affect writable external objects that are associated with the
cross-org adapter for Salesforce Connect.
API Usage Considerations for Salesforce Connect—Cross-Org Adapter
With the cross-org adapter, Salesforce Connect uses Lightning Platform REST API calls to access records in other Salesforce orgs.
Depending on how the external object is accessed, each call counts toward the API usage limits of only the provider org or of both
provider and subscriber orgs.
Picklist Considerations for Salesforce Connect—Cross-Org Adapter
Special behaviors and limitations apply to picklist and multi-select picklist fields on external objects.

907
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Currency Considerations for Salesforce Connect—Cross-Org Adapter

Special behaviors and limitations apply to currency fields on external objects.

SEE ALSO:
Salesforce Platform Features Supported by Salesforce Connect

Salesforce Compatibility Considerations for Salesforce Connect—Cross-Org Adapter

Some Salesforce features and functionality have special behaviors or aren’t available for external
EDITIONS
objects that are associated with an external data source of type Salesforce Connect:
Cross-Org. Available in: both Salesforce
• The cross-org adapter for Salesforce Connect can access only queryable objects in the provider Classic and Lightning
org. If you define an external object whose table name specifies an object that can’t be queried, Experience
your users and the Lightning Platform can’t access that external object. Available in: Developer
• You can’t use Salesforce Connect external objects to access big objects in another org. Edition
• When you deploy an external data source that uses OAuth 2.0 from a sandbox org to a Available for an extra cost
production org, you must update the authentication provider. On a production org, an external in: Enterprise, Performance,
data source can’t use an authentication provider that directs authorization or token requests and Unlimited Editions
to a sandbox org. Similarly, on a sandbox org, an external data source can’t use an authentication
provider that directs authorization or token requests to a production org.
Also review the considerations that apply to all Salesforce Connect adapters.

Sync Considerations for Salesforce Connect—Cross-Org Adapter

When you validate and sync an external data source of type Salesforce Connect:
EDITIONS
Cross-Org, some special behaviors and limitations apply.
• Which objects and fields can be synced is determined by the object permissions and field Available in: both Salesforce
permissions of the provider org’s user whose credentials are defined in the external data source Classic (not available in all
definition. See User Access to External Data in Salesforce Connect—Cross-Org Adapter on page orgs) and Lightning
903. Experience (not for
high-data-volume external
• Only queryable objects can be synced.
objects)
• You can’t sync an object whose API name contains 38 or more characters. An external object’s
name can’t exceed 40 characters, including the automatically appended __x suffix. See API Available in: Developer
Names for External Objects and Custom Fields in Salesforce Connect—Cross-Org Adapter on Edition
page 901. Available for an extra cost
• These field types aren’t synced. in: Enterprise, Performance,
and Unlimited Editions
– Encrypted text
– Rich text area

• Global picklist value sets aren’t synced. If a provider org’s picklist field uses a global picklist value set, syncing creates a local picklist
field on the subscriber org. A local picklist field has its own set of values.
• Inactive picklist values aren’t synced. If the subscriber org accesses an external object record that contains an inactive picklist value,
the inactive value is added to the picklist field on the external object.

• Syncing converts restricted picklists on the provider org into unrestricted picklists on the subscriber org’s external objects.

908
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

We recommend having only unrestricted picklists on external objects, even when they’re associated with restricted picklists on the
provider org. Restricted picklists on the provider org block unapproved values from the subscriber org, eliminating the need to
restrict picklists on external objects.

• To enable users to change the currency when editing an external object record, add the Currency field to the page layouts. All
other synced fields are automatically added to the default page layout.
• Syncing always enables search on the external object when search is enabled on the external data source, and vice versa.
• Hierarchical, lookup, and master-detail relationship fields are synced. However, they become text fields in the subscriber org, and
their values appear as IDs, not as record names.
For example, suppose that we sync the Account object. When we view the Acme Wireless account in the provider org, the value of
the Account Owner (Account.OwnerId) field appears as John Smith. When we view the equivalent account in the subscriber
org, the value for the (Account__x.OwnerId__c) field appears as 005B00000019eapIAA.

• You can use external lookup relationships in the subscriber org to mirror lookup relationships in the provider org. For each lookup
relationship that you want to bring into the subscriber org, sync the parent and child objects. Each lookup relationship field becomes
a text field on the subscriber org. Change the field type of the sync-created text field to External Lookup Relationship. When specifying
the parent of the external lookup relationship, select the external object that corresponds to the parent object in the provider org.
• The names and labels of synced fields on the subscriber org are derived from the API names—not the labels—of the fields on the
provider org. For example, the Account object in the provider org has the Account Owner (OwnerId) standard field. If we sync the
Account object, the Account__x.OwnerId__c field in the subscriber org has the label “Owner ID” and the name “OwnerId.”

Important: When you select the provider org objects to sync, determine whether check marks appear in the Synced column.
If a Synced check mark appears, the subscriber org has an external object whose object name (for example, Account__x)
associates it with the object in the provider org (for example, Account). If you select the object and click Sync:
• The external object is overwritten.
• Any custom field on the external object is overwritten if its API name (for example, Email_c__c) associates it with a field
on the provider org (for example, Email__c).
• Any other custom fields on the external object remain as they are, including:
– Previously synced custom fields whose API names were changed by editing their Field Name values.
– Manually added custom fields whose API names aren’t associated with fields on the provider org’s object.

If no Synced check mark appears, and you sync the object, a new external object is created in the subscriber org.
For example, the object name is changed on the provider org to no longer be associated with the object name of the external
object on the subscriber org. Syncing that object creates a new external object on the subscriber org. We recommend that you
change the object name of the existing external object to match the updated object name on the provider org before you sync.

Also review the considerations that apply to all Salesforce Connect adapters.

SEE ALSO:
API Names for External Objects and Custom Fields in Salesforce Connect—Cross-Org Adapter
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter
Sync an External Data Source for Salesforce Connect
Cross-Org Adapter for Salesforce Connect

909
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Writable External Objects Considerations for Salesforce Connect—Cross-Org Adapter

Some behaviors and limitations affect writable external objects that are associated with the cross-org
EDITIONS
adapter for Salesforce Connect.
• Some fields remain read only on writable external objects, such as fields that are creatable but Available in: both Salesforce
not editable and fields that have derived or calculated values. For example: Classic (not available in all
orgs) and Lightning
– Address fields such as Billing Address and Shipping Address, which are
Experience (not for
derived from writable fields, such as Street Address, State, and Zip)
high-data-volume external
– Auto-number fields objects)
– Created by fields
Available in: Developer
– Formula fields Edition
– Last Modified fields Available for an extra cost
– Roll-up summaries in: Enterprise, Performance,
and Unlimited Editions
• Picklist values on external objects can get out of sync with picklist values on the provider org.
If picklist values are changed on the provider org, resync or manually delete and recreate the
associated picklist fields on the subscriber org.
Also review the considerations that apply to all Salesforce Connect adapters.

SEE ALSO:
Writable External Objects in Salesforce Connect
Sync an External Data Source for Salesforce Connect
Cross-Org Adapter for Salesforce Connect

API Usage Considerations for Salesforce Connect—Cross-Org Adapter

With the cross-org adapter, Salesforce Connect uses Lightning Platform REST API calls to access
EDITIONS
records in other Salesforce orgs. Depending on how the external object is accessed, each call counts
toward the API usage limits of only the provider org or of both provider and subscriber orgs. Available in: both Salesforce
When a user accesses an external object in one of the following ways, the Lightning Platform REST Classic (not available in all
API call counts toward the API usage limits of the provider org. orgs) and Lightning
Experience (not for
• Opening a list view of external object records
high-data-volume external
• Viewing an external object record detail page objects)
• Viewing a parent object record that contains an external object related list
Available in: Developer
• Viewing a child object record that contains an external lookup field Edition
• Executing a search that also searches external objects Available for an extra cost
• Accessing an external object from a flow, Visualforce page, Apex class, or Apex trigger in: Enterprise, Performance,
and Unlimited Editions
• Creating, editing, or deleting an external object record
• Running a report
• Editing a report and causing the preview to load in report builder

910
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

If a user or system accesses an external object through the SOAP API, Bulk API, or Lightning Platform REST API, that access counts toward
the API usage limits of both the subscriber org and the provider org.

SEE ALSO:
Salesforce Limits Quick Reference Guide: API Request Limits and Allocations
Considerations for Salesforce Connect—Cross-Org Adapter
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter

Picklist Considerations for Salesforce Connect—Cross-Org Adapter

Special behaviors and limitations apply to picklist and multi-select picklist fields on external objects.
EDITIONS
• You can edit picklist values on external objects, but changes to fields on the provider org aren’t
automatically reflected in the subscriber org. To reflect changes on the subscriber org, resync Available in: both Salesforce
the external object or manually update the picklist values on the external object. Classic (not available in all
orgs) and Lightning
If you don’t resync or update the picklist values on the external object:
Experience (not for
– When an active picklist value is added to the provider org, the subscriber org doesn’t display high-data-volume external
it as an available picklist value on external object records. objects)
– When an active picklist value is deleted from or made inactive on a restricted picklist on Available in: Developer
the provider org, the subscriber org can’t create or edit external object records with that Edition
value.
Available for an extra cost
• Global picklist value sets aren’t synced. If a provider org’s picklist field uses a global picklist value in: Enterprise, Performance,
set, syncing creates a local picklist field on the subscriber org. A local picklist field has its own and Unlimited Editions
set of values.
• Inactive picklist values aren’t synced. If the subscriber org accesses an external object record
that contains an inactive picklist value, the inactive value is added to the picklist field on the external object.

• Syncing converts restricted picklists on the provider org into unrestricted picklists on the subscriber org’s external objects.
• We recommend having only unrestricted picklists on external objects, even when they’re associated with restricted picklists on the
provider org. Restricted picklists on the provider org block unapproved values from the subscriber org, eliminating the need to
restrict picklists on external objects.

SEE ALSO:
Sync Considerations for Salesforce Connect—Cross-Org Adapter
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter
Considerations for Salesforce Connect—Cross-Org Adapter
Picklist Considerations for Salesforce Connect OData Adapters

911
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Currency Considerations for Salesforce Connect—Cross-Org Adapter

Special behaviors and limitations apply to currency fields on external objects.
EDITIONS
• Enable multiple currencies in the subscriber org, and make sure that the subscriber org has all
the currencies that the provider orgs use. If a currency is later added to the provider org, add Available in: both Salesforce
the currency to the subscriber org. Classic (not available in all
orgs) and Lightning
If you can’t enable multiple currencies in the subscriber org, make sure that all provider orgs
Experience (not for
are single-currency and use the same currency as the subscriber org.
high-data-volume external
• To enable users to change the currency when editing an external object record, add the objects)
Currency field to the page layouts. Available in: Developer
• If a user tries to change the currency in an external object record, the list of currency options Edition
isn’t limited to active currencies in the provider org. If the user selects a currency that’s inactive Available for an extra cost
or unavailable in the provider org, the user gets an error and can’t save the record. in: Enterprise, Performance,
• The convertCurrency() function is ignored in SOQL queries of external objects. and Unlimited Editions

SEE ALSO:
Considerations for Enabling Multiple Currencies
Considerations for Salesforce Connect—Cross-Org Adapter
Subscriber and Provider Orgs in Salesforce Connect—Cross-Org Adapter

Access External Data with OData Adapters for Salesforce Connect

Connect your users to data that's exposed via the Open Data Protocol.

OData Adapters for Salesforce Connect

Connect to your back office for a complete view of your business. With the OData 2.0, 4.0, or 4.01 adapter, Salesforce Connect uses
Open Data Protocol Version 2.0, Version 4.0, or Version 4.01 to access data that’s stored outside Salesforce.
Set Up Salesforce Connect to Access External Data with OData Adapters
Let users view and search data that’s stored outside your Salesforce org, such as data in an enterprise resource planning (ERP) system.
Considerations for Salesforce Connect OData Adapters
Understand the special behaviors, limits, and recommendations for using the OData 2.0, 4.0, and 4.01 adapters for Salesforce Connect.
Picklist Considerations for Salesforce Connect OData Adapters
Special behaviors and limitations apply to picklist fields on external objects for OData 2.0, 4.0, and 4.01 adapters.
OData Reference for Salesforce Connect OData Adapters
Get to know the Salesforce implementation of the OData protocol for accessing external systems with Salesforce Connect.
Use External Change Data Capture to Track Data Changes on External Objects
With External Change Data Capture, you can track changes to data that is stored outside your Salesforce org when using the Odata
4.0 adapter. You can then build automation in response to the changes to increase productivity or provide a better customer
experience.

912
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData Adapters for Salesforce Connect

Connect to your back office for a complete view of your business. With the OData 2.0, 4.0, or 4.01
EDITIONS
adapter, Salesforce Connect uses Open Data Protocol Version 2.0, Version 4.0, or Version 4.01 to
access data that’s stored outside Salesforce. Available in: both Salesforce
Your users and the Lightning Platform interact with the external data via external objects. Salesforce Classic (not available in all
Connect converts each of those interactions into an OData query that contains the relevant orgs) and Lightning
parameters to filter the results. Salesforce performs an OData callout each time that: Experience (not for
high-data-volume external
• A user clicks an external object tab for a list view. objects)
• A user views a record detail page of an external object.
Available in: Developer
• A user views a record detail page of a parent object that displays a related list of child external Edition
object records.
Available for an extra cost
• A user performs a Salesforce global search. in: Enterprise, Performance,
• A user creates, edits, or deletes an external object record. and Unlimited Editions
• A user runs a report.
• The preview loads in the report builder.
• An external object is accessed via flows, processes, APIs, Apex, SOQL, or SOSL.
• You validate or sync an external data source.
The OData adapters for Salesforce Connect can access external data that’s exposed via services called OData producers. Learn more about
OData producers at www.odata.org.
To understand the limitations on Apex code accessing external objects via the OData adapters, see Apex Considerations for Salesforce
Connect External Objects.

External IDs and OData Entity Keys

When you access external data with the OData 2.0, 4.0, or 4.01 adapter for Salesforce Connect, the values of the External ID standard
field on an external object are derived according to the entity key that’s defined in the OData service metadata document.
Client-Driven and Server-Driven Paging for Salesforce Connect OData Adapters
It's common for Salesforce Connect queries of external data to have a large result set that's broken into smaller batches or pages.
You decide whether to have the paging behavior controlled by the external system (server-driven) or by the OData adapter for
Salesforce Connect (client-driven).
General Limits for Salesforce Connect OData Adapters
Understand the limits for the OData 2.0, 4.0, and 4.01 adapters for Salesforce Connect.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect to Access External Data with OData Adapters
Considerations for Salesforce Connect OData Adapters
OData Reference for Salesforce Connect OData Adapters

913
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

External IDs and OData Entity Keys

When you access external data with the OData 2.0, 4.0, or 4.01 adapter for Salesforce Connect, the
EDITIONS
values of the External ID standard field on an external object are derived according to the entity
key that’s defined in the OData service metadata document. Available in: both Salesforce
Each external object has an External ID standard field. Its values uniquely identify each Classic (not available in all
external object record in your org. When the external object is the parent in an external lookup orgs) and Lightning
relationship, the External ID standard field is used to identify the child records. Experience (not for
high-data-volume external
Important: Don’t use sensitive data as the values of the External ID standard field or fields objects)
designated as name fields, because Salesforce sometimes stores those values.
Available in: Developer
• External lookup relationship fields on child records store and display the External ID values Edition
of the parent records.
Available for an extra cost
• For internal use only, Salesforce stores the External ID value of each row that’s retrieved in: Enterprise, Performance,
from the external system. This behavior doesn’t apply to external objects that are associated and Unlimited Editions
with high-data-volume external data sources.

This list view for the Order_Detail external object displays External ID values.

Each External ID value is derived according to the entity key that’s defined in the OData service metadata document of the remote data
service (OData producer). The entity key is formed from a subset of the entity type’s properties.
This excerpt from an OData service metadata document shows that the External ID values for the Order_Detail external object are derived
from the OrderID and ProductID properties.
<EntityType Name="Order_Detail">
<Key>
<PropertyRef Name="OrderID"/>
<PropertyRef Name="ProductID"/>
</Key>
<Property Name="OrderID" Type="Edm.Int32" Nullable="false"/>
<Property Name="ProductID" Type="Edm.Int32" Nullable="false"/>
<Property Name="UnitPrice" Type="Edm.Decimal" Nullable="false" Precision="19" Scale="4"/>

<Property Name="Quantity" Type="Edm.Int16" Nullable="false"/>

<Property Name="Discount" Type="Edm.Single" Nullable="false"/>
...

This record detail page displays the OrderID and ProductID fields. Their values are combined to create the value of the External ID standard
field.

914
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

If you enable writable external objects, determine whether the external system requires write operations to specify values for the entity
keys. For example, many external systems generate values for entity keys when new external object records are created in Salesforce. If
your external system requires write operations to specify values for entity keys, ensure that External ID standard field values and
entity key values don’t contradict each other. For each write operation, include either the External ID standard field value or the custom
field values that form the entity key, but never both.

SEE ALSO:
OData Adapters for Salesforce Connect
Writable External Objects in Salesforce Connect

Client-Driven and Server-Driven Paging for Salesforce Connect OData Adapters

It's common for Salesforce Connect queries of external data to have a large result set that's broken
EDITIONS
into smaller batches or pages. You decide whether to have the paging behavior controlled by the
external system (server-driven) or by the OData adapter for Salesforce Connect (client-driven). Available in: both Salesforce
By default, the OData adapters for Salesforce Connect use client-driven paging. Specifically, the Classic (not available in all
OData requests use the $top and $skip system query options to page through the result set. orgs) and Lightning
Experience (not for
With server-driven paging, the external system determines the page sizes and batch boundaries.
high-data-volume external
The external system’s paging settings can optimize the external system’s performance and improve objects)
the load times for external objects in your org. Also, the external data can change while your users
or the Lightning Platform are paging through the result set. Typically, server-driven paging adjusts Available in: Developer
batch boundaries to accommodate changing external data more effectively than client-driven Edition
paging. Available for an extra cost
The Server Driven Pagination field on the external data source specifies whether to in: Enterprise, Performance,
use client-driven or server-driven paging. If you enable server-driven paging on an external data and Unlimited Editions
source, Salesforce ignores the requested page sizes, including the default queryMore() batch
size of 500 rows. The pages returned by the external system determine the batches, but each page
can’t exceed 2,000 rows. However, the limits for the OData adapters for Salesforce Connect still apply.

SEE ALSO:
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Define an External Data Source for Salesforce Connect OData 4.01 Adapter
General Limits for Salesforce Connect OData Adapters
OData Query String Options

915
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

General Limits for Salesforce Connect OData Adapters

Understand the limits for the OData 2.0, 4.0, and 4.01 adapters for Salesforce Connect.
EDITIONS
For OData 2.0 and 4.0, an org is limited to:
Available in: both Salesforce
If your users or applications encounter rate limit errors for OData callouts, try one or more of the
Classic (not available in all
following.
orgs) and Lightning
• Select High Data Volume in the external data source definition. Doing so bypasses most Experience (not for
rate limits, but some special behaviors and limitations apply. high-data-volume external
• If you have Apex code that invokes the external system, modify that code to cache frequently objects)
accessed external data that seldom changes. Available in: Developer
• Contact Salesforce to request a higher limit. Edition
Available for an extra cost
Maximum HTTP request size for OData 8 MB in: Enterprise, Performance,
and Unlimited Editions
Maximum HTTP response size for OData 8 MB

Maximum result set size for an OData query 16 MB

Maximum result set size for an OData subquery 1,000 rows

For OData 2.0, 4.0, and 4.01, an org is limited to:

SEE ALSO:
General Limits for Salesforce Connect
OData Adapters for Salesforce Connect
Record IDs for Salesforce Connect External Objects

Set Up Salesforce Connect to Access External Data with OData Adapters

USER PERMISSIONS EDITIONS

To create and edit external data sources: Customize Application Available in: both Salesforce
Classic (not available in all
To create and edit external objects: Customize Application
orgs) and Lightning
To define or change object-level help: Customize Application Experience (not for
high-data-volume external
To create and edit custom fields: Customize Application objects)
To edit permission sets and user profiles: Manage Profiles and Permission Sets Available in: Developer
To edit another user’s authentication settings Manage Users Edition
for external systems: Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions
Let users view and search data that’s stored outside your Salesforce org, such as data in an enterprise
resource planning (ERP) system.
Setting up Salesforce Connect with an OData 2.0, 4.0, or 4.01 adapter involves these high-level steps.

916
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

1. Define an external data source of type Salesforce Connect: OData 2.0 or Salesforce Connect: OData
4.0. or Define an external data source of type Salesforce Connect: OData 4.01.
If your external system hosts multiple services, create an external data source for each service endpoint. Each service endpoint points
to an OData service root URL and can expose collections of entities. For example, you’d create a separate external data source for
each of these service endpoints.
• http://services.example.org/Warehouse.svc
• https://services.example.org/Payroll.svc

2. Create the external objects.

Perform this task only if you don’t sync to automatically create the external objects. Create an external object for each external data
table that you want to access from your Salesforce org.

3. Add custom fields and relationships to the external objects.

Create relationships between objects. If you didn’t sync to automatically create the external objects and their fields, create a custom
field for each external table column that you want to access from your Salesforce org.

4. Verify access to external object data.

Check that expected user and code interactions with the external objects work, including sorting and filtering search and query
results.

Tip: After you configure an external data source, run the validator tool on each external object to test and troubleshoot its
connections. The tool tests for ID uniqueness and the ability to sort and filter results.

5. Enable user access to external objects.

Grant object permissions through permission sets or profiles.

6. Enable user access to the fields on the external objects.

Grant field permissions through permission sets or profiles.

7. If the external data source uses per-user authentication:

a. Let users authenticate to the external system.
Grant users access to authentication settings for the external data source through permission sets or profiles.

b. Set up each user’s authentication settings.

You or your users can perform this task.

Tip: Train your users on how to set up their authentication settings for external systems. Make sure that they know which
credentials to enter for each external system. If you’re using OAuth 2.0, test the OAuth flow for potentially confusing
prompts or redirects, and train your users as needed. OAuth flows vary, depending on your external system, authentication
provider, and specified scopes.

917
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define an External Data Source for Salesforce Connect OData 4.01 Adapter
Connect your Salesforce org to data that’s stored in an external system, such as SAP® NetWeaver Gateway, Microsoft Dynamics® NAV,
or IBM WebSphere®.

SEE ALSO:
OData Adapters for Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
Developer Guide: Visualforce Developer Guide
External Object Relationships

Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Connect your Salesforce org to data that’s stored in an external system, such as SAP® NetWeaver
EDITIONS
Gateway, Microsoft Dynamics® NAV, or IBM WebSphere®.

Note: Available in: both Salesforce

Classic (not available in all
• The external data must be exposed by a service that uses Open Data Protocol (OData) orgs) and Lightning
Version 2.0 or 4.0. Such a service is called an OData producer. Experience (not for
• The URL for reaching the OData producer must be accessible by Salesforce application high-data-volume external
servers through the Internet. You can access by adding Salesforce server IP addresses on objects)
your corporate network firewall to the allow list or by setting up a reverse-proxy XML
Available in: Developer
Gateway. Edition
• The extent to which you can customize data visibility depends on the external system.
Available for an extra cost
To determine the optimal settings for integration with Salesforce, consult the external in: Enterprise, Performance,
system’s documentation. and Unlimited Editions
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources.
USER PERMISSIONS
2. Click New External Data Source, or click Edit to modify an existing external data source.
To create and edit external
3. Complete the fields. data sources:
• Customize Application
Field Description
External Data A user-friendly name for the external data source. The label is displayed
Source in the Salesforce user interface, such as in list views.
If you set Identity Type to Per User, this label appears when
your users view or edit their authentication settings for external
systems.

Name A unique identifier that’s used to refer to this external data source
definition through the API.
The name 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.

Type Select Salesforce Connect: OData 2.0 or Salesforce Connect:

OData 4.0.

918
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
URL The OData service root URL. Make sure that you escape all special characters.
Each service endpoint requires its own external data source definition, but you can have multiple
entities under one service root URL. For more information about the service root URL and other
URL conventions, go to www.odata.org.
Examples:
• http://services.example.org/Warehouse.svc
• https://services.example.org/Payroll.svc
If the endpoint is defined in a named credential, enter the named credential URL. A named
credential URL contains the scheme callout:, the name of the named credential, and an
optional path. For example: callout:My_Named_Credential/some_path.
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:
callout:My_Named_Credential/some_path?format=json.
If you enter a named credential URL, skip the Authentication section for the external data source.
To access the external system, Salesforce Connect uses the authentication settings that are defined
in the named credential.

Connection Timeout Number of seconds to wait for a response from the external system before timing out. By default,
the value is set to the maximum of 120 seconds.
Depending on the availability of and the connection to the external system, it can take a long
time to retrieve external data. Use this field to limit how long to wait for external data to load into
your org.

Writable External Lets the Lightning Platform and users in this org create, update, and delete records for external
Objects objects associated with the external data source. The external object data is stored outside the
org. By default, external objects are read only.

High Data Volume Salesforce enforces rate limits for retrieving and viewing data from external systems. If your org
hits rate limits when accessing external objects, consider selecting the High Data Volume option
on the associated external data sources. Doing so bypasses most rate limits, but some special
behaviors and limitations apply. See High Data Volume Considerations for Salesforce
Connect—OData 2.0 and 4.0 Adapters.
High-data-volume external data sources are still limited to 20,000 OData queries per hour for
Enterprise, Performance, and Unlimited Editions. If you require higher limits, create a support case.
See callout limits in General Limits for Salesforce Connect OData Adapters.

Server Driven It's common for Salesforce Connect queries of external data to have a large result set that's broken
Pagination into smaller batches or pages. Select this option to have the external system control the paging
behavior. See Client-Driven and Server-Driven Paging for Salesforce Connect OData Adapters.

Request Row Counts Includes one of the following system query options in each OData query so that the response
includes the total row count of the result set.
• $inlinecount=allpages for the OData 2.0 adapter
• $count=true for the OData 4.0 adapter

919
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Some external systems don’t support these system query options. If you receive errors or notice
long load times when you try to access their data, deselect Request Row Counts on the external
data source. If you do so, however, the external data source and its associated external objects
can’t support the following functionality, which requires the total row count.
• SOQL COUNT() aggregate function
• Batch Apex with Database.QueryLocator

Compress Requests When selected, Salesforce sends compressed HTTP requests to the external system. Make sure
that the external system is set up to receive gzip-compressed data. Salesforce automatically
accepts gzip-compressed responses.

Enable Search Determines whether SOSL and Salesforce global searches also query the external objects that are
associated with this external data source.
When selected, you can control which external objects are searchable by selecting or deselecting
Allow Search on each external object.
Only text, text area, and long text area fields on external objects can be searched. If an external
object has no searchable fields, searches on that object return no records.
Select this option to allow the external data source’s associated external objects to appear in
Salesforce for iOS and Salesforce mobile web when used on iOS devices.

Custom Query Option Available only for the OData 2.0 adapter for Salesforce Connect. If the OData producer has
for Salesforce implemented and exposed a free-text-search custom query option, enter the name of that query
Search string parameter.
Learn more about OData custom query options and other URI conventions at www.odata.org.
This field has no effect when Enable Search is deselected or when the OData producer
isn’t set up to correctly handle the custom query option.
See OData 2.0 Query Options.

Use Free-Text Search Available only for the OData 4.0 adapter for Salesforce Connect. Select this option to use the
Expressions $search system query option instead of $filter in search requests that are sent to the
external system. Make sure that the OData producer is set up to support the $search system
query option.
This field has no effect when Enable Search is deselected.
See OData 4.0 Query Options.

Format The format that the OData producer uses to represent resources, such as collections of data.
Make sure that the OData producer is set up to support the selected format. Learn more about
representation formats and operations at www.odata.org.
If your external data source uses the OData 4.0 adapter and JSON format, make sure that the
OData producer accepts headers that contain the odata.metadata=full format parameter.
Other variations, including odata.metadata=minimal, aren’t supported for OData 4.0
adapter.

920
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Special Select Socrata only if the URL specifies a Socrata open data endpoint. See Socrata™ Considerations
Compatibility for Salesforce Connect—OData 2.0 and 4.0 Adapters.

Display Server Lets you specify whether to display error messages from an external system in the user interface.
Errors

CSRF Protection If the external system requires Cross-Site Request Forgery (CSRF) protection in requests to create,
edit or delete its data, select this option. If you do so, your org obtains an anti-CSRF token and
cookie from the external system and includes them in each create, edit, and delete request. See
CSRF Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters.
Available only when Writable External Objects is selected.

Anti-CSRF Token Name HTTP header field that contains the anti-CSRF token. The external system determines the field
name. Default: X-CSRF-Token
Available only when CSRF Protection is selected.

Certificate 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.

Identity Type Determines whether you're using one set or multiple sets of credentials to access the external
system. See Identity Type for External Data Sources.
Select Anonymous only if the external system doesn’t require authentication.

4. Select the authentication protocol.

• If you select Password Authentication, enter the username and password for accessing the external system.
• If you select OAuth 2.0, complete the following fields.

Field Description
Authentication Choose the provider. See Authentication Providers.
Provider

Scope Specifies the scope of permissions to request for the access token. Your authentication provider
determines the allowed values. See Use the Scope Parameter.

Note:
– The value that you enter replaces the Default Scopes value that’s defined
in the specified authentication provider.
– Whether scopes are defined can affect whether each OAuth flow prompts the user
with a consent screen.
– We recommend that you request a refresh token or offline access. Otherwise, when
the token expires, you lose access to the external system.

921
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Start To authenticate to the external system and obtain an OAuth token, select this checkbox. This
Authentication Flow authentication process is called an OAuth flow.
on Save When you click Save, the external system prompts you to log in. After successful login, the
external system grants you an OAuth token for accessing its data from this org.
Redo the OAuth flow when you need a new token—for example, if the token expires—or if
you edit the Scope or Authentication Provider fields. When the token expires,
the external system returns a 401 HTTP error status.

5. Click Save.
6. Click Validate and Sync, and confirm that the connection is successful.
7. Optionally, select tables and click Sync to do the following for each selected table.
• Automatically create a Salesforce external object.
• Automatically create a custom field for each table column that’s compatible with a Salesforce metadata field type.

Note: Before you sync, make sure that you understand the considerations that are described in these topics.
• Sync an External Data Source for Salesforce Connect
• Sync Considerations for Salesforce Connect OData Adapters

You can instead choose to manually create the external objects and custom fields that map to the external data. Doing so lets you
customize the external object names, decide which table columns to create custom fields for, and customize the custom field names.
However, this approach takes longer and requires manual maintenance.

Optionally, you can associate custom HTTP headers to the external data source to retrieve or request additional data.

SEE ALSO:
Set Up Salesforce Connect to Access External Data with OData Adapters
Store Authentication Settings for External Systems
OData Query String Options
OData Type Mapping
Named Credentials

922
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define Custom HTTP Headers for OData Connectors

Define and activate custom HTTP headers to pass more request information to the external data
EDITIONS
source for processing.
Custom HTTP headers provide context information from Salesforce such as region, org details, or Available in: both Salesforce
the role of the person viewing the external object. For each OData external data source, define up Classic (not available in all
10 HTTP headers to request or data. For example, to see who’s making a callout to the external data orgs) and Lightning
source, use a formula that resolves to the name of the user. Experience

When naming the custom HTTP header, don’t override the following existing standard header Available with Salesforce
names. Connect, which is available
in: Developer Edition and for
• Content-Type
an extra cost in: Enterprise,
• Accept Performance, and
• maxVersionHeader Unlimited Editions
• versionHeader
• X-HTTP-METHOD USER PERMISSIONS
• Content-Length
To create and edit external
• X-CSRF-Token (when CSRF-enabled) data sources:
• Prefer (when a trigger on the external object is enabled) • Customize Application
• Cookie
1. From Setup, enter External Data Sources in the Quick Find box, then select External Data Sources.
2. Click the name of an OData 2.0 or 4.0 data source.
3. In the External Custom HTTP Headers related list, click New to create a custom HTTP header or Edit to change an existing one.
4. Complete the fields.

Field Description
Header Field Name Enter a name that contains at least one alphanumeric character or underscore. It can also include:
!#$%&'*+-.^_`|~

Header Field Value Create a formula for the Header Field Value using the formula editor. 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.

Active To start using the header field right away, select the Active checkbox.

Description A text description of the header field’s purpose.

Parent The name of the entity that the custom HTTP header is related to.

Note: A named credential as the parent entity for the custom HTTP header isn’t supported.

5. Click Save.

Note: You can’t add or delete Custom HTTP headers that are included in a managed package. However, you can edit custom
HTTP headers that are part of a managed package. The Header Name and Description fields are developer editable. The Active
and Header Field Value fields are both subscriber and developer editable.

923
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Named Credential as Callouts for Salesforce Connect OData 2.0 or 4.0 Adapters
This example shows how Salesforce Connect OData 2.0 or 4.0 adapters can make callouts using the authentication settings defined in
a named credential.
Define a named credential that specifies the endpoint URL and the JWT authentication settings.

When you’re defining an external data source with an Odata 2.0 or Odata 4.0 adapter, specify the named credential you defined as the
OData service root URL. In this example, the URL is callout:Test_named_credential. And skip the Authentication section
for the external data source. To access the external system, Salesforce Connect uses the authentication settings defined in the named
credential.

SEE ALSO:
Named Credentials
Store Authentication Settings for External Systems
Grant Access to Authentication Settings for Legacy Named Credentials

924
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define an External Data Source for Salesforce Connect OData 4.01 Adapter
Connect your Salesforce org to data that’s stored in an external system, such as SAP® NetWeaver
EDITIONS
Gateway, Microsoft Dynamics® NAV, or IBM WebSphere®.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Available in: both Salesforce
Data Sources. Classic (not available in all
orgs) and Lightning
2. Click New External Data Source, or click Edit to modify an existing external data source.
Experience (not for
3. Complete the fields. high-data-volume external
objects)
Field Description
Available in: Developer
External Data A user-friendly name for the external data source. The label is displayed Edition
Source in the Salesforce user interface, such as in list views. Available for an extra cost
in: Enterprise, Performance,
Name A unique identifier that’s used to refer to this external data source
and Unlimited Editions
definition through the API.
The name can contain only underscores and alphanumeric characters.
It must be unique, begin with a letter, not include spaces, not end USER PERMISSIONS
with an underscore, and not contain two consecutive underscores.
To create and edit external
Type Select Salesforce Connect: OData 4.01. data sources:
• Customize Application
Named Enter the named credential URL defined for data source exposed via
Credential OData 4.01. To know how to create an external credential and named
credential, see Named Credentials.

Connection Number of seconds to wait for a response from the external system
Timeout before timing out. By default, the value is set to the maximum of 120
seconds.

Writable Lets the Lightning Platform and users in this org create, update, and
External delete records for external objects associated with the external data
Objects source. The external object data is stored outside the org. By default,
external objects are read only.

Server Driven Select this option to have the external system control the paging
Pagination behavior. See Client-Driven and Server-Driven Paging for Salesforce
Connect OData Adapters.

Batch DML Select this option to be able to send multiple DML requests to the
external data source in JSON batch format. See batch requests.

Metadata Select Full or Minimal as per your client application and device
Control requirements.
Information

4. Click Save.
5. Click Validate and Sync, select the tables, and click Sync. Before you sync, make sure that you understand the considerations
described in Sync an External Data Source for Salesforce Connect and Sync Considerations for Salesforce Connect OData Adapters

925
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Note: To leverage Named Credentials and Private Connect with OData 4.0 data sources, use the OData 4.01 adapter for
Salesforce Connect.

Considerations for Salesforce Connect OData Adapters

Understand the special behaviors, limits, and recommendations for using the OData 2.0, 4.0, and
EDITIONS
4.01 adapters for Salesforce Connect.
Also review the considerations that apply to all Salesforce Connect adapters. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Lightning Experience Considerations for Salesforce Connect OData Adapters
Experience (not for
Users can access external objects from the Lightning Experience app. But some requirements high-data-volume external
and special behaviors apply when the external data is accessed via the OData 2.0, 4.0, or 4.01 objects)
adapter for Salesforce Connect.
Available in: Developer
Writable External Objects Considerations for Salesforce Connect OData Adapters Edition
Some special behaviors and limitations affect writable external objects that are associated with
Available for an extra cost
OData 2.0, 4.0, and 4.01 adapters for Salesforce Connect.
in: Enterprise, Performance,
Sync Considerations for Salesforce Connect OData Adapters and Unlimited Editions
When you validate and sync an external data source of type OData 2.0, 4.0, or 4.01, some special
behaviors and limitations apply.
OData Producer Considerations for Salesforce Connect OData Adapters
Understand the limits and recommendations for the remote data service that exposes the external data via OData 2.0, 4.0, and 4.01
to your Salesforce org.
High Data Volume Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters
If your org hits rate limits when accessing external objects, consider selecting the High Data Volume option on the associated
external data sources. Doing so bypasses most rate limits, but some special behaviors and limitations apply.
Socrata™ Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters
Socrata Open Data Protocol™ is commonly used for health data and for collaboration between governments and their citizens.
Salesforce Connect can access data from endpoints that are backed by Socrata Open Data Portal. To accommodate Socrata-specific
requirements, set the Special Compatibility field on the external data source to Socrata.
CSRF Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters
Understand the special behaviors, limitations, and recommendations for Cross-Site Request Forgery (CSRF) on OData external data
sources.

SEE ALSO:
Salesforce Platform Features Supported by Salesforce Connect

926
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Lightning Experience Considerations for Salesforce Connect OData Adapters

Users can access external objects from the Lightning Experience app. But some requirements and
EDITIONS
special behaviors apply when the external data is accessed via the OData 2.0, 4.0, or 4.01 adapter
for Salesforce Connect. Available in: both Salesforce
• If external object records don’t appear in your org, make sure that the OData producer doesn’t Classic and Lightning
change the values specified in the OData query filters. When your org sends OData queries that Experience
specify field values with the $filter equals (eq) operator, the OData producer must return
Available in: Developer
those same field values in the resulting data rows. Edition
• If external object records don’t appear in relationship fields or related lists, check for case-sensitive Available for an extra cost
values. For example, suppose that you set up an indirect lookup relationship. If the external in: Enterprise, Performance,
system uses case-sensitive values in the specified External Column Name, make sure that the and Unlimited Editions
parent object field is also case-sensitive. When you define the parent object’s custom field,
select External ID, Unique, and Treat "ABC" and "abc" as different values (case sensitive).

SEE ALSO:
External Object Relationships
OData Query String Options
OData Adapters for Salesforce Connect
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Define an External Data Source for Salesforce Connect OData 4.01 Adapter

Writable External Objects Considerations for Salesforce Connect OData Adapters

Some special behaviors and limitations affect writable external objects that are associated with
EDITIONS
OData 2.0, 4.0, and 4.01 adapters for Salesforce Connect.
• An external object custom field associated with an OData complex type on the external system Available in: both Salesforce
is always read only, even if the external object is writable. Classic (not available in all
orgs) and Lightning
• Writable external objects aren’t available for high-data-volume external data sources.
Experience (not for
• If your external system requires write operations to specify values for entity keys, ensure that high-data-volume external
External ID standard field values and entity key values don’t contradict each other. For objects)
each write operation, include either the External ID standard field value or the custom field
values that form the entity key, but never both. Available in: Developer
Edition
• When an external object record is edited, Salesforce Connect sends an HTTP request to the
external system. Available for an extra cost
in: Enterprise, Performance,
– If the record is edited from the Salesforce user interface, the HTTP request includes all fields, and Unlimited Editions
including the fields that weren’t changed.
– If the record is edited from the API, only the specified fields are included in the HTTP request.

• Make sure that the OData producer supports the HTTP methods that are used by your Salesforce Connect adapter.

To Do This OData 4.01 Adapter Uses This OData 4.0 Adapter Uses This OData 2.0 Adapter Uses This
HTTP Method HTTP Method HTTP Method
Create record POST POST POST

927
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

To Do This OData 4.01 Adapter Uses This OData 4.0 Adapter Uses This OData 2.0 Adapter Uses This
HTTP Method HTTP Method HTTP Method
Edit record PATCH POST with X-HTTP-METHOD POST with X-HTTP-METHOD
header set to PATCH header set to MERGE

Delete record DELETE DELETE DELETE

View record GET GET GET

Also review the considerations that apply to all Salesforce Connect adapters.

SEE ALSO:
Writable External Objects in Salesforce Connect
External IDs and OData Entity Keys
OData Adapters for Salesforce Connect

Sync Considerations for Salesforce Connect OData Adapters

When you validate and sync an external data source of type OData 2.0, 4.0, or 4.01, some special
EDITIONS
behaviors and limitations apply.
Syncing always enables search on the external object when search is enabled on the external data Available in: both Salesforce
source, and vice versa. Classic (not available in all
orgs) and Lightning
Important: When you select the tables to sync, determine whether check marks appear in Experience (not for
the Synced column. high-data-volume external
If a Synced check mark appears, your org has an external object whose object name matches objects)
the table name. If you select the table and click Sync: Available in: Developer
• The external object is overwritten. Edition
• Any custom field on the external object is overwritten if its API name (for example, Available for an extra cost
Email__c) associates it with a table column name (for example, Email). in: Enterprise, Performance,
and Unlimited Editions
• Any other custom fields on the external object remain as they are, including:
– Previously synced custom fields whose API names were changed by editing their
Field Name values.
– Manually added custom fields whose API names aren’t associated with table column
names.

If no Synced check mark appears, and you sync the table, a new external object is created in
your org. The new external object’s object name matches the table name.
For example, if the table name is changed on the external system to no longer match the
object name of the external object, syncing that table creates a new external object in
Salesforce. We recommend that you change the object name of the existing external object
to match the new table name on the external system before you sync that table.

928
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Also review the considerations that apply to all Salesforce Connect adapters.

SEE ALSO:
Sync an External Data Source for Salesforce Connect
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Define an External Data Source for Salesforce Connect OData 4.01 Adapter
OData Adapters for Salesforce Connect
OData Type Mapping

OData Producer Considerations for Salesforce Connect OData Adapters

Understand the limits and recommendations for the remote data service that exposes the external
EDITIONS
data via OData 2.0, 4.0, and 4.01 to your Salesforce org.
• Validate your OData producer by using the Open Data Protocol Service Validation Tool at Available in: both Salesforce
services.odata.org/validation. Doing so checks your implementation against Classic and Lightning
the OData specification and identifies potential issues. Experience
• To improve performance over low-bandwidth connections, set up your OData producer to Available in: Developer
receive gzip-compressed data. Then, in the external data source definition for OData 2.0 or 4.0, Edition
select Compress Requests. You can also set up the OData producer to send gzip-compressed
Available for an extra cost
data to Salesforce, which automatically accepts gzip-compressed responses. in: Enterprise, Performance,
• By default, Salesforce sends each OData request with one of the following system query options and Unlimited Editions
so that the response includes the total row count of the result set.
– $inlinecount=allpages for the OData 2.0 adapter
– $count=true for the OData 4.0 adapter
– $count=true hard coded for 4.01 adapter
Some external systems don’t support these system query options. If you receive errors or notice long load times when you try to
access their data, deselect Request Row Counts for OData 2.0 or 4.0, on the external data source. If you do so, the external data
source and its associated external objects can’t support the following functionality, which requires the total row count.
– SOQL COUNT() aggregate function
– Batch Apex with Database.QueryLocator
For details about OData URI conventions, go to www.odata.org.

• Configure your OData producer to use a page size that’s large enough to avoid excessive round trips. Querying a large set of data
with a small page size can take a long time because of network latency. Salesforce pages that display external data can take a long
time to load.
For example, if the query results include 100 records, and the page size holds only 5 records, it takes 20 round trips to retrieve the
results. If the network latency is 100 ms per round trip, it takes 2 seconds (20 × 100 ms) to retrieve the results.
In contrast, if the page size holds 20 records, it takes only five round trips to retrieve the 100 records. With the same network latency
of 100 ms per round trip, it takes 0.5 seconds (5 × 100 ms) to retrieve the results.

• If your external data source uses the OData 4.0 adapter and JSON format, make sure that the OData producer accepts headers that
contain the odata.metadata=full format parameter. Other variations, including odata.metadata=minimal, aren’t
supported for OData 4.0 adapter.

929
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

• If external object records don’t appear in your org, make sure that the OData producer doesn’t change the values specified in the
OData query filters. When your org sends OData queries that specify field values with the $filter equals (eq) operator, the
OData producer must return those same field values in the resulting data rows.

SEE ALSO:
OData Adapters for Salesforce Connect
OData Query String Options
OData Type Mapping

High Data Volume Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters
If your org hits rate limits when accessing external objects, consider selecting the High Data Volume
EDITIONS
option on the associated external data sources. Doing so bypasses most rate limits, but some special
behaviors and limitations apply. Available in: both Salesforce
• The following features aren’t available for external objects that are associated with Classic (not available in all
high-data-volume external data sources. orgs) and Lightning
Experience (not for
– Access via Lightning Experience
high-data-volume external
– Access via the Salesforce mobile app objects)
– Appearance in Recent Items lists
Available in: Developer
– Record feeds Edition
– Reports and dashboards Available for an extra cost
– Writable external objects in: Enterprise, Performance,
and Unlimited Editions
• Salesforce IDs aren’t assigned to external object records that are associated with
high-data-volume external data sources.
• On record detail pages for external objects that are associated with high-data-volume external data sources, custom buttons, and
links that call JavaScript aren’t supported.
• Salesforce Console in Salesforce Classic doesn’t support external objects that are associated with high-data-volume external data
sources.
• CSRF protection for writable external objects isn’t available for high-data-volume external data sources.

SEE ALSO:
REST API Developer Guide : List Organization Limits
CSRF Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter

930
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Socrata™ Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters

Socrata Open Data Protocol™ is commonly used for health data and for collaboration between
EDITIONS
governments and their citizens. Salesforce Connect can access data from endpoints that are backed
by Socrata Open Data Portal. To accommodate Socrata-specific requirements, set the Special Available in: both Salesforce
Compatibility field on the external data source to Socrata. Classic (not available in all
Socrata doesn’t support the row identifier (_id) column in $select or $orderby clauses in orgs) and Lightning
OData queries. When Socrata is selected in the Special Compatibility field: Experience (not for
high-data-volume external
• OData queries don’t include the _id column in $select clauses. objects)
• If an _id column is synced from a Socrata endpoint, the resulting custom field on the external
Available in: Developer
object isn’t sortable.
Edition
• If you manually define an external object’s custom field with _id as the External Column
Available for an extra cost
Name, make sure that you select the Sorting Disabled attribute for that custom field.
in: Enterprise, Performance,
If you modify the Special Compatibility field on an external data source, we recommend and Unlimited Editions
that you resync its external objects. Or instead, you can test whether queries or user access to the
external objects result in errors, and resync only the problematic external objects.

SEE ALSO:
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Considerations for Salesforce Connect OData Adapters

CSRF Considerations for Salesforce Connect—OData 2.0 and 4.0 Adapters

Understand the special behaviors, limitations, and recommendations for Cross-Site Request Forgery
EDITIONS
(CSRF) on OData external data sources.
• CSRF protection isn’t available for high-data-volume external data sources. Available in: both Salesforce
• Make sure that the URL of the external data source starts with https:// so that secure HTTP Classic (not available in all
orgs) and Lightning
can prevent unauthorized access to the anti-CSRF token and cookie.
Experience (not for
• In addition to enabling CSRF protection on the external data source, we recommend keeping high-data-volume external
CSRF protection enabled in your org’s session security settings. These session settings are objects)
enabled by default, and keeping them enabled protects your Salesforce data and your external
data from CSRF attacks. Available in: Developer
Edition
– Enable CSRF protection on GET requests on non-setup pages
Available for an extra cost
– Enable CSRF protection on POST requests on non-setup pages in: Enterprise, Performance,
and Unlimited Editions
SEE ALSO:
Define an External Data Source for Salesforce Connect—OData 2.0 or 4.0 Adapter
Modify Session Security Settings

931
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Picklist Considerations for Salesforce Connect OData Adapters

Special behaviors and limitations apply to picklist fields on external objects for OData 2.0, 4.0, and
EDITIONS
4.01 adapters.
• Global and local single-select picklists are supported. Available in: both Salesforce
• You must manually update picklist values to stay in sync between your org and the external Classic (not available in all
system. If values aren’t in sync, your users could see an error message when viewing the field. orgs) and Lightning
Experience (not for
– Add values to the picklist as you would a picklist on a custom object. high-data-volume external
– Remove a value from a picklist by deactivating the value rather than deleting it. objects)
– Replace a value by deactivating it and then adding the new value. Update the external Available in: Developer
system’s record values to the new value on the external system. Edition
• Convert existing external object text fields to picklists by deleting and recreating. Delete the Available for an extra cost
text field and create a picklist pointing to the text field’s existing External Column Name. in: Enterprise, Performance,
and Unlimited Editions
• If you select to delete, you may be prompted to replace the value with another value. No replace
occurs for external object record values. You must manually change the values on the external
system.
• We recommend having only unrestricted picklists on external objects, even when they’re associated with restricted picklists on the
provider org. Restricted picklists on the provider org block unapproved values from the subscriber org, eliminating the need to
restrict picklists on external objects.

SEE ALSO:
Picklist Considerations for Salesforce Connect—Cross-Org Adapter

OData Reference for Salesforce Connect OData Adapters

Get to know the Salesforce implementation of the OData protocol for accessing external systems
EDITIONS
with Salesforce Connect.
Available in: both Salesforce
OData Type Mapping Classic (not available in all
Salesforce Connect maps OData types to Salesforce metadata field types when syncing metadata orgs) and Lightning
and converting values between Salesforce and external systems. Experience (not for
high-data-volume external
OData Query String Options objects)
The OData adapters for Salesforce Connect use a subset of the OData 2.0 and 4.0 and 4.01
system functions and filter expression constructs to query external systems. Available in: Developer
Edition
Available for an extra cost
SEE ALSO: in: Enterprise, Performance,
OData Adapters for Salesforce Connect and Unlimited Editions

932
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData Type Mapping

Salesforce Connect maps OData types to Salesforce metadata field types when syncing metadata
EDITIONS
and converting values between Salesforce and external systems.
Available in: both Salesforce
OData 2.0 Type Mapping Classic (not available in all
Understand how the OData 2.0 adapter for Salesforce Connect maps OData types to Salesforce orgs) and Lightning
metadata field types. Experience (not for
high-data-volume external
OData 4.0 and 4.01 Type Mapping objects)
Understand how the OData 4.0 and 4.01 adapters for Salesforce Connect maps OData types to
Salesforce metadata field types. Available in: Developer
Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

OData 2.0 Type Mapping

Understand how the OData 2.0 adapter for Salesforce Connect maps OData types to Salesforce
EDITIONS
metadata field types.
Salesforce Connect supports only the following types when syncing metadata and converting Available in: both Salesforce
values between Salesforce and an external system. Classic (not available in all
orgs) and Lightning
Experience (not for
OData 2.0 Primitive Types high-data-volume external
objects)
OData 2.0 Type Salesforce Metadata Field Type
Available in: Developer
Binary TextArea Edition
Boolean Checkbox Available for an extra cost
in: Enterprise, Performance,
Byte Number and Unlimited Editions
DateTime DateTime

DateTimeOffset DateTime

Decimal Number

Double Number

Guid Text

Int16 Number

Int32 Number

Int64 Number

SByte Number

Single Number

933
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData 2.0 Type Salesforce Metadata Field Type

String Depends on the declared maximum length of the OData string column.

OData Declared Maximum Salesforce Field Type Salesforce Field Length

Length Attribute
Not declared Text 128 characters

255 or fewer characters Text Same as declared

More than 255 characters LongTextArea Same as declared

Time Text

Tip: A binary value from an external system is represented in Salesforce as a base64-encoded string. You can convert it to a value
of type Blob by using the EncodingUtil.base64Decode(inputString) Apex method.

OData 2.0 Complex Types

Salesforce Connect supports OData complex types as follows.

SEE ALSO:
Sync an External Data Source for Salesforce Connect
Custom Field Types
Custom Field Attributes
OData Reference for Salesforce Connect OData Adapters
Apex Developer Guide : EncodingUtil Class: base64Decode(inputString)

OData 4.0 and 4.01 Type Mapping

Understand how the OData 4.0 and 4.01 adapters for Salesforce Connect maps OData types to
EDITIONS
Salesforce metadata field types.
Salesforce Connect supports only the following types when syncing metadata and converting Available in: both Salesforce
values between Salesforce and an external system. Classic (not available in all
orgs) and Lightning
Experience (not for
OData 4.0 and 4.01 Primitive Types high-data-volume external
objects)
OData 4.0 and Salesforce Metadata Field Type
4.01 Type Available in: Developer
Edition
Binary TextArea
Available for an extra cost
Boolean Checkbox in: Enterprise, Performance,
and Unlimited Editions
Byte Number

Date DateTime with time properties set to 0

934
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData 4.0 and 4.01 Type Salesforce Metadata Field Type

DateTimeOffset DateTime

Decimal Number

Double Number

Guid Text

Int16 Number

Int32 Number

Int64 Number

Byte Number

Single Number

String Depends on the declared maximum length of the OData string column.

OData Declared Maximum Salesforce Field Type Salesforce Field Length

Length Attribute
Not declared Text 128 characters

255 or fewer characters Text Same as declared

More than 255 characters LongTextArea Same as declared

Tip: A binary value from an external system is represented in Salesforce as a base64-encoded string. You can convert it to a value
of type Blob by using the EncodingUtil.base64Decode(inputString) Apex method.

OData 4.0 and 4.01 Complex Types

Salesforce Connect supports OData complex types as follows.

SEE ALSO:
Sync an External Data Source for Salesforce Connect
Custom Field Types
Custom Field Attributes
OData Reference for Salesforce Connect OData Adapters
Apex Developer Guide : EncodingUtil Class: base64Decode(inputString)

935
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData Query String Options

The OData adapters for Salesforce Connect use a subset of the OData 2.0 and 4.0 and 4.01 system
EDITIONS
functions and filter expression constructs to query external systems.
Salesforce automatically creates the OData queries so that you, as an administrator or developer, Available in: both Salesforce
don’t have to. However, understanding how OData queries are generated—or even attempting Classic (not available in all
manual OData queries—can help you troubleshoot issues with the external system’s OData producer. orgs) and Lightning
For details about each system query option, go to www.odata.org. Experience (not for
high-data-volume external
Salesforce Connect supports only the following OData system query options. All other options in objects)
the OData 2.0, 4.0, and 4.01 specifications are unused.
Available in: Developer
• $count (OData 4.0 and 4.01)
Edition
• $filter
Available for an extra cost
• $inlinecount (OData 2.0 only) in: Enterprise, Performance,
• $orderby and Unlimited Editions
• $search (OData 4.0 and 4.01)
• $select
• $skip
• $top
A query search string to an external system is sent as a case-sensitive single phrase after removing all ASCII punctuation characters except
hyphens (-). For example, if the search string is Sales & Marketing, the external system receives Sales Marketing.

$count (OData 4.0 and 4.01)

Specifies that the response must include the number of rows that the URI identifies after $filter system query options are applied,
but before $top and $skip system query options are applied.
For OData 4.01, $count=true is hard coded and for OData 4.0, $count=true when Request Row Counts is enabled on
the external data source. The total items in the result set is the same as the LIMIT value in the query for values less than 202. If the LIMIT
value is greater than 202, then 202 items are returned to indicate that more records exist in the next batch. For OData 4.0, if Request
Row Counts is disabled, Salesforce includes $count=false in all OData 4.0 queries of the external data source, and 2000 items
are returned in each result set.

Examples
User action in View or access an external object.
Salesforce

SOQL query Any SOQL query of an external object

Resulting OData http://services.example.org/my.svc/Suppliers?$select=SupplierID&

query $count=true&$top=26

$filter
Filters the collection of resources that’s addressed by a request URL. The response contains the results that evaluate to true.

936
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Examples
User action in Open a list view of cities from supplier records that are filtered so that the country is USA.
Salesforce

SOQL query SELECT City__c FROM Suppliers__x WHERE Country__c = 'USA' ORDER BY
City__c ASC LIMIT 26

Resulting OData http://services.example.org/my.svc/Suppliers?$orderby=City&

query $select=City,SupplierID&$inlinecount=allpages&$filter=Country+eq+'USA'&
$top=26

$inlinecount (OData 2.0 only)

Specifies that the response must include a count of the number of rows that the URI identifies after $filter system query options
are applied but before $top and $skip system query options are applied.
When Request Row Counts is enabled on the external data source, Salesforce uses $inlinecount in all OData 2.0 queries
of that external data source to determine the total number of items in each result set. If Request Row Counts is disabled,
$inlinecount is excluded from all OData 2.0 queries of the external data source.

Examples
User action in View or access an external object.
Salesforce

SOQL query Any SOQL query of an external object.

Resulting OData http://services.example.org/my.svc/Suppliers?$select=SupplierID&

query $inlinecount=allpages&$top=26

$orderby
Sorts the result set in ascending or descending order. The fields in the ORDER BY clause of the SOQL query don't always match the
properties used by the $orderby option in the resulting OData query. If you use the OFFSET clause in the SOQL query, the entity key
property is added in the resulting OData query.

Examples
User action in Open a list view of supplier records that are ordered by company name.
Salesforce

SOQL query SELECT CompanyName__c,ContactName__c FROM Suppliers__x ORDER BY

CompanyName__c ASC LIMIT 26

Resulting OData http://services.example.org/my.svc/Suppliers?$orderby=CompanyName&

query $select=CompanyName,ContactName,SupplierID&$inlinecount=allpages&$top=26

937
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

$search (OData 4.0 and 4.01)

Requests entities that match the search query string as a free-text search expression. For OData 4.0, enable this option by selecting Use
Free-Text Search Expressions on the external data source. By default, Use Free-Text Search Expressions
isn’t enabled. The search query string is used as the contains value in the $filter system query option.

Examples
User action in View or access an external object.
Salesforce

SOQL query Any SOQL query of an external object

Resulting OData http://services.example.org/my.svc/Shippers?

query $select=CompanyName,Phone,ShipperID&$count=true&$search=Acme&$top=25

$select
Requests a limited set of properties for each entity.

Examples
User action in Open a list view of supplier records where the page layout displays the company name and contact name.
Salesforce

SOQL query SELECT CompanyName__c,ContactName__c FROM Suppliers__x ORDER BY

CompanyName__c ASC LIMIT 26

Resulting OData http://services.example.org/my.svc/Suppliers?$orderby=CompanyName&

query $select=CompanyName,ContactName,SupplierID&$inlinecount=allpages&$top=26

$skip
Specifies the number of items in the queried collection to skip in the result set.

Examples
User action in Click to view the second page of a list view of supplier records that are ordered by city.
Salesforce

SOQL query SELECT City__c,CompanyName__c FROM Suppliers__x ORDER BY City__c ASC

OFFSET 25

Resulting OData http://services.example.org/my.svc/Suppliers?$orderby=City&

query $select=City,CompanyName,SupplierID&$inlinecount=allpages&$top=25&
$skip=25

$top
Specifies the number of items in the queried collection to include in the result. The value in the LIMIT clause of a SOQL query doesn’t
always match the requested $top value, because the latter is modified as needed for client-driven paging and queryMore() calls.

938
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Examples
User action in Open a list view of the top 25 supplier records.
Salesforce

SOQL query SELECT SupplierID__c FROM Suppliers__x LIMIT 25

Resulting OData http://services.example.org/my.svc/Suppliers?$select=SupplierID&

query $inlinecount=allpages&$top=25

OData 2.0 Query Options

By default, the search query string is used as the substringof value in the $filter system query option.
OData 4.0 Query Options
By default, the search query string is used as the contains value in the $filter system query option.

SEE ALSO:
OData Producer Considerations for Salesforce Connect OData Adapters
OData Reference for Salesforce Connect OData Adapters
Client-Driven and Server-Driven Paging for Salesforce Connect OData Adapters

OData 2.0 Query Options

By default, the search query string is used as the substringof value in the $filter system
EDITIONS
query option.
In this example, the search query string is Acme. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Experience (not for
high-data-volume external
objects)

Available in: Developer

Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

http://services.example.org/my.svc/Shippers?
$select=CompanyName,Phone,ShipperID&$inlinecount=allpages&
$filter=substringof('Acme',CompanyName)+eq+true+
or+substringof('Acme',Phone)+eq+true&$top=25

939
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

OData 2.0 Custom Query Option

We recommend that you set up the OData producer to support free text search expressions with the custom query option. You can then
specify the name of the query string parameter in the Custom Query Option for Salesforce Search field on the
external data source. In this example, the custom query parameter is doSearch and the search query string is Acme.
http://services.example.org/my.svc/Shippers?
$select=CompanyName,Phone,ShipperID&
$inlinecount=allpages&doSearch=Acme&$top=25

Learn more about OData URI conventions at www.odata.org.

OData 4.0 Query Options

By default, the search query string is used as the contains value in the $filter system query
EDITIONS
option.
In the following example, the search query string is Acme. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Experience (not for
high-data-volume external
objects)

Available in: Developer

Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

http://services.example.org/v4.svc/Shippers?
$select=CompanyName,Phone,ShipperID&$count=true&
$filter=contains(CompanyName,'Acme') eq true
or contains(Phone,'Acme') eq true$top=25&

OData 4.0 Custom Query Option

We recommend that you set up the OData producer to support free text search expressions with the $search system query option.
You can then select Use Free-Text Search Expressions on the external data source.
http://services.example.org/v4.svc/Shippers?
$select=CompanyName,Phone,ShipperID&$count=true&
$search=Acme&$top=25

Learn more about OData URI conventions at www.odata.org.

Use External Change Data Capture to Track Data Changes on External Objects
With External Change Data Capture, you can track changes to data that is stored outside your Salesforce org when using the Odata 4.0
adapter. You can then build automation in response to the changes to increase productivity or provide a better customer experience.
The external data change tracking feature polls the external system at configurable intervals (5–30 minutes) for tracked changes. For
each external object that has the feature enabled, a topic channel and an associate change event entity are created where change event

940
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

notifications are published. You add a subscriber to each topic channel and then process the data changes through Streaming API. You
can also add an Apex trigger that is called when change event notifications are published.

External Change Data Capture Considerations

Keep these considerations in mind when working with External Change Data Capture.
Enable External Change Data Capture and Tracking
Enable external change data capture for the data source and each external object that you want to monitor.
Subscribe to Change Events
You can use Apex triggers to subscribe to change events. Or you can use a Bayeux client to subscribe to Streaming API on the
publication channel.
Check the External Change Data Capture Status for an External Object
You can quickly check the change-tracking status from an external object’s detail page. More detailed monitoring is also available.
Change the Polling Interval for External Change Data Capture
By default, the external change data capture feature polls the external system every 30 minutes for tracked changes. You can change
the interval to poll the external system as frequently as every 5 minutes.
Monitor and Troubleshoot External Change Data Capture
Check these tips when troubleshooting change tracking on external objects.
Example: How Codey Outfitters Uses External Change Data Capture
The fictitious company, Codey Outfitters, distributes outdoor equipment from local small businesses to outdoor enthusiasts around
the world. The company handles all logistics, such as complying with import laws for each state and country.

External Change Data Capture Considerations

Keep these considerations in mind when working with External Change Data Capture.
• Each polling request counts toward your Salesforce org’s OData callout rate allocation.
• OData doesn’t differentiate between created and updated change events. Both events are published with update change type.
• When you enable change tracking, a $top=0 query for zero rows is sent to the external data source to tell it to track changes, and a
delta link is returned.
• If an error occurs, Salesforce stops sending polling requests. You can check for an error status by querying the BackgroundOperation
object or viewing the latest error on the object’s setup page.
• If you create an Apex trigger to respond to change events, these requirements and behaviors apply.
– Create the Apex trigger with development tools, such as the Developer Console or Metadata API or Salesforce UI. You can’t
create the trigger from the Salesforce UI.
– Because the Apex trigger runs after an event occurs, only the after-insert trigger event is supported.
– The trigger passes the associated change event, not the object that caused the change.
– Changed records can be committed in the same transaction that started the trigger. However, keep in mind that this transaction
is separate from the transaction that created the original event.

941
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Enable External Change Data Capture and Tracking

Enable external change data capture for the data source and each external object that you want
USER PERMISSIONS
to monitor.
1. From Setup, enter External Data Sources in the Quick Find box, then select External To create or edit external
objects:
Data Sources.
• Customize Application
2. Click Edit, and select Eligible for External Change Data Capture.
3. Click Save.
4. From the External Objects list , select the external object that you want to track.
5. Click Edit, and select Track Data Changes.
6. Click Save.
After you enable change tracking, a publication channel is created under the topic for the external object. For example, /data/Object
Name__ChangeEvents appears as /data/Products__ChangeEvents, where Product is the object name.

Subscribe to Change Events

You can use Apex triggers to subscribe to change events. Or you can use a Bayeux client to subscribe to Streaming API on the publication
channel.
After subscribing, you can observe change event notifications when you perform a DML operation on an external object. You can also
see change events on the tracked data stored on the external system.

Check the External Change Data Capture Status for an External Object
You can quickly check the change-tracking status from an external object’s detail page. More
USER PERMISSIONS
detailed monitoring is also available.
1. From Setup, enter External Objects in the Quick Find box, then select External Objects. To create or edit external
objects:
2. Click the label of the external object. • Customize Application
The External Change Data Capture Status field shows one of the following statuses.
• Disabled—Either the data source or the external object doesn’t have external change data
capture enabled.
• Error—External change data capture encountered an error in the last poll for changes and stopped. After resolving the error,
restart external change data capture.
• Running—External change data capture is running and polls the external system in the configured time interval for changes.
• Stopped—External change data capture is not scheduled to poll for changes.

Change the Polling Interval for External Change Data Capture

By default, the external change data capture feature polls the external system every 30 minutes for tracked changes. You can change
the interval to poll the external system as frequently as every 5 minutes.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Data Sources.
2. Next to the name of the external data source, click Edit.
3. In the Polling Interval for External Change Data Capture field, enter the number of seconds between polling.
4. Click Save.

942
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Monitor and Troubleshoot External Change Data Capture

Check these tips when troubleshooting change tracking on external objects.
• To check the status of external data change tracking, query the BackgroundOperation object.
• Each BackgroundOperation record is available for inspection for one day. You can include the ExpiresAt field in your SOQL query of
the BackgroundOperation object to check when the record expires.
• Set up and view debug logs.

Example: How Codey Outfitters Uses External Change Data Capture

The fictitious company, Codey Outfitters, distributes outdoor equipment from local small businesses to outdoor enthusiasts around the
world. The company handles all logistics, such as complying with import laws for each state and country.
Over the years, Codey Outfitters has acquired different IT systems to manage orders, shipments, inventory, and billing. It uses Salesforce
CRM to manage its customer base and the suppliers whose items it sells. Codey Outfitters wants to provide customers with a one-stop
shopping portal where they can see price changes on the gear.
When the inventory is updated, Codey Outfitters wants the change notifications sent to its Salesforce org. Salesforce then performs
business logic to determine whether the updates include price changes that are valuable to customers based on their order history.
Customers can see or be notified about relevant deals on their Codey Outfitters portal.
Let’s see how Codey Outfitters sets up and uses external change data capture to accomplish these goals.

Set Up the External Data Source and the External Object

Codey Outfitters has an OData 4.0 service for its inventory. The company connects its Salesforce org to the inventory by creating an
external data source called Gear Inventory and creating an external object called Products.
Monitor External Change Data Capture
With external change data capture enabled, Codey Outfitters’ org polls the external system every 30 minutes. To monitor the tracking
status, it queries the BackgroundOperation object. Codey Outfitters prefers to run SOQL queries in the Query Editor of the Developer
Console, but you can use your preferred tool.
Subscribe to Changes with Streaming API
When Codey Outfitters runs its Bayeux client, the client subscribes to Streaming API on the products publication channel.
React to Changes with Apex Triggers
To automate your business with external change events, use Apex triggers.

Set Up the External Data Source and the External Object

Codey Outfitters has an OData 4.0 service for its inventory. The company connects its Salesforce org to the inventory by creating an
external data source called Gear Inventory and creating an external object called Products.
The Products external object provides the following data.
• Name (product name)
• UnitPrice (current price)
• Stock (number of items in stock)
• OrderLimit (limit for each order)
To track changes, Codey Outfitters selects Eligible for External Change Data Capture for the Gear Inventory external data source. It
then enables Track Data Changes on the Products external object.

943
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Monitor External Change Data Capture

With external change data capture enabled, Codey Outfitters’ org polls the external system every 30 minutes. To monitor the tracking
status, it queries the BackgroundOperation object. Codey Outfitters prefers to run SOQL queries in the Query Editor of the Developer
Console, but you can use your preferred tool.
Here’s the SOQL query that Codey Outfitters uses to monitor the tracking status.
SELECT Id,Name,SubmittedAt,StartedAt,FinishedAt,ProcessAfter,Status
FROM BackgroundOperation WHERE WorkerUri='v45.0/xds/data-changes'

In the query results, the first row shows the initial callout to the external system. The initial request tells the OData producer to start
tracking changes on the Products__x object. In the second row, the org schedules the next callout to request the tracked changes.
Notice that the callout is scheduled to occur after 30 minutes have passed.

ID Name Submitted Started Finished Process After Status

08Pxx0000000019EAA Products__x 2017-10-06T01:11:04.000Z 2017-10-06T01:11:08.000Z 2017-10-06T01:11:08.000Z Complete

08Pxx000000000qEAA Products__x 2017-10-06T01:11:08.000Z 2017-10-06T01:41:08.000Z Waiting

After waiting 30 minutes, querying the BackgroundOperation object shows that the second callout finishes, and the status is Complete.
In the third row, a new change request is scheduled to run after 30 more minutes have passed.

ID Name Submitted Started Finished Process After Status

08Pxx0000000019EAA Products__x 2017-10-06T01:11:04.000Z 2017-10-06T01:11:08.000Z 2017-10-06T01:11:08.000Z Complete

08Pxx000000000qEAA Products__x 2017-10-06T01:41:09.000Z 2017-10-06T01:41:09.000Z 2017-10-06T01:41:09.000Z 2017-10-06T01:41:08.000Z Complete

08Pxx000000002MEAQ Products__x 2017-10-06T01:41:09.000Z 2017-10-06T02:11:09.000Z Waiting

Suppose that the Codey Outfitters inventory has a service outage, preventing the scheduled poll request from succeeding. Errors cause
change tracking to stop, so querying the BackgroundOperation object shows the error status and no new rows.

ID Name Submitted Started Finished Process After Status

08Pxx0000000019EAA Products__x 2017-10-06T01:11:04.000Z 2017-10-06T01:11:08.000Z 2017-10-06T01:11:08.000Z Complete

08Pxx000000000qEAA Products__x 2017-10-06T01:41:09.000Z 2017-10-06T01:41:09.000Z 2017-10-06T01:41:09.000Z 2017-10-06T01:41:09.000Z Complete

08Pxx000000002MEAQ Products__x 2017-10-06T01:41:09.000Z 2017-10-06T02:12:07.000Z 2017-10-06T02:12:07.000Z 2017-10-06T02:11:09.000Z Error

When query results show no rows in Waiting status, external change data capture is disabled. When the query results show an error,
you can get error details by including the Error field in your SOQL query of the BackgroundOperation object. Here’s how Codey Outfitters
investigates the error.
SELECT Error FROM BackgroundOperation WHERE Id=’08Pxx000000002MEAQ’

944
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Because a service outage caused the problem, the error message says:
The external system is unreachable. Try again later, or contact your admin, who can verify
the external data source settings and the external system's availability. Attempted to
reach this URL: https://codey-outfitters.example.com/inventory/Products

Codey Outfitters fixes the service outage and restarts change tracking on the Products__x object.

Subscribe to Changes with Streaming API

When Codey Outfitters runs its Bayeux client, the client subscribes to Streaming API on the products publication channel.
Codey Outfitters uses a Visualforce page to show its customers updates to prices and inventory and new and discontinued outdoor gear.
This sample source code for the Visualforce page is on Github, and you can modify it to work with your OData 4.0 producer.
The heart of the subscription mechanism is in the _subscribeChannels method in src/js/channel/ServerConnection.js.
cometd.subscribe(channelName, function(event) {
if (event && event.data && event.data.payload &&
event.data.payload.ChangeEventHeader) {
var header = event.data.payload.ChangeEventHeader;
var entityName = header.entityName;
var recordId = header.recordIds[0];
var timestamp = header.commitTimestamp;
var changeType = header.changeType;

switch (changeType) {
case "UPDATE":
// Update logic ...
break;
case "CREATE":
// Create logic
break;
case "DELETE":
// Delete logic
break;
}
}
}

The channelName for Codey Outfitters’ products is /data/Products__ChangeEvent. Each change event notification that’s published on
the channel is in the Bayeux format and represents an updated record in the product inventory. The data.payload contains the change
event data and includes a header that describes the nature of the change event. This sample event notification describes a change to a
Codey Outfitters product record.
{
schema=”lswW55LyUCYeU7raSrmZ5A”,
payload={
ChangeEventHeader={
commitUser=”005xx000001SvAn”,
sequenceNumber=15,
entityName=”Products__x”,
changeType=”UPDATE”,
changeOrigin=”Products?$deltaToken=3779”,
transactionKey=”f158f145-a...”,
commitTimestamp=1507759119826,

945
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

recordIds=[“x03xx0000000008”]
},
Name__c=”Camping Stove”,
ExternalId=7801,
UnitPrice__c=10.0,
Stock__c=1500.0,
OrderLimit__c=12.0,
ProductId__c=7801.0
},
event={replayId=15}
}

Each change event notification has this structure.

Field Description
schema Versioned schema reference that defines the change event.

payload Details about the change event.

• ChangeEventHeader—Describes the nature of the data change
event.
• Record fields and values—The OData producer can also include
fields that have no changed values. To see the current values,
query the external object using the record ID in the change
event header.

event The replay ID that refers to the position of the event notification
in the event stream on a channel.

Each change event header contains these fields.

Field Description
commitUser User who publishes the event.

sequenceNumber Change event sequence number. Each change occurs in the order
in which it’s received.

entityName API name of the external object.

changeType Specifies whether a record was updated, created, or deleted.

changeOrigin Delta link that’s used to request the change. The OData producer
calculates the delta token while executing the previous change
request.

transactionKey Unique identifier for the transaction.

commitTimestamp Specifies when the change event notification is published in

milliseconds since January 1, 1970.

946
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
recordIds Salesforce ID of the external object record that’s updated, created,
or deleted. To see the current values of the record’s fields, query
the external object using this record ID.

nulledFields List of fields set to null.

React to Changes with Apex Triggers

To automate your business with external change events, use Apex triggers.
Codey Outfitters can customize Salesforce to send email or SMS notifications on items that are low on stock or have been updated to
an attractive price. Gear and other items that are in high demand can be monitored for low stock and automatically ordered. Before
customizing Salesforce, make sure that you’re tracking data changes on the external object that you want to track. To track items that
are running low on stock, Codey Outfitters creates an Apex trigger named LowOnStock. Next, the company selects the trigger’s sObject
and the change event that publishes changes for the external object Products__x: Products__ChangeEvent.
Here’s an example of a simple rule that sends a notification when an item is low on stock.
trigger LowOnStock on Products__ChangeEvent (after insert) {
// Get the change event’s product ID for added and updated products
Set<Id> productIds = new Set<Id>();
for (Products__ChangeEvent event: Trigger.new) {
if (event.ChangeEventHeader.getChangeType() != 'DELETE') {
String productId = event.ChangeEventHeader.getRecordIds()[0];
productIds.add(productId);
}
}
if (productIds.size() > 0) {
ProductNotifications.notifyOnLowOnStockProductUpdates(productIds);
}
}

The product notifications class queries the external Product objects for the given changed product IDs and LowOnStock threshold value.
Looking up the current Product records on the external system for qualifying products is a callout and is scheduled as an Apex future.
public class ProductNotifications {
// Notify subscribers on product updates that are low on stock.
// This method is run asynchronously as it is performing a callout to the external
// system to get the latest product details
@future (callout=true)
public static void notifyOnLowOnStockProductUpdates(Set<Id> productIds) {
// Look up the current stock threshold to filter the products with
Integer productStockThreshold = ...;
List<Products__x> lowOnStockProducts =
getProductsLowOnStock(productIds, productStockThreshold);
// Notify subscribers
notifySubscribers(lowOnStockProducts,
‘These items are running out of stock. Act soon!’);
}

// Get the external Product objects for each Product ID

public static List<Products__x>
getProductsLowOnStock(Set<Id> productIds, Integer productStockThreshold) {

947
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

return [SELECT Id, ExternalId, Name__c, ProductId__c, Stock__c, UnitPrice__c

FROM Products__x
WHERE Stock__c < :productStockThreshold AND Stock__c > 0 AND
Id IN :productIds];
}

// Notify subscribers by sending an email or SMS

public static void notifySubscribers(String message, List<Products__x> products) {
...
}
}

You can discover the metadata for change events through the sObject describe API. For example, the sObject describe for
Products__ChangeEvent shows the following standard change event fields.

Field Type Description

Id String The change event’s Salesforce ID. This ID
isn’t the Salesforce ID of the record that
changed, but the event that carries the
record’s changes.

ReplayId String The position of the event notification in the

event stream on a channel.

ChangeEventHeader Complex Type The type of data change event.

Each change event object defines fields that hold the updated value at the time the record was updated. The OData producer can also
include fields that haven’t changed. To see the current values, query the external object using the record ID in the change event header.
The following table shows sample Products__x fields. Event change objects are tailored to their tracked external object. For a change
event, not all fields are necessarily present.

Field Type Description

Id String Product record’s Salesforce ID in your org

ExternalId String Product record’s external ID

DisplayUrl String URL representing the record in the external

system

CreatedOn__c DateTime When the record was created in the external

system

UpdatedOn__c DateTime When the record was last updated on the

external system

Name__c String Product name in Product__x

OrderLimit__c Integer Number of items that can be ordered at a

time

Stock__c Integer Number of items in stock

948
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Type Description

UnitPrice__c Decimal(8,2) Item’s unit price

The following fields are change event header complex type fields. To access ChangeEventHeader fields from Apex, use its getter method.
For example, to access the field ChangeType, use eventObject.ChangeEventHeader.getChangeType().

Field Type Description

commitUser String User who published the event.

sequenceNumber Integer Change event sequence number. Each

change is listed in the order in which it’s
received.

entityName String API name of the external object.

changeType ChangeType enum Specifies whether a record was updated,

created, or deleted. The enum values for
external change events are Create,
Update, and Delete.

changeOrigin String Delta link that’s used to request the changes

made since the previous or initial change
request. The OData producer calculates the
delta token while executing the previous
change request.

transactionKey String Unique identifier for the transaction.

commitTimestamp Long Specifies when the change event

notification is published in milliseconds
since January 1, 1970.

recordIds Array of type String Salesforce ID of the external object record

that is updated, created, or deleted. To see
the current values of the record fields, query
the external object using this record ID. This
array always has exactly one Salesforce ID.

nulledFields Array of type String List of field names set to null.

Access External Data with a Custom Adapter for Salesforce Connect

Connect your users to any data anywhere by developing your own custom adapter with the Apex Connector Framework.

Custom Adapter for Salesforce Connect

Connect to any data anywhere for a complete view of your business. Use the Apex Connector Framework to develop a custom
adapter for Salesforce Connect.

949
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Set Up Salesforce Connect to Access External Data with a Custom Adapter

Let users view, search, and modify any data anywhere from within their Salesforce org.
Considerations for Salesforce Connect—Custom Adapter
Understand the special behaviors, limits, and recommendations for using a custom adapter for Salesforce Connect.

Custom Adapter for Salesforce Connect

Connect to any data anywhere for a complete view of your business. Use the Apex Connector
EDITIONS
Framework to develop a custom adapter for Salesforce Connect.
Your users and the Lightning Platform interact with the external data via external objects. For each Available in: both Salesforce
of those interactions, Salesforce Connect invokes methods in the Apex classes that compose the Classic (not available in all
custom adapter. Salesforce invokes the custom adapter’s Apex code each time that: orgs) and Lightning
Experience (not for
• A user clicks an external object tab for a list view.
high-data-volume external
• A user views a record detail page of an external object. objects)
• A user views a record detail page of a parent object that displays a related list of child external
Available in: Developer
object records. Edition
• A user performs a Salesforce global search.
Available for an extra cost
• A user creates, edits, or deletes an external object record. in: Enterprise, Performance,
• A user runs a report. and Unlimited Editions
• The preview loads in the report builder.
• An external object is accessed via flows, processes, APIs, Apex, SOQL, or SOSL.
• You validate or sync an external data source.
Apex code can access external objects, but some limitations and requirements apply.
• To understand the limitations on Apex code accessing external objects, see Apex Considerations for Salesforce Connect External
Objects.
• To know how to use a custom adapter for Salesforce Connect, see Get Started with the Apex Connector Framework.

External IDs for External Objects in Salesforce Connect—Custom Adapter

When you access external data with a custom adapter for Salesforce Connect, the values of the External ID standard field on an
external object come from the DataSource.Column named ExternalId.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect to Access External Data with a Custom Adapter
Considerations for Salesforce Connect—Custom Adapter

950
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

External IDs for External Objects in Salesforce Connect—Custom Adapter

When you access external data with a custom adapter for Salesforce Connect, the values of the
EDITIONS
External ID standard field on an external object come from the DataSource.Column named
ExternalId. Available in: both Salesforce
Each external object has an External ID standard field. Its values uniquely identify each Classic (not available in all
external object record in your org. When the external object is the parent in an external lookup orgs) and Lightning
relationship, the External ID standard field is used to identify the child records. Experience (not for
high-data-volume external
Important: objects)
• The custom adapter’s Apex code must declare the DataSource.Column named Available in: Developer
ExternalId and provide its values. Edition
• Don’t use sensitive data as the values of the External ID standard field or fields designated Available for an extra cost
as name fields, because Salesforce sometimes stores those values. in: Enterprise, Performance,
– External lookup relationship fields on child records store and display the External ID and Unlimited Editions
values of the parent records.
– For internal use only, Salesforce stores the External ID value of each row that’s retrieved
from the external system. This behavior doesn’t apply to external objects that are
associated with high-data-volume external data sources.

Example: This excerpt from a sample DataSource.Connection class shows the DataSource.Column named
ExternalId.

override global List<DataSource.Table> sync() {

List<DataSource.Table> tables =
new List<DataSource.Table>();
List<DataSource.Column> columns;
columns = new List<DataSource.Column>();
columns.add(DataSource.Column.text('title', 255));
columns.add(DataSource.Column.text('description',255));
columns.add(DataSource.Column.text('createdDate',255));
columns.add(DataSource.Column.text('modifiedDate',255));
columns.add(DataSource.Column.url('selfLink'));
columns.add(DataSource.Column.url('DisplayUrl'));
columns.add(DataSource.Column.text('ExternalId',255));
tables.add(DataSource.Table.get('googleDrive','title',
columns));
return tables;
}

SEE ALSO:
Custom Adapter for Salesforce Connect
Apex Developer Guide

951
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Set Up Salesforce Connect to Access External Data with a Custom Adapter

USER PERMISSIONS EDITIONS

To create Apex classes: Author Apex Available in: both Salesforce

Classic (not available in all
To configure remote settings: Modify All Data
orgs) and Lightning
To create and edit external data sources: Customize Application Experience (not for
high-data-volume external
To create and edit external objects: Customize Application objects)
To define or change object-level help: Customize Application Available in: Developer
To create and edit custom fields: Customize Application Edition
Available for an extra cost
To edit permission sets and user profiles: Manage Profiles and Permission Sets
in: Enterprise, Performance,
To edit another user’s authentication settings Manage Users and Unlimited Editions
for external systems:

Let users view, search, and modify any data anywhere from within their Salesforce org.
Setting up Salesforce Connect with a custom adapter involves these high-level steps.
1. Develop the custom adapter for Salesforce Connect.
Using the Apex Connector Framework, create the DataSource.Connection and DataSource.Provider classes that
comprise the custom adapter.

2. Define remote sites for Apex callouts.

If the custom adapter involves any Apex callouts, define each callout endpoint as a remote site in your organization. However, you
don’t need to define a remote site for a callout whose endpoint is specified as a named credential instead of a URL.

3. Define an external data source of type Salesforce Connect: Custom.

If you created multiple custom adapters, make sure that the external data source’s Type field specifies the correct
DataSource.Provider class.

4. Create the external objects.

Perform this task only if you don’t sync to automatically create the external objects. Create an external object for each external data
table that you want to access from your Salesforce org.

5. Create help content for the external objects.

Create Visualforce pages that describe the external data. When your users click Help for this Page on an external object, they read
your custom help content. Remember, your users can’t find information about the external data in Salesforce Help.

6. Add custom fields and relationships to the external objects.

Create relationships between objects. If you didn’t sync to automatically create the external objects and their fields, create a custom
field for each external table column that you want to access from your Salesforce org.

7. Verify access to external object data.

Check that expected user and code interactions with the external objects work, including sorting and filtering search and query
results.

952
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Tip: After you configure an external data source, run the validator tool on each external object to test and troubleshoot its
connections. The tool tests for ID uniqueness and the ability to sort and filter results.

8. Enable user access to external objects.

Grant object permissions through permission sets or profiles.

9. Enable user access to the fields on the external objects.

Grant field permissions through permission sets or profiles.

10. If the external data source uses per-user authentication:

a. Let users authenticate to the external system.
Grant users access to authentication settings for the external data source through permission sets or profiles.

b. Set up each user’s authentication settings.

You or your users can perform this task.

Tip: Train your users on how to set up their authentication settings for external systems. Make sure that they know which
credentials to enter for each external system. If you’re using OAuth 2.0, test the OAuth flow for potentially confusing
prompts or redirects, and train your users as needed. OAuth flows vary, depending on your external system, authentication
provider, and specified scopes.

SEE ALSO:
Custom Adapter for Salesforce Connect
Salesforce Platform Features Supported by Salesforce Connect
Developer Guide: Visualforce Developer's Guide
External Object Relationships

Define an External Data Source for Salesforce Connect—Custom Adapter

Connect your Salesforce org to any data anywhere via a Salesforce Connect custom adapter that
EDITIONS
you create with the Apex Connector Framework.
Before you begin, develop the custom adapter for Salesforce Connect. If the custom adapter uses Available in: both Salesforce
Apex callouts, also define remote sites for the callout endpoints. See Set Up Salesforce Connect to Classic and Lightning
Access External Data with a Custom Adapter on page 952. Experience

1. From Setup, enter External Data Sources in the Quick Find box, then select Available in: Developer
External Data Sources. Edition
2. Click New External Data Source, or click Edit to modify an existing external data source. Available for an extra cost
in: Enterprise, Performance,
3. Complete the fields.
and Unlimited Editions

Field Description
Label A user-friendly name for the external data source. The label is displayed USER PERMISSIONS
in the Salesforce user interface, such as in list views.
To create and edit external
If you set Identity Type to Per User, this label appears when data sources:
your users view or edit their authentication settings for external • Customize Application
systems.

953
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Name A unique identifier that’s used to refer to this external data source definition through the API.
The name 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.

Type Select Salesforce Connect: Custom—<your DataSource.Provider class name>.

If you change and save a DataSource.Connection class, resave the corresponding
DataSource.Provider class. Otherwise, when you define the external data source, the
custom adapter doesn’t appear as an option for the Type field.

URL URL of the external system.

Available only when the DataSource.Provider class declares the REQUIRE_ENDPOINT
capability. If the class also declares the REQUIRE_HTTPS capability, the URL must begin with
https://.
If the endpoint is defined in a named credential, enter the named credential URL. A named
credential URL contains the scheme callout:, the name of the named credential, and an
optional path. For example: callout:My_Named_Credential/some_path.
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:
callout:My_Named_Credential/some_path?format=json.

Writable External Lets the Lightning platform and users in this org create, update, and delete records for external
Objects objects associated with the external data source. The external object data is stored outside the
org. By default, external objects are read only.

High Data Volume Salesforce enforces rate limits for retrieving and viewing data from external systems. If your org
hits rate limits when accessing external objects, consider selecting the High Data Volume option
on the associated external data sources. Doing so bypasses most rate limits, but some special
behaviors and limitations apply. See High Data Volume Considerations for Salesforce
Connect—Custom Adapters on page 958.

Certificate 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.
Available only when the DataSource.Provider class declares the CERTIFICATE
authentication capability.

Identity Type Determines whether you're using one set or multiple sets of credentials to access the external
system. See Identity Type for External Data Sources on page 890.
Available only when the DataSource.Provider class declares the BASIC or OAUTH
authentication capability.

4. Select the authentication protocol.

• If you select Password Authentication, enter the username and password for accessing the external system.

954
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Password authentication is available only when the DataSource.Provider class declares the BASIC authentication
capability.

• If you select OAuth 2.0, complete the following fields.

OAuth 2.0 is available only when the DataSource.Provider class declares the OAUTH authentication capability.

Field Description
Authentication Choose the provider. See Authentication Providers.
Provider

Scope Specifies the scope of permissions to request for the access token. Your authentication provider
determines the allowed values. See Use the Scope Parameter.

Note:
– The value that you enter replaces the Default Scopes value that’s defined
in the specified authentication provider.
– Whether scopes are defined can affect whether each OAuth flow prompts the user
with a consent screen.
– We recommend that you request a refresh token or offline access. Otherwise, when
the token expires, you lose access to the external system.

Start To authenticate to the external system and obtain an OAuth token, select this checkbox. This
Authentication Flow authentication process is called an OAuth flow.
on Save When you click Save, the external system prompts you to log in. After successful login, the
external system grants you an OAuth token for accessing its data from this org.
Redo the OAuth flow when you need a new token—for example, if the token expires—or if
you edit the Scope or Authentication Provider fields. When the token expires,
the external system returns a 401 HTTP error status.

5. Click Save.
6. Click Validate and Sync, and confirm that the connection is successful.
This step also invokes the sync() method on the DataSource.Connection class to obtain the list of tables that you can
sync to create external objects and their fields.

7. Optionally, select tables and click Sync to do the following for each selected table.
• Automatically create a Salesforce external object.
• Automatically create a custom field for each table column that’s compatible with a Salesforce metadata field type.

Note: Before you sync, make sure that you understand the considerations that are described in these topics.
• Sync an External Data Source for Salesforce Connect on page 891
• Sync Considerations for Salesforce Connect—Custom Adapter on page 959

955
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

You can instead choose to manually create the external objects and custom fields that map to the external data. Doing so lets you
customize the external object names, decide which table columns to create custom fields for, and customize the custom field names.
However, this approach takes longer and requires manual maintenance.

SEE ALSO:
Set Up Salesforce Connect to Access External Data with a Custom Adapter
Store Authentication Settings for External Systems
Named Credentials

Considerations for Salesforce Connect—Custom Adapter

Understand the special behaviors, limits, and recommendations for using a custom adapter for
EDITIONS
Salesforce Connect.
Also review the considerations that apply to all Salesforce Connect adapters. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Apex Connector Framework Considerations for Salesforce Connect—Custom Adapter
Experience (not for
Understand the limits and considerations for creating Salesforce Connect custom adapters with high-data-volume external
the Apex Connector Framework. objects)
High Data Volume Considerations for Salesforce Connect—Custom Adapters
Available in: Developer
If your org hits rate limits when accessing external objects, consider selecting the High Data Edition
Volume option on the associated external data sources. Doing so bypasses most rate limits,
Available for an extra cost
but some special behaviors and limitations apply.
in: Enterprise, Performance,
Writable External Objects Considerations for Salesforce Connect—Custom Adapters and Unlimited Editions
Some special behaviors and limitations affect writable external objects that are associated with
custom adapters for Salesforce Connect.
Sync Considerations for Salesforce Connect—Custom Adapter
When you validate and sync an external data source of type Salesforce Connect: Custom, some special behaviors and
limitations apply.

SEE ALSO:
Salesforce Platform Features Supported by Salesforce Connect

956
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Apex Connector Framework Considerations for Salesforce Connect—Custom Adapter

Understand the limits and considerations for creating Salesforce Connect custom adapters with
EDITIONS
the Apex Connector Framework.
• If you change and save a DataSource.Connection class, resave the corresponding Available in: both Salesforce
DataSource.Provider class. Otherwise, when you define the external data source, the Classic (not available in all
custom adapter doesn’t appear as an option for the Type field. Also, the associated external orgs) and Lightning
objects’ custom tabs no longer appear in the Salesforce UI. Experience (not for
high-data-volume external
• DML operations aren’t allowed in the Apex code that comprises the custom adapter.
objects)
• Make sure that you understand the limits of the external system’s APIs. For example, some
external systems accept only requests for up to 40 rows. Available in: Developer
Edition
• Apex data type limitations:
Available for an extra cost
– Double—The value loses precision beyond 18 significant digits. For higher precision, use in: Enterprise, Performance,
decimals instead of doubles. and Unlimited Editions
– String—If the length is greater than 255 characters, the string is mapped to a long text area
field in Salesforce.

• Custom adapters for Salesforce Connect are subject to the same limitations as any other Apex code. For example:
– All Apex governor limits apply.
– Test methods don’t support web service callouts. Tests that perform web service callouts fail. For an example that shows how
to avoid these failing tests by returning mock responses, see Google Drive™ Custom Adapter for Salesforce Connect.

• In Apex tests, use dynamic SOQL to query external objects. Tests that perform static SOQL queries of external objects fail.

SEE ALSO:
Custom Adapter for Salesforce Connect
External Objects in Salesforce Connect
Apex Developer Guide: Primitive Data Types
Apex Developer Guide: Execution Governors and Limits
Apex Developer Guide: Callout Limits and Limitations
Apex Developer Guide: Google Drive™ Custom Adapter for Salesforce Connect
Apex Developer Guide: Dymamic SOQL

957
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

High Data Volume Considerations for Salesforce Connect—Custom Adapters

If your org hits rate limits when accessing external objects, consider selecting the High Data Volume
EDITIONS
option on the associated external data sources. Doing so bypasses most rate limits, but some special
behaviors and limitations apply. Available in: both Salesforce
• The following features aren’t available for external objects that are associated with Classic (not available in all
high-data-volume external data sources. orgs) and Lightning
Experience (not for
– Access via Lightning Experience
high-data-volume external
– Access via the Salesforce mobile app objects)
– Appearance in Recent Items lists
Available in: Developer
– Record feeds Edition
– Reports and dashboards Available for an extra cost
– Writable external objects in: Enterprise, Performance,
and Unlimited Editions
• Salesforce IDs aren’t assigned to external object records that are associated with
high-data-volume external data sources.
• On record detail pages for external objects that are associated with high-data-volume external data sources, custom buttons, and
links that call JavaScript aren’t supported.
• Salesforce Console in Salesforce Classic doesn’t support external objects that are associated with high-data-volume external data
sources.
• CSRF protection for writable external objects isn’t available for high-data-volume external data sources.

SEE ALSO:
Custom Adapter for Salesforce Connect
Considerations for Salesforce Connect—Custom Adapter

Writable External Objects Considerations for Salesforce Connect—Custom Adapters

Some special behaviors and limitations affect writable external objects that are associated with
EDITIONS
custom adapters for Salesforce Connect.
• Writable external objects aren’t available for high-data-volume external data sources. Available in: both Salesforce
• Queued changes to the external data execute over time, so external object records that are Classic (not available in all
read successively can contain different data. orgs) and Lightning
Experience (not for
Also review the considerations that apply to all Salesforce Connect adapters. high-data-volume external
objects)
SEE ALSO: Available in: Developer
Writable External Objects in Salesforce Connect Edition
Custom Adapter for Salesforce Connect Available for an extra cost
Apex Developer Guide : Writable External Objects in: Enterprise, Performance,
and Unlimited Editions

958
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Sync Considerations for Salesforce Connect—Custom Adapter

When you validate and sync an external data source of type Salesforce Connect: Custom,
EDITIONS
some special behaviors and limitations apply.
• Syncing always enables search on the external object when search is enabled on the external Available in: both Salesforce
data source, and vice versa. For an external data source of type Salesforce Connect: Custom, Classic (not available in all
search is enabled when the custom adapter’s DataSource.Provider class declares the orgs) and Lightning
DataSource.Capability.SEARCH capability. Experience (not for
high-data-volume external
Important: When you select the tables to sync, determine whether check marks appear in objects)
the Synced column.
Available in: Developer
If a Synced check mark appears, your org has an external object whose object name matches Edition
the table name. If you select the table and click Sync:
Available for an extra cost
• The external object is overwritten. in: Enterprise, Performance,
• Any custom field on the external object is overwritten if its API name (for example, and Unlimited Editions
Email__c) associates it with a table column name (for example, Email).
• Any other custom fields on the external object remain as they are, including:
– Previously synced custom fields whose API names were changed by editing their
Field Name values.
– Manually added custom fields whose API names aren’t associated with table column
names.

If no Synced check mark appears, and you sync the table, a new external object is created in
your org. The new external object’s object name matches the table name.
For example, suppose you change the table name in the custom adapter’s
DataSource.Connection class to no longer match the object name of the external
object. Syncing that table creates a new external object in Salesforce. We recommend that
you change the object name of the existing external object to match the new table name in
the DataSource.Connection class before you sync that table.

Also review the considerations that apply to all Salesforce Connect adapters.

SEE ALSO:
Sync an External Data Source for Salesforce Connect
Define an External Data Source for Salesforce Connect—Custom Adapter
Custom Adapter for Salesforce Connect

Access External Data with the Salesforce Connect Adapter for Amazon DynamoDB
Connect your users to data that's stored in Amazon DynamoDB.

Salesforce Connect Adapter for Amazon DynamoDB

Connect to Amazon DynamoDB to access and integrate DynamoDB data into Salesforce applications. With this adapter, take advantage
of the flexible data storage capabilities of Amazon DynamoDB that provides fast and predictable performance combined with
customer 360-degree view captured in Salesforce.

959
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Set Up Salesforce Connect to Access External Data in Amazon DynamoDB

Provide users with access to data stored in DynamoDB data source in Salesforce so that they have a complete view of the business.
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB
Amazon DynamoDB uses unique design patterns to model data efficiently that support multiple table and single table designs. To
make data stored in Amazon DynamoDB table accessible to external objects, use qualifiers to reinterpret external data. The qualifiers
describe the item attributes and indicates whether an item belongs to the schema represented by the external object. For multiple-table
schema designs, the table qualifier is optional.
Considerations for Salesforce Connect Adapters for Amazon DynamoDB
Understand the special behaviors, limits, and recommendations for using the Salesforce Connect adapter for Amazon DynamoDB.

Salesforce Connect Adapter for Amazon DynamoDB

Connect to Amazon DynamoDB to access and integrate DynamoDB data into Salesforce applications.
EDITIONS
With this adapter, take advantage of the flexible data storage capabilities of Amazon DynamoDB
that provides fast and predictable performance combined with customer 360-degree view captured Available in: both Salesforce
in Salesforce. Classic (not available in all
Amazon DynamoDB achieves its goals of consistent fast performance at very high scale through a orgs) and Lightning
series of trade-offs different from those of an RDBMS. A sophisticated partitioning scheme manages Experience (not for
the storage of very large tables, though at that size JOINs become impractical and aren’t supported. high-data-volume external
Querying is limited in other ways as well. To understand more, see Amazon DynamoDB Developer objects)
Guide: Modeling Relational Data in DynamoDB. Available in: Developer
Salesforce Connect Adapter for Amazon DynamoDB maps single table and multiple table designs Edition
of DynamoDB as external objects on the Salesforce Platform. You can define external object Available for an extra cost
relationships to integrate DynamoDB data into your Salesforce org, based on your business in: Enterprise, Performance,
requirements. and Unlimited Editions
Salesforce Connect adapter for Amazon DynamoDB uses PartiQL to perform data manipulation
operations, such as SELECT or UPDATE on the external objects. To know about how the Amazon
DynamoDB source tables are manipulated, see Amazon DynamoDB Developer Guide: PartiQL - A SQL-Compatible Query Language for
Amazon DynamoDB.

Map Salesforce External Object Field to DynamoDB Attributes

External object fields of Salesforce Connect Adapter for Amazon DynamoDB can be mapped to attributes of string, number, and
boolean scalar types. If an attribute of string type that represents a date or a timestamp is mapped to an external object field, then
date, dateTime, or time must be stored in ISO 8601 format.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect to Access External Data in Amazon DynamoDB
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB
Considerations for Salesforce Connect Adapters for Amazon DynamoDB

960
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Map Salesforce External Object Field to DynamoDB Attributes

External object fields of Salesforce Connect Adapter for Amazon DynamoDB can be mapped to
EDITIONS
attributes of string, number, and boolean scalar types. If an attribute of string type that represents
a date or a timestamp is mapped to an external object field, then date, dateTime, or time must be Available in: both Salesforce
stored in ISO 8601 format. Classic (not available in all
This table lists Amazon DynamoDB attribute types supported for field types of external objects in orgs) and Lightning
Salesforce. Experience

Available in: Developer

Amazon Amazon DynamoDB Salesforce External Object Field Type Edition
DynamoDB Data Type
Shorthand Available for an extra cost
Data Type in: Enterprise, Performance,
and Unlimited Editions
S String Text
Mapped as is.

N Number Number
Mapped to default precision and scale, which you
can override.

BOOL Boolean Checkbox

Mapped as is.

Following is the mapping strategy of Amazon DynamoDB attribute types to some of the common field types of external objects in
Salesforce:
• An attribute of string type that represents a date or dateTime is stored in ISO 8601 format.
• An attribute of string type that represents a time is stored in a format used by TIMEVALUE() or TEXT() function.
• An attribute of number type that represents currency is stored as a numeric value using the currency symbol configured for the
Salesforce org.
• An attribute of string type that represents a picklist is rendered as Salesforce defined enumeration values. For picklist (multi-select),
it is stored as comma-separated values of the selected choices.
• An attribute of number type that represents a percent is stored as a numeric value of percent type.
• An attribute of string type that represents a phone, URL, textarea, or email is stored as the corresponding Salesforce field type.
External object fields cannot be mapped to these attributes types:
• Scalar Types: Binary, Null
• Document Types: Map, List
• Sets of number, string, or binary values

961
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Note: When you manually create fields for an external object, make sure the mapped attributes are of a compatible type.

SEE ALSO:
Amazon DynamoDB Developer Guide: Data Types
Custom Field Types
Salesforce Connect Adapter for Amazon DynamoDB

Set Up Salesforce Connect to Access External Data in Amazon DynamoDB

USER PERMISSIONS EDITIONS

To create and edit external data sources: Customize Application Available in: both Salesforce
Classic (not available in all
To create and edit external objects: Customize Application
orgs) and Lightning
To view named credentials: View Setup and Configuration Experience (not for
high-data-volume external
To create, edit, or delete named credentials: Customize Application objects)
To create and edit custom fields: Customize Application Available in: Developer
To edit permission sets and user profiles: Manage Profiles and Permission Sets Edition
Available for an extra cost
To edit another user’s authentication settings Manage Users
in: Enterprise, Performance,
for external systems:
and Unlimited Editions

Provide users with access to data stored in DynamoDB data source in Salesforce so that they have
a complete view of the business.
Before you begin, review Amazon DynamoDB setup and access permissions in Amazon DynamoDB Developer Guide.
• For information about setup and access instructions, see Setting Up DynamoDB and Accessing DynamoDB.
• To know about identity-based AWS Identity and Access Management (IAM) policies with Amazon DynamoDB, see Managing Access.
The AWS user that the Salesforce Connect adapter for Amazon DynamoDB uses to make API calls must have the required permissions
to access the DynamoDB data source. You can use AWS Managed (Predefined) IAM Policies to allow read-only or edit access to users.
To be able to use PartiQL statements, you must add IAM Security Policies with PartiQL for DynamoDB to user's access permissions.

Configure an Amazon DynamoDB External Data Source with Setup Wizard

Define an external data source for an Amazon DynamoDB with fewer clicks using the setup wizard. The guided interface walks you
through connecting an Amazon DynamoDB data source and integrating the data in Salesforce.
Define a Named Credential for Salesforce Connect Adapter for Amazon DynamoDB
Create a named credential that specifies the endpoint URL for Amazon DynamoDB and an external credential to provide the required
authentication parameters.
Define a Legacy Named Credential for Salesforce Connect Adapter for Amazon DynamoDB
Create a legacy named credential that specifies the URL of a callout endpoint as Amazon DynamoDB endpoint and provides the
required authentication parameters.
Create an External Data Source for Salesforce Connect Adapter for Amazon DynamoDB
Connect your Salesforce org to data that’s stored in Amazon DynamoDB.

962
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Create External Objects for Salesforce Connect Adapter for Amazon DynamoDB
Tables in Amazon DynamoDB map to one or more external objects in Salesforce, combining all your data and content for users in
your org. The external objects associated with Amazon DynamoDB data source are searchable objects. Use the search box at the
top of every page to search by a specific external object or for a global search across Salesforce. You can also use other search tools
available in the Salesforce Platform to find external object records mapped to an Amazon DynamoDB table.
Sync an External Data Source for Salesforce Connect Adapter for Amazon DynamoDB
After you create the external objects, sync the corresponding external data source to get the metadata, such as the primary key
schema and indexes on the DynamoDB table.

SEE ALSO:
Salesforce Connect
Salesforce Connect Adapter for Amazon DynamoDB
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB
Considerations for Salesforce Connect Adapters for Amazon DynamoDB

Configure an Amazon DynamoDB External Data Source with Setup Wizard

Define an external data source for an Amazon DynamoDB with fewer clicks using the setup wizard.
EDITIONS
The guided interface walks you through connecting an Amazon DynamoDB data source and
integrating the data in Salesforce. Available in: both Salesforce
1. From Setup, enter External Data Sources in the Quick Find box, then select External Classic (not available in all
Data Sources. orgs) and Lightning
Experience
2. Click Connect to Amazon DynamoDB to launch the wizard.
The wizard lets you create a new external data source or use an existing one, specify the named Salesforce Connect is
available in: Developer
credential required to authenticate, select the DynamoDB table to map, and create an external
Edition and for an extra cost
object based on representative sample data. You can review the summary of the newly created
in: Enterprise, Performance,
external object and proceed to connect to another Amazon DynamoDB table, as required.
and Unlimited Editions
Files Connect for
cloud-based external data
sources is available in:
Professional, Enterprise,
Performance, Unlimited,
and Developer Editions
Federated Search is
available in: Enterprise,
Professional, Unlimited,
and Developer Editions

USER PERMISSIONS

To create and edit external

data sources:
• Customize Application

963
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define a Named Credential for Salesforce Connect Adapter for Amazon DynamoDB
Create a named credential that specifies the endpoint URL for Amazon DynamoDB and an external
EDITIONS
credential to provide the required authentication parameters.
1. From Setup, enter Named Credentials in the Quick Find box, then select Named Available in: both Salesforce
Credentials. Classic (not available in all
orgs) and Lightning
2. Click External Credentials.
Experience
3. To create a new external credential, click New . To edit an existing external credential, click its
link in the list of external credentials and then click Edit. Available in: All Editions

4. Complete the fields.

USER PERMISSIONS
Field Description
To view named credentials:
Label A user-friendly name for the named credential that’s displayed in the • View Setup and
Salesforce user interface. Configuration
To create, edit, or delete
Name A unique identifier that’s used to refer to this external credential from named credentials:
callout definitions while creating an external data source for Amazon • Customize Applications
DynamoDB.

Authentication Select AWS Signature Version 4.

Protocol

Service The name of an AWS service, such as dynamodb.

Region The AWS region for the named credential’s endpoint. For example,
us-west-2.

AWS Account ID Optional. The 12-digit number that uniquely identifies your AWS
account.

Use STS for Select the checkbox to provide limited access and specify STS access
Temporary key, access secret, external ID, and duration. For details, see Create
Access and Edit an External Credential.

5. Click Save. You’re taken to the Named Credentials screen.

6. To further edit the new external credential, click External Credential.
7. Select the external credential you created.
8. Scroll to Permission Set Mappings.
9. Click New to create a permission set mapping for this external credential.
10. Complete the following fields. When you use STS for temporary access, the Access Key and Secret fields are disabled and display the
temporary credentials, if any.

964
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
Permission Set Select an available permission set. This enables different groups of Salesforce users to mirror access
permissions of IAM roles.
Make sure you define the required access to the User External Credentials object (use permission
sets or profiles to configure object access). Only users with access to the User External Credentials
object can make callouts to the external source. For details, see Named Credentials and External
Credentials.

Sequence Number Assign a sequence number. A sequence number 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.

IAM Role ARN The Amazon Resource Name (ARN) of the role that the credential assumes.
To get the ARN for an IAM role:
a. In the navigation pane of the IAM console, choose Roles.
b. In the list of roles, choose the role you want to map to the permission set.
c. In the Summary section, copy the ARN value.
For details, see AWS Identity and Access Management User Guide: Tutorials.

11. Create a named credential that uses the authentication configuration you defined in the external credential. From Setup, enter
Named Credentials in the Quick Find box, select Named Credentials, and then click Named Credentials.
12. To create a new named credential, click New and complete the fields.
• Fill out the Label, Name, and URL fields.
Sample format for the URL would be https://dynamodb.REGION.amazonaws.com For example, if the AWS region
is us-west-2, the URL would be https://dynamodb.us-west-2.amazonaws.com
For details, see Create and Edit a Named Credential.
• For the External Credential field, select the external credential you created that uses the AWS Signature Version 4
authentication protocol.
• Select Generate Authorization Header.

Use the named credential that captures the authentication configuration in external credentials to authenticate Salesforce users against
Amazon DynamoDB, provide limited access to AWS resources, and periodically refresh access tokens.

SEE ALSO:
Amazon DynamoDB Developer Guide: Getting an AWS Access Key
Named Credentials
Salesforce Connect Adapter for Amazon DynamoDB

965
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define a Legacy Named Credential for Salesforce Connect Adapter for Amazon DynamoDB
Create a legacy named credential that specifies the URL of a callout endpoint as Amazon DynamoDB
EDITIONS
endpoint and provides the required authentication parameters.

Important: In Winter ’23, Salesforce introduced an improved named credential that is Available in: both Salesforce
extensible and customizable. We strongly recommend that you use this preferred credential Classic (not available in all
orgs) and Lightning
instead of legacy named credentials. For information on extensible, customizable named
Experience
credentials, see Named Credentials and External Credentials. Legacy named credentials are
deprecated and will be discontinued in a future release. Available in: All Editions
1. From Setup, enter Named Credentials in the Quick Find box, then select Named
Credentials. USER PERMISSIONS
2. To create a new legacy named credential, click New Legacy from the dropdown menu.
To view named credentials:
3. Complete the fields. • View Setup and
Configuration
Field Description To create, edit, or delete
Label A user-friendly name for the named credential that’s displayed in the named credentials:
Salesforce user interface. • Customize Applications

Name A unique identifier that’s used to refer to this named credential from
callout definition while creating an external data source for Amazon
DynamoDB.

URL The URL of the Amazon DynamoDB endpoint.

Sample format for the URL would be
https://dynamodb.REGION.amazonaws.com
For example, if the AWS region is us-east-1, the URL would be
https://dynamodb.us-east-1.amazonaws.com

Identity Type Select Named Principal to designate one user account on the
Amazon DynamoDB external system for all your Salesforce org users.

Authentication Select AWS Signature Version 4 and complete the following fields.
Protocol a. AWS Access Key ID: First part of the access key used to
sign programmatic requests to AWS.
b. AWS Secret Access Key : Second part of the access key
used to sign programmatic requests to AWS.
c. AWS Region : The AWS region name for the named
credential’s endpoint. For example, us-east-1.

966
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
d. AWS Service: dynamodb, which is the AWS utility to access.

SEE ALSO:
Amazon DynamoDB Developer Guide: Getting an AWS Access Key
Named Credentials
Salesforce Connect Adapter for Amazon DynamoDB

Create an External Data Source for Salesforce Connect Adapter for Amazon DynamoDB
Connect your Salesforce org to data that’s stored in Amazon DynamoDB.
EDITIONS
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources. Available in: both Salesforce
Classic (not available in all
2. Click New External Data Source, or click Edit to modify an existing external data source.
orgs) and Lightning
3. Complete the fields. Experience (not for
high-data-volume external
Field Description objects)

External Data A user-friendly name for the external data source. The label is displayed Available in: Developer
Source in the Salesforce user interface. Edition

Name A unique identifier that’s used to refer to this external data source Available for an extra cost
in: Enterprise, Performance,
definition through the API.
and Unlimited Editions
Type Select Amazon DyanamoDB.

Named Enter the named credential URL you defined for Amazon DynamoDB USER PERMISSIONS
Credential data source.
To create and edit external
You can skip the Authentication section for the external data source.
data sources:
To access the Amazon DynamoDB external system, Salesforce Connect
• Customize Application
uses the authentication settings that are defined in the named
credential.

Connection Number of seconds to wait for a response from the Amazon

Timeout DynamoDB external system before timing out. By default, the value
is set to the maximum of 120 seconds.

Writable Select this option only if you want to create, edit, and delete data
External that’s stored in Amazon DynamoDB. By default, external objects are
Objects read only.

967
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

4. Click Save.

SEE ALSO:
Work with External Data Sources
Salesforce Connect Adapter for Amazon DynamoDB

Create External Objects for Salesforce Connect Adapter for Amazon DynamoDB
Tables in Amazon DynamoDB map to one or more external objects in Salesforce, combining all
EDITIONS
your data and content for users in your org. The external objects associated with Amazon DynamoDB
data source are searchable objects. Use the search box at the top of every page to search by a Available in: both Salesforce
specific external object or for a global search across Salesforce. You can also use other search tools Classic (not available in all
available in the Salesforce Platform to find external object records mapped to an Amazon DynamoDB orgs) and Lightning
table. Experience
For external object fields defined for an Amazon DynamoDB data source, the attribute values in Salesforce Connect is
DynamoDB must be appropriately mapped to the data type defined for the external object fields. available in: Developer
See Supported Data Types. Edition and for an extra cost
To create or modify an external object: in: Enterprise, Performance,
and Unlimited Editions
1. From Setup, enter External Objects in the Quick Find box, then select External Objects.
Files Connect for
2. Click New External Object, or click Edit to modify an existing external object. cloud-based external data
3. Enter the following: sources is available in:
Professional, Enterprise,
Field Description Performance, Unlimited,
and Developer Editions
Label A user-friendly name for the external object. The label is displayed in
Federated Search is
the Salesforce user interface.
available in: Enterprise,
Plural Label The plural name of the external object. When you create a tab for this Professional, Unlimited,
object, this name is used for the tab. and Developer Editions

Object Name A unique identifier used to refer to this external object definition when
using the API. Object names must be unique across all standard, USER PERMISSIONS
custom, and external objects in the org.
To create or edit external
External Data The external data source definition that contains the connection details objects:
Source you want to use for this external object. • Customize Application

Table Name Table in Amazon DynamoDB data source that the external object
maps to.

4. Click Save.
5. On the external object detail page, view and modify the external object’s custom fields and relationships, page layouts, field sets,
search layouts, and buttons and links.
• To create field mappings or add fields to an external object, click New on the Custom Fields & Relationships related list.
• To assign different page layouts by user profile, click Page Layout Assignments.

968
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

After the external object and its fields are created, you may have to provide additional configuration so that Salesforce can apply a
schema-like concept on top of data that’s inherently schemaless. Single-table schema designs often require developers to populate
attribute values with prefixes that must be parsed for end users. See Manage Qualifiers for Salesforce Connect Adapter for Amazon
DynamoDB.

SEE ALSO:
Define External Objects
External Object Relationships
Manage Custom Objects
Salesforce Connect Adapter for Amazon DynamoDB

Sync an External Data Source for Salesforce Connect Adapter for Amazon DynamoDB
After you create the external objects, sync the corresponding external data source to get the
EDITIONS
metadata, such as the primary key schema and indexes on the DynamoDB table.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Available in: both Salesforce
Data Sources. Classic (not available in all
orgs) and Lightning
2. Click the name of the external data source and then click Validate and Sync.
Experience (not for
3. Select the Amazon DynamoDB tables you want to sync and click Sync. high-data-volume external
After syncing is complete, manually create external object fields for the synced tables. objects)

Available in: Developer

Note: If the Amazon DynamoDB primary key or indexes change, you must resync the tables
Edition
to get the updated metadata information.
Available for an extra cost
in: Enterprise, Performance,
SEE ALSO: and Unlimited Editions
Amazon DynamoDB Developer Guide: Primary Key and Secondary Indexes
Salesforce Connect Adapter for Amazon DynamoDB
USER PERMISSIONS

To create and edit external

data sources:
• Customize Application

969
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB

Amazon DynamoDB uses unique design patterns to model data efficiently that support multiple
EDITIONS
table and single table designs. To make data stored in Amazon DynamoDB table accessible to
external objects, use qualifiers to reinterpret external data. The qualifiers describe the item attributes Available in: both Salesforce
and indicates whether an item belongs to the schema represented by the external object. For Classic (not available in all
multiple-table schema designs, the table qualifier is optional. orgs) and Lightning
Experience (not for
Qualifier Options for Salesforce Connect Adapter for Amazon DynamoDB high-data-volume external
objects)
You can use various qualifier options to parse an Amazon DynamoDB table into an external
object by applying filters to the table rows and performing lightweight transformations of the Available in: Developer
returned data. Edition
Qualifier Example for One-to-Many and Many-to-Many Relationships in Amazon DynamoDB Available for an extra cost
An enterprise stores and retains fine-grain transaction details for millions of customers, resulting in: Enterprise, Performance,
in data volumes reaching billions of records. In this example, Salesforce is the system of record and Unlimited Editions
for core customer information and details of all the customer’s orders are stored in Amazon
DynamoDB for scale reasons.
Sort Example for Orders and Order Items in Amazon DynamoDB
To effectively sort orders and order items stored in an Amazon DynamoDB table in a way that benefits a business process, create
secondary indexes that identify attribute values as the basis for sorting.
DynamoDB Qualifier Examples for Parsing Formulas
This example shows a simple formula to concatenate two text values. The value of the location virtual attribute is evaluated
using the values of city and state attributes. For example, if city is Los Angeles and state is California, location value is defined
as Los Angeles, California.

SEE ALSO:
Amazon DynamoDB Developer Guide: Partition Key Design
Amazon DynamoDB Developer Guide: Adjacency List Design Pattern
Salesforce Connect Adapter for Amazon DynamoDB

Qualifier Options for Salesforce Connect Adapter for Amazon DynamoDB

You can use various qualifier options to parse an Amazon DynamoDB table into an external object
EDITIONS
by applying filters to the table rows and performing lightweight transformations of the returned
data. Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Experience (not for
high-data-volume external
objects)

Available in: Developer

Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

970
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

The following is the syntax for a JSON qualifier expression.

TableLocation ::=
"tableLocationName": "tableLocationValue" |
"tableLocationName": {TableLocation(, TableLocation)*}

NamedColumnQualifier ::=
"columnName": {ColumnQualifier(, ColumnQualifier)*}

ColumnQualifier ::=
"columnName": "physicalColumnName" |
"type": ("S" | "N" | "BOOL") |
"presence": ("exists" | "null" | "not null" | "not exists" | "any") |
"virtual": (true | false) |
"filter": "sqlLikeExpression" |
"postFilter": "matchRegex" |
"values": [ValueDefinition(, ValueDefinition)*]

ValueDefinition ::=
{ValueQualifier,( ValueQualifier)*}

ValueQualifier ::=
"definition": "functionDefinition" |
"columnOrder": ["ColumnName"(, "ColumnName")*]

• TableLocation: Specific set of properties for a data source type that are used to locate the table. For example, database name
and database catalog.
• NamedColumnQualifier: Default value for the columnName is NamedColumnQualifier’s column name. If the
ColumnQualifier is virtual, columnName is not specified.
• ColumnQualifier
– columnName: Name of the external physical attribute, column, or field.
– type: Some field types may be mapped to more than one attribute type. For example, dates may be mapped as an ISO 8601
string (default) or as a Unix epoch number.
You can’t use the type qualifier to override field types to incompatible attribute types. For example, a field of type number
can’t be mapped to an attribute type of string.

– presence: Represents whether the attribute must be present, null (be present and null), not null (be present but not null),
absent, or any (presence isn’t relevant). Default value is any.
Amazon DynamoDB server evaluates the presence criteria and translates it as part of the PartiQL query.

– virtual: If true, the attribute doesn't physically exist in the external data source. Default value is false. Virtual attributes are
derived from external attributes using the values formula.
Use virtual attributes to transform encoded or composed attributes, such as transforming a sort key attribute to a user-friendly
value. You can recompose physical attribute values by defining value functions with virtual attribute values, for example to create
or update records.

– filter: An expression evaluated by the Amazon DynamoDB server to filter matching items. Allowed expressions for Amazon
DynamoDB:
• equals: ExactValue
• begins with: LeftValue%
• contains: %MiddleValue%

971
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Ends with or other substring matches aren't supported.

– postFilter: An expression that runs after the query results are obtained from the Amazon DynamoDB service. Though the
postFilter expression refines matching result records, use qualifiers such as presence and filter for better performance.
Back-references (for example, "\1") and lazy quantifiers (for example, "*?") aren’t supported for performance reasons.

– values: A list of candidate Salesforce formula functions that derive the attribute value from other attributes. For example,
encoding sort keys and deriving composed keys.

• ValueDefinition: Contains an array of value qualifiers.

• ValueQualifier
– definition: A candidate value defined using Salesforce formula functions. A formula function can be a constant expression
or can depend on one or more attribute values.
– columnOrder: The lexical attribute order of the derived attribute value. The lexical order determines the field sort order in
SOQL.

SEE ALSO:
Amazon DynamoDB Developer Guide: Use PartiQL Functions with Amazon DynamoDB
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB

Qualifier Example for One-to-Many and Many-to-Many Relationships in Amazon DynamoDB

An enterprise stores and retains fine-grain transaction details for millions of customers, resulting in data volumes reaching billions of
records. In this example, Salesforce is the system of record for core customer information and details of all the customer’s orders are
stored in Amazon DynamoDB for scale reasons.
In this typical relational model, customers are stored in Salesforce as Accounts. Orders, order items, and products are stored in Amazon
DynamoDB and virtualized in Salesforce as external objects. Deploying such a solution provides the enterprise’s sellers and customer
service agents complete access to customers' order history.

Because Amazon DynamoDB is a NoSQL database and doesn’t support JOIN queries, recommended design practice is to store all related
information for a business operation in a single DynamoDB table. To differentiate items that are products and not orders or order items,
you have to use other strategies. Another design practice is to identify access patterns and ensure that common operations can be
performed with a single query, thereby maintaining high performance even with very large tables. The following is a sample table based
on the recommended design practices.

PK SK CUSTOMER ORDERDATE TOTAL SHIPPING QTY PRICE SUBTOTAL NAME

1012 ORDER A123 2022-07-12T14:33:14Z 25.75 5.75

1012 product#1 2 5.00 10.00 Widget X

972
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

PK SK CUSTOMER ORDERDATE TOTAL SHIPPING QTY PRICE SUBTOTAL NAME

1012 product#2 1 15.00 15.00 Widget Y

1 PRODUCT 5.00 Widget X

2 PRODUCT 15.00 Widget Y

3 PRODUCT 20.00 Widget Z

1013 ORDER B456 2022-07-15T18:05:45Z 9.25

1013 product#1 49.25 1 5.00 5.00 Widget X

1013 product#2 1 15.00 15.00 Widget Y

1013 product#3 1 20.00 20.00 Widget Z

Amazon DynamoDB manages one-to-many relationship between orders and order items based on the Adjacency list design pattern.
This pattern allows an order and all its order items to be retrieved via a single query. For example, an order management application
deployed on AWS executes the following one query and renders a single receipt for an order. For this purpose, the name of the product
is duplicated into the order item at checkout. The goal of the table design isn’t to fully normalize data as in relational database design.
SELECT * FROM "OrderManagement" WHERE "pk" = "1012"
With the structure of the Amazon DynamoDB table known, we can create qualifiers in Salesforce so that the Salesforce Connect adapter
for DynamoDB can separate products, orders, and order items. Along with the other elements of the qualifier, the sort key (SK) is used
to differentiate between the items (similar to Record Types). For products and orders, the sort key contains a static value of PRODUCT
or ORDER as the differentiator. Because of the static value, certain operations are simplified.

Note: Though JSON doesn’t support comments, snippets in this example topic include comments for clarity. If you want to deploy
this sample, use a JSON validation tool to point out the syntax to skip.

Manage Qualifiers for Order

The partition key (PK) of an order is numeric, but it’s more flexible for the field to be a string relative to Amazon DynamoDB. Hence, the
qualifier for Order looks for numeric values via regex even though the attribute type is still a string. The following is a JSON snippet for
an Order qualifier.
{
"tableName": "OrderManagement",
"columns": {
"pk": {
"postFilter": "^[0-9]+$", // regex matching integers
"type": "S" // attribute must be a String
},
"sk": {
"values": [
{
"definition": "\"ORDER\"" // // matches the static value "ORDER"
}
]
}
}
}

973
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

While it’s beneficial to map the partition key (PK) field to an Order Number (or a similar field) in Salesforce, the sort key (SK) doesn’t need
to be mapped to a field on the Order object. It doesn’t provide any business value to end users.

Manage Qualifiers for Product

Based on the same approach as for Order, the following is a JSON snippet for a Product qualifier.
{
"tableName": "OrderManagement",
"columns": {
"pk": {
"postFilter": "^[0-9]+$", // regex matching integers
"type": "S" // attribute must be a String
},
"sk": {
"values": [
{
"definition": "\"PRODUCT\"" // // matches the static value "PRODUCT"
}
]
}
}
}

Both Product and Order have other attributes in the Amazon DynamoDB table that must be mapped to external objects fields. Because
these attributes don’t need any qualification or translation, they don’t need to appear in the qualifier. Salesforce Connect adapter for
Amazon DynamoDB maps these other attributes to field types. For example:
• ORDERDATE string attribute is converted to DateTime field type, if it’s in ISO 8601 format.
• PRICE and TOTAL number attributes are converted to Currency type configured for the Salesforce org.

Manage Qualifiers for Order Items

Qualifiers allow you to use Salesforce formulas to create virtual attributes that don’t physically exist in Amazon DynamoDB. Such attributes
can be referenced as external column names when you define the fields on the external object.
The sort key (SK) for Order Items contains an identifier for the product, as well as a static prefix product# to clearly identify that the
value refers to a product.
The approach used in this example combines PK and SK in a way that works well relative to Amazon DynamoDB. The partition key and
sort key together form a unique composite key for an item. When the following qualifier is applied, the external ID in Salesforce for a
particular Order Item takes the form of 1012-1 (PK and SK separated by a hyphen). The external ID is mapped to a Salesforce ID to enable
the Salesforce Platform capabilities available to external objects.
The following is a JSON snippet for the qualifier that leverages the approach described and uses a formula to remove the prefix and
increase readability.
{
"tableName": "OrderManagement",
"columns": {
"pk": {
"postFilter": "^[0-9]+$", // regex matching integers
"type": "S" // attribute must be a String
},
"sk": {

974
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

"filter": "products#%" // prefixed with "products#"

},
"productCode": {
"virtual": true, // productCode does not exist in DynamoDB
"values": [
{
"definition": "RIGHT(sk, LEN(sk) - FIND(\"#\", sk))" // Formula parses out the
prefix
}
]
}
}
}

When you create an external lookup to Product from Order Item, use the virtual attribute productCode as the external column name.
The external lookup to Order uses the PK as the external column name and using this column you can create many-to-many relationships.

SEE ALSO:
DynamoDB Qualifier Examples for Parsing Formulas
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB

Sort Example for Orders and Order Items in Amazon DynamoDB

To effectively sort orders and order items stored in an Amazon DynamoDB table in a way that benefits a business process, create secondary
indexes that identify attribute values as the basis for sorting.
A secondary index allows efficient access to data with attributes other than the primary key values. You can create multiple secondary
indexes and give your applications access to different query patterns. A general rule of thumb for creating indexes:
When you query for rows that match condition A, you want to sort the results by attribute B.
A secondary index is a data structure that contains a subset of attributes you select from the table. You must select all the attributes that
you want to appear in the query results, even if they’re not used for sorting.
Suppose you want to sort orders for a customer by date, and then sort the line items within an order by quantity. To do this, an Amazon
DynamoDB administrator must create specific indexes to support the query and the sort operation:
• customerID-orderDate-index: query for the orders for a specific customer (partition key), then sort by date (sort key).
• orderID-quantity-index: query for the order items for a specific order (partition key), then sort by quantity (sort key).
If you want to display unit price and any other corresponding details for orders or order items, make sure to include the attributes while
you’re creating the index.

SEE ALSO:
Qualifier Example for One-to-Many and Many-to-Many Relationships in Amazon DynamoDB
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB

975
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

DynamoDB Qualifier Examples for Parsing Formulas

This example shows a simple formula to concatenate two text values. The value of the location virtual attribute is evaluated using
the values of city and state attributes. For example, if city is Los Angeles and state is California, location value is defined as Los
Angeles, California.
{
"columns": {
"city": {
"presence": "any",
"type": "S",
"values": [{
"definition": "LEFT(location, FIND(\",\", location)-1)"
}]
},
"state": {
"presence": "any",
"type": "S",
"values": [{
"definition": "MID(location, FIND(\", \", location)+2, LEN(location))"
}]
},
"location": {
"virtual": "true",
"values": [{
"definition": "city+\", \"+state"
}]
}
}
}

This example depicts use of parsing formulas to decode an address stored in a single attribute in Amazon DynamoDB. The data field
captures the street address as country#region#city#address for querying purposes. For example, USA#MI#Ann Arbor#707 Oxford Rd.
{
"columns": {
"pk": {
"filter": "suppliers#%",
"values": [
{
"definition": "\"suppliers#\" +supplier"
}
]
},
"sk": {
"presence": "exists",
"values": [
{
"definition": "\"SUPPLIER\""
}
]
},
"supplier": {
"virtual": true,
"type": "S",

976
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

"values": [
{
"definition": "MID(pk, FIND(\"#\", pk) + 1, LEN(pk))"
}
]
},
"data": {
"presence": "any",
"type": "S",
"values": [
{
"definition": "country + \"#\" + region + \"#\" + city + \"#\" + address"
}
]
},
"country": {
"virtual": true,
"type": "S",
"values": [
{
"definition": "LEFT(data, FIND(\"#\", data)-1)"
}
]
},
"region": {
"virtual": true,
"type": "S",
"values": [
{
"definition": "MID(data, FIND(\"#\", data)+1, FIND(\"#\", data, FIND(\"#\",
data)+1)-FIND(\"#\", data)-1)"
}
]
},
"city": {
"virtual": true,
"type": "S",
"values": [
{
"definition": "MID(data, FIND(\"#\", data, FIND(\"#\", data)+1)+1, FIND(\"#\",
data, FIND(\"#\", data, FIND(\"#\", data)+1)+1)-FIND(\"#\", data, FIND(\"#\", data)+1)-1)"

}
]
},
"address": {
"virtual": true,
"type": "S",
"values": [
{
"definition": "RIGHT(data, LEN(data)-FIND(\"#\", data, FIND(\"#\", data,
FIND(\"#\", data)+1)+1))"
}
]

977
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

}
}
}

SEE ALSO:
Amazon DynamoDB Developer Guide: Using the BEGINS_WITH Function with PartiQL for DynamoDB
Manage Qualifiers for Salesforce Connect Adapter for Amazon DynamoDB

Considerations for Salesforce Connect Adapters for Amazon DynamoDB

Understand the special behaviors, limits, and recommendations for using the Salesforce Connect
EDITIONS
adapter for Amazon DynamoDB.
• When you define an external object, you must specify the prefixes used in the keys. This enables Available in: both Salesforce
applying a schema-like concept on top of Amazon DynamoDB data that’s inherently schema-less. Classic and Lightning
See Amazon DynamoDB Developer Guide: Core Components of Amazon DynamoDB. Experience
• When you define a DynamoDB external data source, you must manually set up metadata for Available in: Developer
the related external objects, and fields on the external objects. Edition
• Not all relational-style SOQL queries can be translated in a way that returns results in DynamoDB, Available for an extra cost
such as table joins. Such queries can’t execute and may cause a runtime error displayed in the in: Enterprise, Performance,
Lightning UI. and Unlimited Editions
Amazon DynamoDB delivers reliably fast performance at extremely high scale by mandating
developers store data in a way that matches how it will be accessed. Typical relational databases
don’t impose this restriction on development teams, but JOINs and subqueries at the very highest levels of scale become problematic.
See Amazon DynamoDB Developer Guide: From SQL to NoSQL.

• External object fields map to a DynamoDB attribute value in its entirety, so any compound values with embedded keys are visible
to the user.
• Salesforce Platform features that aren’t supported:
– Reports
– SOSL
– Sorting is only available based on the sort key of the underlying table in Amazon DynamoDB, or any secondary indexes defined
for that table. See Sort Example for Orders and Order Items on page 975.
– Filtering isn't supported on virtual fields. Filtering is supported only for columns that are present in the DynamoDB data source.
– Certain operations, such as updates via Flows work only when the primary key for the mapped DynamoDB table is of type string.

• A SOQL query may cause a runtime error if:

– The query scans an Amazon DynamoDB table that is configured to prevent such scans.
– The query can’t be translated in a way that returns results in Amazon DynamoDB such as table joins. Because Amazon DynamoDB
is a nonrelational database, it doesn't support table joins.
To understand more, see Amazon DynamoDB Developer Guide: Working with Scans in DynamoDB.
• We recommend consistent reads for working with Salesforce integration. For information reading data from a DynamoDB table, see
Amazon DynamoDB Developer Guide: Read Consistency.
• Auto-numbering of identifiers isn’t supported. So DML operations must always include primary key fields.
• Asynchronous DML operations aren’t supported. Instead use the synchronous variant of the DML operations. Amazon DynamoDB
database service is designed to run high-performance applications at any scale.

978
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

• For external lookups and indirect lookups on external objects:

– External Lookup Relationship: Look up an external parent by its primary key.
– Indirect Lookup Relationship: Look up a parent by key fields on the parent that uniquely identify a record. The child record holds
the values to match for the parent unique field. For efficient queries, we recommend indexing parent key fields that uniquely
identify the record and match the child record.

• External ID values that uniquely identify external object records are case sensitive.

SEE ALSO:
Salesforce Connect Adapter for Amazon DynamoDB
Set Up Salesforce Connect to Access External Data in Amazon DynamoDB

Access External Data with the Salesforce Connect Adapter for Amazon Athena
Provide your users access to Amazon Athena’s capability to analyze data directly in Amazon Simple Storage Service (Amazon S3) and
integrate AWS-hosted data in Salesforce applications.

Salesforce Connect Adapter for Amazon Athena

Perform complex queries on large datasets and get fast query results using the Salesforce Connect adapter for Amazon Athena. With
this adapter, take advantage of Amazon Athena’s capability to run queries against data directly in Amazon S3 without having to
manage RDBMS infrastructure or ETL tools.
Set Up Salesforce Connect Adapter for Amazon Athena
Provide users easy access to data stored in Amazon S3 so that they can build custom applications that combine the power of the
Salesforce and AWS clouds.
Manage Qualifiers for Salesforce Connect Adapter for Amazon Athena
Tables and databases in Amazon Athena contain the metadata definitions for the underlying source data schema. To be able to
make queries to Amazon Athena, use qualifiers to specify the key columns that identify records in the Amazon Athena data source.

Salesforce Connect Adapter for Amazon Athena

Perform complex queries on large datasets and get fast query results using the Salesforce Connect
EDITIONS
adapter for Amazon Athena. With this adapter, take advantage of Amazon Athena’s capability to
run queries against data directly in Amazon S3 without having to manage RDBMS infrastructure or Available in: both Salesforce
ETL tools. Classic (not available in all
Amazon Athena is an interactive query service that makes it easy to query structured data stored orgs) and Lightning
in Amazon S3 using standard SQL. Use the Salesforce Connect adapter for Amazon Athena to query Experience (not for
data stored in Amazon S3 and combine it with the customer 360-degree view captured in Salesforce. high-data-volume external
objects)
Amazon Athena provides additional data connectors that run as AWS Lambda functions and can
query nearly any data source on AWS. However, one of the trade-offs is that DML operations such Available in: Developer
as insert, update, and delete aren’t supported on all the data sources. For more information, see Edition
Amazon Athena User Guide: Running SQL queries using Amazon Athena. Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

979
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Map Salesforce External Object Field to Amazon Athena Data Types

External object fields of Salesforce Connect adapter for Amazon Athena can be mapped to columns with scalar types such as strings
and numbers. External object fields can’t be mapped to columns containing complex or nested data types such as an array, map,
or struct.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect Adapter for Amazon Athena
Manage Qualifiers for Salesforce Connect Adapter for Amazon Athena

Map Salesforce External Object Field to Amazon Athena Data Types

External object fields of Salesforce Connect adapter for Amazon Athena can be mapped to columns
EDITIONS
with scalar types such as strings and numbers. External object fields can’t be mapped to columns
containing complex or nested data types such as an array, map, or struct. Available in: both Salesforce
The table details the mappings between column types in Amazon Athena to external object field Classic (not available in all
types in Salesforce. orgs) and Lightning
Experience
Amazon Athena Data Type Salesforce External Object Field Type Available in: Developer
boolean Checkbox Edition
Available for an extra cost
tinyint, smallint, int and integer, Number
in: Enterprise, Performance,
bigint, double, float, decimal Mapped to default precision and scale, which you can override. and Unlimited Editions

char Text or Text Area

varchar, string Text, Text Area, or Text Area (Long)

date Date
Supported format is YYYY-MM-DD

timestamp Date/Time
Supported format is yyyy-MM-dd HH:mm:ss.f
For example, ‘2008-09-15 03:04:05.324'

Note: For Time Salesforce field type, there isn’t an equivalent column type in Amazon Athena.

Following is the mapping strategy of Amazon Athena data types to some of the common field types of external objects in Salesforce:
• A char, string, or varchar data type that represents a phone, URL, Text, Text Area, Text Area (Long), or Email is stored as the
corresponding Salesforce field type.
• A char, string, or varchar data type that represents a Picklist is rendered as Salesforce defined enumeration values. For Picklist
(Multi-Select), it’s stored as comma-separated values of the selected choices.
• A decimal data type that represents a percent is stored as a numeric value of percent type.
• A decimal data type that represents currency is stored as a numeric value using the currency symbol configured for the Salesforce
org.

980
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Note: When you manually create fields for an external object, make sure the mapped attributes are of a compatible type.

SEE ALSO:
Data types in Amazon Athena
Custom Field Types
Salesforce Connect Adapter for Amazon Athena

Set Up Salesforce Connect Adapter for Amazon Athena

USER PERMISSIONS EDITIONS

To create and edit external data sources: Customize Application Available in: both Salesforce
Classic (not available in all
To create and edit external objects: Customize Application
orgs) and Lightning
To view named credentials: View Setup and Configuration Experience (not for
high-data-volume external
To create, edit, or delete named credentials: Customize Application objects)
To create and edit custom fields: Customize Application Available in: Developer
To edit permission sets and user profiles: Manage Profiles and Permission Sets Edition
Available for an extra cost
To edit another user’s authentication settings Manage Users
in: Enterprise, Performance,
for external systems:
and Unlimited Editions

Provide users easy access to data stored in Amazon S3 so that they can build custom applications
that combine the power of the Salesforce and AWS clouds.
Before you begin, review the basics of Amazon Athena setup and access in Amazon Athena User Guide.
To know about identity-based AWS Identity and Access Management (IAM) policies to restrict access to Athena operations, see Identity
and access management in Athena.

Define a Named Credential for Salesforce Connect Adapter for Amazon Athena
Create a named credential that specifies the endpoint URL for Amazon Athena and an external credential to provide the required
authentication parameters.
Define a Legacy Named Credential for Salesforce Connect Adapter for Amazon Athena
Create a legacy named credential that specifies the URL of a callout endpoint as Amazon Athena endpoint and provides the required
authentication parameters.
Create an External Data Source for Salesforce Connect Adapter for Amazon Athena
Connect your Salesforce org to access Amazon Athena’s interactive query capabilities.

981
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Validate and Sync External Data Source Configured for Amazon Athena
After you create an external data source for Amazon Athena, synchronize it to map its tables with external objects in your Salesforce
org.

SEE ALSO:
Salesforce Connect
Salesforce Connect Adapter for Amazon Athena
Manage Qualifiers for Salesforce Connect Adapter for Amazon Athena

Define a Named Credential for Salesforce Connect Adapter for Amazon Athena
Create a named credential that specifies the endpoint URL for Amazon Athena and an external
EDITIONS
credential to provide the required authentication parameters.
1. From Setup, enter Named Credentials in the Quick Find box, then select Named Available in: both Salesforce
Credentials. Classic (not available in all
orgs) and Lightning
2. Click External Credentials.
Experience
3. To create a new external credential, click New . To edit an existing external credential, click its
link in the list of external credentials and then click Edit. Available in: All Editions

4. Complete the fields.

USER PERMISSIONS
Field Description
To view named credentials:
Label A user-friendly name for the named credential that’s displayed in the • View Setup and
Salesforce user interface. Configuration
To create, edit, or delete
Name A unique identifier that’s used to refer to this external credential from named credentials:
callout definitions while creating an external data source for Amazon • Customize Applications
Athena.

Authentication Select AWS Signature Version 4.

Protocol

Service The name of an AWS service, such as athena.

Region The AWS region for the named credential’s endpoint. For example,
us-west-2.

AWS Account ID Optional. The 12-digit number that uniquely identifies your AWS
account.

Use STS for Select the checkbox to provide limited access and specify STS access
Temporary key, access secret, external ID, and duration. For details, see Create
Access and Edit an AWS Signature v4 External Credential.

5. Click Save. You’re taken to the Named Credentials screen.

6. To further edit the new external credential, click External Credential.
7. Select the external credential you created.

982
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

8. Scroll to Permission Set Mappings.

9. Click New to create a permission set mapping for this external credential.
10. Complete the following fields. When you use STS for temporary access, the Access Key and Secret fields are disabled and display the
temporary credentials, if any.

Field Description
Permission Set Select an available permission set. This enables different groups of Salesforce users to mirror access
permissions of IAM roles.
Make sure you define the required access to the User External Credentials object (use permission
sets or profiles to configure object access). Only users with access to the User External Credentials
object can make callouts to the external source. For details, see Named Credentials and External
Credentials.

Sequence Number Assign a sequence number. A sequence number 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.

IAM Role ARN The Amazon Resource Name (ARN) of the role that the credential assumes.
To get the ARN for an IAM role:
a. In the navigation pane of the IAM console, choose Roles.
b. In the list of roles, choose the role you want to map to the permission set.
c. In the Summary section, copy the ARN value.
For details, see AWS Identity and Access Management User Guide: Tutorials.

11. Create a named credential that uses the authentication configuration you defined in the external credential. From Setup, enter
Named Credentials in the Quick Find box, select Named Credentials, and then click Named Credentials.
12. To create a new named credential, click New and complete the fields.
• Fill out the Label, Name, and URL fields.
Sample format for the URL would be https://athena.REGION.amazonaws.com For example, if the AWS region is
us-west-2, the URL would be https://athena.us-west-2.amazonaws.com
For details, see Create and Edit a Named Credential.
• For the External Credential field, select the external credential you created that uses the AWS Signature Version 4
authentication protocol.
• Select Generate Authorization Header.

Use the named credential that captures the authentication configuration in external credentials to authenticate Salesforce users against
Amazon Athena, provide limited access to AWS resources, and periodically refresh access tokens.

SEE ALSO:
Named Credentials

983
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define a Legacy Named Credential for Salesforce Connect Adapter for Amazon Athena
Create a legacy named credential that specifies the URL of a callout endpoint as Amazon Athena
EDITIONS
endpoint and provides the required authentication parameters.

Important: In Winter ’23, Salesforce introduced an improved named credential that is Available in: both Salesforce
extensible and customizable. We strongly recommend that you use this preferred credential Classic (not available in all
orgs) and Lightning
instead of legacy named credentials. For information on extensible, customizable named
Experience
credentials, see Named Credentials and External Credentials. Legacy named credentials are
deprecated and will be discontinued in a future release. Available in: All Editions
1. From Setup, enter Named Credentials in the Quick Find box, then select Named
Credentials. USER PERMISSIONS
2. To create a new legacy named credential, click New Legacy from the dropdown menu.
To view named credentials:
3. Complete the fields. • View Setup and
Configuration
Field Description To create, edit, or delete
Label A user-friendly name for the named credential that’s displayed in the named credentials:
Salesforce user interface. • Customize Applications

Name A unique identifier that’s used to refer to this named credential from
callout definition while creating an external data source for Amazon
Athena.

URL The URL of the Amazon Athena endpoint.

Sample format for the URL would be
https://athena.REGION.amazonaws.com
For example, if the AWS region is us-west-2, the URL would be
https://athena.us-west-2.amazonaws.com

Identity Type Select Named Principal to designate one user account on the
Amazon Athena external system for all your Salesforce org users.

Authentication Select AWS Signature Version 4 and complete the following fields.
Protocol a. AWS Access Key ID: First part of the access key used to
sign programmatic requests to AWS.
b. AWS Secret Access Key : Second part of the access key
used to sign programmatic requests to AWS.
c. AWS Region : The AWS region name for the named
credential’s endpoint. For example, us-west-2.

984
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Field Description
d. AWS Service: The AWS utility to access. For example, athena.

SEE ALSO:
AWS Account and Access Keys
Named Credentials
Salesforce Connect Adapter for Amazon Athena

Create an External Data Source for Salesforce Connect Adapter for Amazon Athena
Connect your Salesforce org to access Amazon Athena’s interactive query capabilities.
EDITIONS
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources. Available in: both Salesforce
Classic (not available in all
2. Click New External Data Source, or click Edit to modify an existing external data source.
orgs) and Lightning
3. Complete the fields. Experience (not for
high-data-volume external
Field Description objects)

External Data A user-friendly name for the external data source. The label is displayed Available in: Developer
Source in the Salesforce user interface. Edition

Name A unique identifier that’s used to refer to this external data source Available for an extra cost
in: Enterprise, Performance,
definition through the API.
and Unlimited Editions
Type Select Amazon Athena.

Data Catalog The name of the AWS Glue Data Catalog where the target database USER PERMISSIONS
is registered.
To create and edit external
In most cases, it is the default AwsDataCatalog data source.
data sources:
• Customize Application
Named Enter the named credential URL you defined for Amazon Athena data
Credential source.
You can skip the Authentication section for the external data source.
To access the Amazon Athena external system, Salesforce Connect
uses the authentication settings that are defined in the named
credential.

Connection Number of seconds to wait for a response from the Amazon Athena
Timeout external system before timing out. By default, the value is set to the
maximum of 120 seconds.

Note: Salesforce Connect adapter for Amazon Athena doesn’t support writable external objects. The adapter only supports
read operations on the queried data.

985
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

4. Click Save.

SEE ALSO:
Work with External Data Sources
Salesforce Connect Adapter for Amazon Athena

Validate and Sync External Data Source Configured for Amazon Athena
After you create an external data source for Amazon Athena, synchronize it to map its tables with
EDITIONS
external objects in your Salesforce org.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Available in: both Salesforce
Data Sources. Classic (not available in all
orgs) and Lightning
2. Click the name of the external data source you created for Amazon Athena external system.
Experience
3. Click Validate and Sync.
Salesforce Connect is
4. Select the Amazon Athena database that contains the tables you want to sync. available in: Developer
5. Select the tables and click Sync. Edition and for an extra cost
in: Enterprise, Performance,
Note: Make sure the external object field names exactly match the table column names in and Unlimited Editions
Amazon Athena. Otherwise, queries to Amazon Athena cause a runtime error.
Files Connect for
After the external object and its fields are created, you must provide additional configuration so cloud-based external data
that Salesforce can access Amazon Athena to run queries and respect settings configured by the sources is available in:
AWS administrator. See Manage Qualifiers for Salesforce Connect Adapter for Amazon Athena. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions
SEE ALSO:
Federated Search is
Work with External Data Sources
available in: Enterprise,
Salesforce Connect Adapter for Amazon Athena Professional, Unlimited,
and Developer Editions

USER PERMISSIONS

To create an external object

from an external data
source:
• Customize Application

986
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Manage Qualifiers for Salesforce Connect Adapter for Amazon Athena

Tables and databases in Amazon Athena contain the metadata definitions for the underlying source
EDITIONS
data schema. To be able to make queries to Amazon Athena, use qualifiers to specify the key columns
that identify records in the Amazon Athena data source. Available in: both Salesforce
When you query an Amazon Athena table, the data catalog and database you configured determine Classic (not available in all
the table location. To provide additional configuration: orgs) and Lightning
Experience (not for
1. From Setup, enter External Data Sources in the Quick Find box, then select External
high-data-volume external
Data Sources. objects)
2. Select and click the external data source to edit.
Available in: Developer
3. Under External Objects, select the synced external object to which you want to add qualifiers Edition
and click Manage Qualifiers.
Available for an extra cost
in: Enterprise, Performance,
Field Description and Unlimited Editions
Database Displays the configured Athena database that contains the synced
table for the corresponding external object.

Key Column Specify the column names that represent a unique key for a row in
Name(s) the synced Amazon Athena table.
Salesforce Connect adapter uses these column values to build an
external ID for external object records in Salesforce.

Note: Composite keys can be represented as a

comma-delimited list. For example orderId,productId.

Workgroup Specify the name of the workgroup used by the Salesforce Connect
adapter to make queries to Amazon Athena. The primary workgroup
is the default.
AWS administrators use workgroups to control query access and costs.
Specify the workgroup option to respect those settings.
If you want to create a workgroup to isolate queries from different
workloads, see Using workgroups for running queries.

4. Click Save.

SEE ALSO:
Amazon Athena User Guide: How workgroups work
Salesforce Connect Adapter for Amazon Athena

Access External Data with the Salesforce Connect Adapter for GraphQL
Connect your users to external data sources that expose their capabilities via GraphQL.
To know the GraphQL schema specifications and naming conventions that must be adhered to for the Salesforce Connect adapter for
GraphQL, see Understand GraphQL Schema Requirements.

987
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Salesforce Connect Adapter for GraphQL

GraphQL is a standard query language that allows applications to flexibly access required data and provides a modern way to integrate
applications. Unlike traditional REST APIs, GraphQL provides granularity in specifying fields and relationships and is more efficient.
Set Up Salesforce Connect to Access External Data Exposed via GraphQL
Provide users access to external databases managed via GraphQL and integrate data in Salesforce so that they have a complete view
of the business.
Manage Qualifiers and External IDs for Salesforce Connect Adapter for GraphQL
When you sync a database table to create a Salesforce external object, a table qualifier is automatically generated. The qualifier
constructs an external ID for the external object based on the global id field in the GraphQL schema. You can also configure the
external ID based on any of the ID field types in the GraphQL schema.
Considerations for Salesforce Connect Adapters for GraphQL
Understand the special behaviors, limits, and recommendations for using the Salesforce Connect adapter for Amazon GraphQL.

Salesforce Connect Adapter for GraphQL

GraphQL is a standard query language that allows applications to flexibly access required data and
EDITIONS
provides a modern way to integrate applications. Unlike traditional REST APIs, GraphQL provides
granularity in specifying fields and relationships and is more efficient. Available in: both Salesforce
The Salesforce Connect adapter for GraphQL includes special extensions for AWS AppSync and Classic (not available in all
provides seamless access to Amazon RDS. AWS AppSync hosts the GraphQL endpoint, accepts, and orgs) and Lightning
validates GraphQL queries. The GraphQL resolver interprets GraphQL queries into SQL queries and Experience (not for
executes them against an Amazon RDS-hosted database. You can then create an external data high-data-volume external
source with the endpoint URL set to AppSync GraphQL API and provide access to AWS data source objects)
from Salesforce. Available in: Developer
Edition
Map Salesforce External Object Fields to GraphQL Types Available for an extra cost
When you map external object fields to GraphQL scalar types, you may want to optimize the in: Enterprise, Performance,
type mapping for a better experience in Salesforce. For example, a String in the GraphQL schema and Unlimited Editions
can be mapped to a Picklist in Salesforce to improve data quality.

SEE ALSO:
Salesforce Connect
Set Up Salesforce Connect to Access External Data Exposed via GraphQL
Manage Qualifiers and External IDs for Salesforce Connect Adapter for GraphQL
Considerations for Salesforce Connect Adapters for GraphQL

988
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Map Salesforce External Object Fields to GraphQL Types

When you map external object fields to GraphQL scalar types, you may want to optimize the type
EDITIONS
mapping for a better experience in Salesforce. For example, a String in the GraphQL schema can
be mapped to a Picklist in Salesforce to improve data quality. Available in: both Salesforce
Classic (not available in all
GraphQL Scalar Type Salesforce External Object Field Type orgs) and Lightning
Experience
ID Text
Available in: Developer
String Text
Edition
Int Number Available for an extra cost
Float Number in: Enterprise, Performance,
and Unlimited Editions
Boolean Checkbox

Enum Picklist

Enum (List) Picklist (Multi-select)

Salesforce Connect adapter for GraphQL supports these type conversions.

• String (ISO 8601 Date) GraphQL type to Date Salesforce field type.
• String (ISO 8601 Date/Time) GraphQL type to Date/Time Salesforce field type.
• Int (epoch timestamp) GraphQL type to Date/Time Salesforce field type.
• Customized GraphQL scalar type to Text Salesforce field type.
If you’re using AWS AppSync to access Amazon RDS-hosted databases, this table lists the mapping of AWS AppSync scalars to external
object field types in Salesforce.

AWS AppSync Scalar Type Salesforce External Object Field Type

AWSDate Date

AWSTime Time

AWSDateTime Date/Time

AWSTimestamp Number

AWSEmail Email

AWSJSON Text Area (Long)

AWSPhone Phone

AWSURL URL

AWSIPAddress Text

SEE ALSO:
Custom Field Types
Salesforce Connect Adapter for GraphQL

989
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Set Up Salesforce Connect to Access External Data Exposed via GraphQL

USER PERMISSIONS EDITIONS

To create and edit external data sources: Customize Application Available in: both Salesforce
Classic (not available in all
To create and edit external objects: Customize Application
orgs) and Lightning
To view named credentials: View Setup and Configuration Experience (not for
high-data-volume external
To create, edit, or delete named credentials: Customize Application objects)
To create and edit custom fields: Customize Application Available in: Developer
To edit permission sets and user profiles: Manage Profiles and Permission Sets Edition
Available for an extra cost
To edit another user’s authentication settings Manage Users
in: Enterprise, Performance,
for external systems:
and Unlimited Editions

Provide users access to external databases managed via GraphQL and integrate data in Salesforce
so that they have a complete view of the business.
Before you begin, review GraphQL and AWS AppSync resources:
• To know about GraphQL and explore how it works, see Introduction to GraphQL.
• To know about AWS AppSync, see What is AWS AppSync?
If you’re using AWS AppSync to enable GraphQL API implementation and access Amazon RDS-hosted databases, work with your Amazon
administrator to configure AWS AppSync using the setup template.

Define a Named Credential for Salesforce Connect Adapter for GraphQL

Create a named credential that specifies the endpoint URL of a GraphQL API and an external credential to provide the required
authentication parameters.
Create an External Data Source for Salesforce Connect Adapter for GraphQL
Connect your Salesforce org to data that’s stored in external databases managed via GraphQL.
Sync an External Data Source for Salesforce Connect Adapter for GraphQL
After you create an external data source, synchronize it to map the database tables with external objects in your Salesforce org.

SEE ALSO:
Salesforce Connect
Salesforce Connect Adapter for GraphQL
Manage Qualifiers and External IDs for Salesforce Connect Adapter for GraphQL
Considerations for Salesforce Connect Adapters for GraphQL

990
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Define a Named Credential for Salesforce Connect Adapter for GraphQL

Create a named credential that specifies the endpoint URL of a GraphQL API and an external
EDITIONS
credential to provide the required authentication parameters.
To create an external credential that uses AWS Signature Version 4 authentication protocol, see Available in: both Salesforce
Create and Edit an AWS Signature v4 External Credential. To create a named credential and link it Classic (not available in all
to the external credential, see Create and Edit a Named Credential. orgs) and Lightning
Experience
If you’re creating a named credential for GraphQL API URL hosted by AppSync, URL format would
be https://<unique Available in: All Editions
identifier>.appsync-api.REGION.amazonaws.com/graphql
For example, if the AWS region is us-west-2, the URL would be https://<unique USER PERMISSIONS
identifier>.appsync-api.us-west-2.amazonaws.com/graphql
To view named credentials:
To get the GraphQL API URL hosted by AppSync, go to AWS AppSync Console > APIs and select
• View Setup and
the GraphQL API to use. Under Settings > API Details, copy the API URL. Configuration
To create, edit, or delete
SEE ALSO: named credentials:
Named Credentials • Customize Applications
Salesforce Connect Adapter for GraphQL

Create an External Data Source for Salesforce Connect Adapter for GraphQL
Connect your Salesforce org to data that’s stored in external databases managed via GraphQL.
EDITIONS
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources. Available in: both Salesforce
Classic (not available in all
2. Click New External Data Source, or click Edit to modify an existing external data source.
orgs) and Lightning
3. Complete the fields. Experience (not for
high-data-volume external
Field Description objects)

External Data A user-friendly name for the external data source. The label is displayed Available in: Developer
Source in the Salesforce user interface. Edition

Name A unique identifier that’s used to refer to this external data source Available for an extra cost
in: Enterprise, Performance,
definition through the API.
and Unlimited Editions
Type Select GraphQL.

Named Enter the named credential URL you defined for GraphQL API. USER PERMISSIONS
Credential To access the external system, Salesforce Connect uses the
To create and edit external
authentication settings that are defined in the named credential.
data sources:
• Customize Application
Connection Number of seconds to wait for a response from the external system
Timeout before timing out. By default, the value is set to the maximum of 120
seconds.

Writable Select this option only if you want to create, edit, and delete data
External that’s stored in the external data source. By default, external objects
Objects are read only.

991
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

4. Click Save.

SEE ALSO:
Work with External Data Sources
Salesforce Connect Adapter for GraphQL

Sync an External Data Source for Salesforce Connect Adapter for GraphQL
After you create an external data source, synchronize it to map the database tables with external
EDITIONS
objects in your Salesforce org.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Available in: both Salesforce
Data Sources. Classic (not available in all
orgs) and Lightning
2. Click the name of the external data source you created for the database managed via GraphQL.
Experience (not for
3. Click Validate and Sync. high-data-volume external
4. Select the database tables and click Sync to create Salesforce external objects. objects)

After an external object is created, a table qualifier is automatically created based on the globally Available in: Developer
unique id field in the GraphQL schema. See Manage Qualifiers and Externals IDs. Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

USER PERMISSIONS

To create and edit external

data sources:
• Customize Application

Manage Qualifiers and External IDs for Salesforce Connect Adapter for GraphQL
When you sync a database table to create a Salesforce external object, a table qualifier is automatically
EDITIONS
generated. The qualifier constructs an external ID for the external object based on the global id
field in the GraphQL schema. You can also configure the external ID based on any of the ID field Available in: both Salesforce
types in the GraphQL schema. Classic (not available in all
orgs) and Lightning
Qualifier Options for Salesforce Connect Adapter for GraphQL Experience (not for
high-data-volume external
We recommend you use the default global id in the GraphQL schema to construct the external
objects)
ID of an external object.
Available in: Developer
Edition
SEE ALSO:
Available for an extra cost
Salesforce Connect Adapter for GraphQL
in: Enterprise, Performance,
and Unlimited Editions

992
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Qualifier Options for Salesforce Connect Adapter for GraphQL

We recommend you use the default global id in the GraphQL schema to construct the external ID
EDITIONS
of an external object.
Available in: both Salesforce
Classic (not available in all
orgs) and Lightning
Experience (not for
high-data-volume external
objects)

Available in: Developer

Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

TableQualifier ::=
"tableName": "phyiscalTableName" |
"keyColumns": [" keyColumnName"(, "keyColumnName")*] ||
"columns": {NamedColumnQualifier(, NamedColumnQualifier)*}

NamedColumnQualifier ::=
"columnName": {ColumnQualifier(, ColumnQualifier)*}

ColumnQualifier ::=
"virtual": (true | false) |
"values": [ValueDefinition(, ValueDefinition)*]

ValueDefinition ::=
{ValueQualifier,( ValueQualifier)*}

ValueQualifier ::=
"definition": "functionDefinition" |
"columnOrder": ["columnName"(, "columnName")*]

• TableQualifier: Specific set of properties that are used to identify a table.

• NamedColumnQualifier: Default value for the columnName is NamedColumnQualifier’s column name. If the
ColumnQualifier is virtual, columnName is not specified.
• ColumnQualifier
– virtual: If true, the field doesn't physically exist in the external data source. Default value is false. Virtual fields are defined
using the values formula.
– values: A list of candidate Salesforce formula functions that derive the field value from other fields.

• ValueDefinition: Contains an array of value qualifiers.

• ValueQualifier
– definition: A candidate value defined using Salesforce formula functions. A formula function can be a constant expression
or can depend on one or more field values.
– columnOrder: The lexical field order of the derived field value. The lexical order determines the field sort order in SOQL.

993
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Example: Example
This is a sample table qualifier generated for an external ID based on the id field of the MyOrder table.
{
"columns": {
"ExternalId": {
"virtual": true,
"values": [
{
"definition": "SUBSTITUTE(RIGHT(id,LEN(id)-17),\"\\\\-\",\"-\")"
}
]
},
"id": {
"values": [
{
"definition":
"\"Postgres_MyOrder-\"&SUBSTITUTE(ExternalId,\"-\",\"\\\\-\")"
}
]
}
}
}

SEE ALSO:
Manage Qualifiers and External IDs for Salesforce Connect Adapter for GraphQL

Considerations for Salesforce Connect Adapters for GraphQL

Understand the special behaviors, limits, and recommendations for using the Salesforce Connect
EDITIONS
adapter for Amazon GraphQL.
• To support query pagination, the GraphQL schema must include the first field of type int Available in: both Salesforce
and after field of type string. See Understand GraphQL Schema Requirements and Classic and Lightning
GraphQL: Pagination. Experience

Available in: Developer

Understand GraphQL Schema Requirements Edition
The Salesforce Connect adapter for GraphQL requires that the GraphQL schema adhere to a Available for an extra cost
specific format. in: Enterprise, Performance,
and Unlimited Editions

SEE ALSO:
Salesforce Connect Adapter for GraphQL
Set Up Salesforce Connect to Access External Data Exposed via GraphQL

994
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

Understand GraphQL Schema Requirements

The Salesforce Connect adapter for GraphQL requires that the GraphQL schema adhere to a specific
EDITIONS
format.
This is a representative schema to understand how to construct a schema that works with Salesforce Available in: both Salesforce
Connect. Notations to understand the representative schema: Classic (not available in all
orgs) and Lightning
• ObjName: Denotes the name of a GraphQL object.
Experience (not for
• Bold text: Represents the pattern to follow for each object. high-data-volume external
• Non-bold text: Represents common code, not specific to the objects. objects)

Available in: Developer

Edition
Available for an extra cost
in: Enterprise, Performance,
and Unlimited Editions

type Query {
objName(
limit: Int,
offset: Int,
orderBy: [ObjName_OrderByInput],
where: ObjName_FilterInput,
first: Int,
after: String
): ObjName_Connection
<additional object queries...>
node(id: ID!): Node
}

type Mutation {
create_ObjName(input: ObjName_CreateInput!): ObjName
<additional create mutations>
...
delete_ObjName(id: ID!): ObjName
<additional delete mutations>
...
update_ObjName(input: ObjName_UpdateInput!): ObjName
<additional update mutations>
...
}

type ObjName implements Node {

id: ID!
<fieldName: fieldType>
...
}

type ObjName_Connection {
edges: [ObjName_Edge]
pageInfo: PageInfo!
}

995
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

input ObjName_CreateInput {
<fieldName: fieldType>
...
}

input ObjName_UpdateInput {
id: ID!
<fieldName: fieldType>
...
}

type ObjName_Edge {
cursor: String!
node: ObjName
}

input ObjName_FilterInput {
and: [ObjName_FilterInput]
not: ObjName_FilterInput
or: [ObjName_FilterInput]
id: IDOperator
<fieldName: fieldTypeOperator>
...
}

input ObjName_OrderByInput {
id: OrderByClause
<fieldName >: OrderByClause
...
}

interface Node {
id: ID!
}

enum NullsOrder {
NULLS_FIRST
NULLS_LAST
}

input OrderByClause {
direction: Direction
nulls: NullsOrder
}

type PageInfo {
endCursor: String
hasNextPage: Boolean!
hasPreviousPage: Boolean!
startCursor: String
}

996
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

input StringOperator {
eq: String
gt: String
ge: String
in: [String]
like: String
lt: String
le: String
ne: String
nin: [String]
}

input AWSDateOperator {
eq: AWSDate
gt: AWSDate
ge: AWSDate
in: [AWSDate]
like: AWSDate
lt: AWSDate
le: AWSDate
ne: AWSDate
nin: [AWSDate]
}

input AWSDateTimeOperator {
eq: AWSDateTime
gt: AWSDateTime
ge: AWSDateTime
in: [AWSDateTime]
like: AWSDateTime
lt: AWSDateTime
le: AWSDateTime
ne: AWSDateTime
nin: [AWSDateTime]
}

input AWSJSONOperator {
eq: AWSJSON
gt: AWSJSON
ge: AWSJSON
in: [AWSJSON]
like: AWSJSON
lt: AWSJSON
le: AWSJSON
ne: AWSJSON
nin: [AWSJSON]
}

input AWSTimeOperator {
eq: AWSTime
gt: AWSTime
ge: AWSTime
in: [AWSTime]
like: AWSTime

997
Extend Salesforce with Clicks, Not Code Access External Data With Salesforce Connect

lt: AWSTime
le: AWSTime
ne: AWSTime
nin: [AWSTime]
}

input BooleanOperator {
eq: Boolean
gt: Boolean
gebolded: Boolean
in: [Boolean]
like: Boolean
lt: Boolean
le: Boolean
ne: Boolean
nin: [Boolean]
}

enum Direction {
ASC
DESC
}

input FloatOperator {
eq: Float
gt: Float
ge: Float
in: [Float]
like: Float
lt: Float
le: Float
ne: Float
nin: [Float]
}

input IDOperator {
eq: ID
gt: ID
ge: ID
in: [ID]
like: ID
lt: ID
le: ID
ne: ID
nin: [ID]
}

input IntOperator {
eq: Int
gt: Int
ge: Int
in: [Int]
like: Int
lt: Int

998
Extend Salesforce with Clicks, Not Code Work with External Data Sources

le: Int
ne: Int
nin: [Int]
}

Each object must have an ID! field that’s globally unique and this global ID must be same across all the objects. If you have multiple
fields of type ID! and there isn’t field with id as the field name, use keyColumns qualifier to specify the global ID. See Qualifier
Options.
When an external lookup relationship represents the same lookup relationship that exists between GraphQL objects, keep in mind these
considerations. The external ID field on the parent external object must match the format of the external lookup field of the child external
object. In case they don’t match, use qualifiers to manage one of the following:
• Manipulate the parent external object’s external ID to match the child external lookup.
• Create a virtual column in the child external object to match the parent external ID.
It’s important that the GraphQL global ID and Salesforce external ID can be computed from one another. A possible way to structure a
global ID is to use a prefix to namespace the ID and keep it unique. If the primary key of the object is composed of multiple key fields,
use a delimiter to separate the prefix and the ID. If any of the key fields’ value contains the delimiter, make sure to escape the delimiter.
In this example, ObjName| is the prefix and - is the delimiter. Using | after the ObjName helps to parse the prefix from the key
composition.
id: ObjName|KEY1\-123-KEY2\-456
key1: KEY1-123
key2: KEY2-456

SEE ALSO:
GraphQL: Schemas and Types
Salesforce Connect Adapter for GraphQL

Work with External Data Sources

An external data source specifies how to access an external system. Salesforce Connect uses external data sources to access data that's
stored outside your Salesforce organization. Files Connect uses external data sources to access third-party content systems. External data
sources have associated external objects, which your users and the Lightning platform use to interact with the external data and content.

Define External Data Sources

Create external data sources to connect to content and data that is stored outside your Salesforce org.
Validate and Sync an External Data Source
After you configure an external data source, synchronize it to map its tables with external objects in your Salesforce org. The content
and data of external objects appear in federated search, together with your Salesforce content and data.
Define External Objects
Tables in external systems map to external objects in Salesforce, combining all your data and content for users in your org.
Validate External Object Connections
After you configure an external data source, run the validator tool on each external object to test and troubleshoot its connections.
The tool tests for ID uniqueness and the ability to sort and filter results. Validator is available for external objects from Apex and Odata
data sources.

999
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Grant Access to Authentication Settings for External Data Sources

For external data sources that use per-user authentication, grant users access through permission sets and profiles, so users can set
up and manage their own authentication settings for accessing the external system.
Store Authentication Settings for External Systems
You or your administrator can set up and manage your authentication settings for external systems. With valid authentication settings,
you can access external systems from within your Salesforce org.
External Object Relationships
External objects support standard lookup relationships, which use the 18-character Salesforce record IDs to associate related records
with each other. However, data that’s stored outside your Salesforce org often doesn’t contain those record IDs. Therefore, two
special types of lookup relationships are available for external objects: external lookups and indirect lookups.

Define External Data Sources

Create external data sources to connect to content and data that is stored outside your Salesforce
EDITIONS
org.
1. From Setup, enter External Data Sources in the Quick Find box, then select External Available in: both Salesforce
Data Sources. Classic (not available in all
orgs) and Lightning
2. Click New External Data Source. To modify an existing external data source, click Edit.
Experience
3. Complete the steps for your type of external data source.
Salesforce Connect is
• Files Connect: Google Drive available in: Developer
• Files Connect: SharePoint 2010 or 2013 Edition and for an extra cost
• Files Connect: SharePoint Online or OneDrive for Business in: Enterprise, Performance,
and Unlimited Editions
• Files Connect: Box
Files Connect for
• Simple URL: Data from Another Web Domain cloud-based external data
• Salesforce Connect: OData 2.0 sources is available in:
• Salesforce Connect: OData 4.0 Professional, Enterprise,
Performance, Unlimited,
• Salesforce Connect: Cross-Org
and Developer Editions
• Salesforce Connect: Custom
Federated Search is
• Salesforce Connect adapter for Amazon DynamoDB available in: Enterprise,
• Salesforce Connect adapter for Amazon Athena Professional, Unlimited,
• Federated Search and Developer Editions

SEE ALSO: USER PERMISSIONS

Salesforce Connect To create and edit an
external data source:
• Customize Application

1000
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Validate and Sync an External Data Source

After you configure an external data source, synchronize it to map its tables with external objects
EDITIONS
in your Salesforce org. The content and data of external objects appear in federated search, together
with your Salesforce content and data. Available in: both Salesforce
When you sync a large number of tables, you can select to execute the sync operation asynchronously Classic (not available in all
as a background job and avoid connection timeout. You can view the list of sync operations orgs) and Lightning
performed as background jobs in the corresponding External Data Source page. Experience

Note: Salesforce Connect is

available in: Developer
• Syncing creates or overwrites Salesforce external objects that map to the external system’s Edition and for an extra cost
schema. Syncing doesn’t copy any data into your Salesforce org or write data from your in: Enterprise, Performance,
org to the external system. and Unlimited Editions
• Syncing is a one-time process. If the external system’s schema changes, the modifications Files Connect for
aren’t automatically synced to your Salesforce org. To reflect the changes in the external cloud-based external data
system, resync the objects. After resyncing, full field-level security to the external objects sources is available in:
is granted to all users who have the same profile as the user who initiated the resync. Professional, Enterprise,
• Each org can have up to 200 external objects. External objects don’t count toward the Performance, Unlimited,
amount for custom objects. Syncing fails if it causes your org to exceed 200 external and Developer Editions
objects. Federated Search is
• For Salesforce Connect external data sources, make sure that you read and understand available in: Enterprise,
the sync considerations. See Sync an External Data Source for Salesforce Connect. Professional, Unlimited,
and Developer Editions
1. From Setup, enter External Data Sources in the Quick Find box, then select External
Data Sources.
USER PERMISSIONS
2. Click the name of the external data source.
3. Click Validate and Sync, and confirm that the connection is successful. To create an external object
from an external data
4. Select tables and click Sync to do the following for each selected table. source:
• Automatically create a Salesforce external object. • Customize Application
• Automatically create a custom field for each table column that’s compatible with a Salesforce
metadata field type.

Example: The resulting external data source detail page will include a list of related external objects like this.

1001
Extend Salesforce with Clicks, Not Code Work with External Data Sources

SEE ALSO:
Salesforce Connect

Define External Objects

Tables in external systems map to external objects in Salesforce, combining all your data and content
EDITIONS
for users in your org.
External objects are similar to custom objects, except that they map to data that’s stored outside Available in: both Salesforce
your Salesforce org. Each external object relies on an external data source definition to connect Classic (not available in all
with the external system’s data. Each external object definition maps to a data table on the external orgs) and Lightning
system. Each of the external object’s fields maps to a table column on the external system. External Experience
objects enable your users and the Lightning Platform to search and interact with the external data. Salesforce Connect is
• Each org can have up to 200 external objects. External objects don’t count toward the amount available in: Developer
for custom objects. Edition and for an extra cost
in: Enterprise, Performance,
• If the external system allows it, we recommend that you sync the external data source to
and Unlimited Editions
automatically create related external objects. You can instead choose to manually define external
objects to customize the external object names and manually create the custom fields. Files Connect for
cloud-based external data
To create or modify an external object:
sources is available in:
1. From Setup, enter External Objects in the Quick Find box, then select External Objects. Professional, Enterprise,
Performance, Unlimited,
2. Click New External Object, or click Edit to modify an existing external object.
and Developer Editions
3. Enter the following:
Federated Search is
available in: Enterprise,
Field Description Professional, Unlimited,
Label A user-friendly name for the external object. The label is displayed in and Developer Editions
the Salesforce user interface, such as in list views.
We recommend that you make object labels unique across all USER PERMISSIONS
standard, custom, and external objects in the org.
To create or edit external
Plural Label The plural name of the external object. If you create a tab for this objects:
object, this name is used for the tab. • Customize Application

Starts with If it’s appropriate for your org’s default language, select to precede
vowel sound your label with “an” instead of “a” for any automated messages.

Object Name A unique identifier used to refer to this external object definition when
using the API. Object names must be unique across all standard,
custom, and external objects in the org.
The Object Name field 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.

1002
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Field Description
Description An optional description of the external object. A meaningful description helps you distinguish
among your external objects when you view them in a list.

Context-Sensitive Defines what appears when users click Help for this Page from the external object record home
Help Setting (overview) and detail pages, as well as list views and related lists.
We recommend that you select Open a window using a Visualforce page to display custom
help that you create for your users.
If you instead keep the default value, your users only see Salesforce Help, which doesn’t provide
any information about your external data.
This setting doesn’t affect the Help & Training link at the top of each page, which always opens
Salesforce Help.

Content Name Select the Visualforce page that best describes the data that’s provided by this external object.
This field is available only when you select Open a window using a Visualforce page.

External Data Source The external data source definition that contains the connection details you want to use for this
external object.

Table Name Table in the external system that the external object maps to.
For SharePoint, the table name must match the related scope name.

Display URL Available only for Salesforce Connect. The external object’s Display URL standard field values
Reference Field 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 make sure that the custom field’s values are valid URLs.

Allow Reports Available only for Salesforce Connect.

Deployment Status Indicates whether the external object is visible to other users.

Launch New Custom If selected, the custom tab wizard starts after you save the external object.
Tab Wizard after
saving this external
object

Allow Search If search is also enabled on the external data source, selecting this option lets users find the external
object’s records via SOSL and Salesforce global searches.
By default, search is disabled 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.
However, syncing always overwrites the external object’s search status to match the search status
of the external data source.

1003
Extend Salesforce with Clicks, Not Code Work with External Data Sources

4. Click Save.
5. On the external object detail page, view and modify the external object’s custom fields and relationships, page layouts, field sets,
search layouts, and buttons and links.
• To create field mappings or add fields to an external object, click New on the Custom Fields & Relationships related list.
• To assign different page layouts by user profile, click Page Layout Assignments.

Tip: After you configure an external data source, run the validator tool on each external object to test and troubleshoot its
connections. The tool tests for ID uniqueness and the ability to sort and filter results.

SEE ALSO:
Set Up Salesforce Connect to Access External Data with OData Adapters
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter
Set Up Salesforce Connect to Access External Data with a Custom Adapter
Deployment Status for Custom Objects and External Objects

Validate External Object Connections

After you configure an external data source, run the validator tool on each external object to test
EDITIONS
and troubleshoot its connections. The tool tests for ID uniqueness and the ability to sort and filter
results. Validator is available for external objects from Apex and Odata data sources. Available in: both Salesforce
1. From Setup, enter External Data Source in the Quick Find box, then select External Classic (not available in all
Data Source. orgs) and Lightning
Experience
2. Select the external data source that contains the external object you want to validate.
3. Next to the external object’s name, click Validate. Salesforce Connect is
available in: Developer
4. Select each query type you want validator to run. Edition and for an extra cost
5. Click Run Queries. in: Enterprise, Performance,
and Unlimited Editions
The validator results are displayed. Queries that ran successfully are listed in the Passed Queries
table. The Failed Queries table lists the unsuccessful queries with information to help with Files Connect for
troubleshooting. Queries that weren’t run because a prerequisite query was unsuccessful are in the cloud-based external data
sources is available in:
Skipped Queries table.
Professional, Enterprise,
Performance, Unlimited,
SEE ALSO: and Developer Editions
Define External Objects Federated Search is
available in: Enterprise,
Professional, Unlimited,
and Developer Editions

USER PERMISSIONS

To create or edit external

objects:
• Customize Application

1004
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Grant Access to Authentication Settings for External Data Sources

For external data sources that use per-user authentication, grant users access through permission
EDITIONS
sets and profiles, so users can set up and manage their own authentication settings for accessing
the external system. Available in: both Salesforce
1. From Setup, enter Permission Sets in the Quick Find box, then select Permission Sets Classic (not available in all
or Profiles. orgs) and Lightning
Experience
2. Click the name of the permission set or profile that you want to modify.
3. Do one of the following. Salesforce Connect is
available in: Developer
• For a permission set, or for a profile in the enhanced profile user interface, click External Edition and for an extra cost
Data Source Access in the Apps section. Then click Edit. in: Enterprise, Performance,
• For a profile in the original profile user interface, click Edit in the Enabled External Data and Unlimited Editions
Source Access section. Files Connect for
cloud-based external data
4. Add the data sources that you want to enable. sources is available in:
5. Click Save. Professional, Enterprise,
Performance, Unlimited,
and Developer Editions
SEE ALSO:
Federated Search is
Store Authentication Settings for External Systems
available in: Enterprise,
Set Up Salesforce Connect to Access Data in Another Org with the Cross-Org Adapter Professional, Unlimited,
Set Up Salesforce Connect to Access External Data with OData Adapters and Developer Editions
Set Up Salesforce Connect to Access External Data with a Custom Adapter
USER PERMISSIONS

To edit permission sets and

user profiles:
• Manage Profiles and
Permission Sets

1005
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Store Authentication Settings for External Systems

You or your administrator can set up and manage your authentication settings for external systems.
EDITIONS
With valid authentication settings, you can access external systems from within your Salesforce org.

Note: All credentials stored within the NamedCredential, ExternalDataSource, and Available in: both Salesforce
ExternalDataUserAuth entities are encrypted under a framework that is consistent with other Classic and Lightning
Experience
encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating
org-specific keys. Credentials encrypted using the previous encryption scheme were migrated Named credentials are
to the new framework. available in: All Editions.
Your administrator defines external systems in external data sources and named credentials. External Salesforce Connect is
data sources specify how to access data or content that’s stored outside your Salesforce org. Named available in: Developer
credentials specify callout endpoints, which receive Web service callouts from your org. Edition and for an extra cost
in: Enterprise, Performance,
Before you begin, your administrator:
and Unlimited Editions.
• Sets up the external data source or named credential to use per-user authentication.
Files Connect for
• Grants you access to the external data source or named credential. cloud-based external data
• Verifies that your org can connect to the external system. sources is available in:
Professional, Enterprise,
• Tells you the authentication settings to enter.
Performance, Unlimited,
• Sets up the community, if applicable, by using the Salesforce Tabs + Visualforce template. and Developer Editions
If the community is built with the Customer Service template, only your administrator can set
up and manage your authentication settings for external systems. You can’t complete these
steps on your own. USER PERMISSIONS

If you don’t see the expected settings or options, contact your administrator. To store authentication
settings for an external data
1. Access your authentication settings for external systems with one of these methods. source:
From within a community: • The data source
enabled under External
• If you have a community license, click My Settings > Authentication Settings for External Data Source Access
Systems.
To store authentication
• Otherwise, from your personal settings, enter Authentication, then select settings for a named
Authentication Settings for External Systems credential:
• The named credential
From Salesforce, go to your personal settings and enter Authentication in the Quick
enabled under Named
Find box, then select Authentication Settings for External Systems. Credential Access
2. Click New or Edit. To edit another user’s
authentication settings for
3. Complete the fields. external systems:
• Manage Users
Field Description
External If you’re not sure which option to select, ask your administrator.
System • External Data Source: Provides access to external objects, whose
Definition data is stored outside your Salesforce organization.
• Named Credential: Enables your actions to trigger authenticated
callouts to the endpoint that’s specified in the named credential.
A named credential can handle the authentication for an external
data source. In this scenario, your administrator instructs you to select
Named Credential in this field to access external objects.

1006
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Field Description
External Data Source Which field appears depends on what’s selected for External System Definition.
or If you’re not sure which option to select, ask your administrator. Your administrator can change
Named Credential the option labels to make them more relevant or easier to distinguish from each other.

User Available only to administrators. Select the user whose authentication settings you’re entering.

4. Select the authentication protocol that’s required by the external system. If you’re not sure which option to select, ask your
administrator.
• If you select Password Authentication, enter your username and password for the external system.
• If you select OAuth 2.0, complete these fields.

Field Description
Authentication If you’re not sure which option to select, ask your administrator. Your administrator can change
Provider the option labels to make them more relevant or easier to distinguish from each other.

Scope If you’re not sure what to enter, ask your administrator.

Specifies the scope of permissions to request for the access token.

Start To authenticate to the external system and obtain an OAuth token, select this checkbox. This
Authentication Flow authentication process is called an OAuth flow.
on Save When you click Save, the external system prompts you to log in. After successful login, the
external system grants you an OAuth token for accessing its data from this org.
Redo the OAuth flow when you need a new token—for example, if the token expires—or if
you edit the Scope or Authentication Provider fields. When the token expires,
the external system returns a 401 HTTP error status.

5. Click Save.

SEE ALSO:
Define External Data Sources
Grant Access to Authentication Settings for External Data Sources
Named Credentials
Grant Access to Authentication Settings for Legacy Named Credentials
Add Tabs to Your Salesforce Tabs + Visualforce Site
Personalize Your Salesforce Experience

1007
Extend Salesforce with Clicks, Not Code Work with External Data Sources

External Object Relationships

External objects support standard lookup relationships, which use the 18-character Salesforce record
EDITIONS
IDs to associate related records with each other. However, data that’s stored outside your Salesforce
org often doesn’t contain those record IDs. Therefore, two special types of lookup relationships are Available in: both Salesforce
available for external objects: external lookups and indirect lookups. Classic (not available in all
External lookups and indirect lookups compare a specific field’s values on the parent object to the orgs) and Lightning
relationship field’s values on the child object. When values match, the records are related to each Experience
other. Salesforce Connect is
To create an external object relationship, create a custom field on the child object with one of the available in: Developer
following field types. If the child is an external object, you can instead change the field type of an Edition and for an extra cost
existing custom field to one of the following. in: Enterprise, Performance,
and Unlimited Editions
• Lookup Relationship
Files Connect for
• External Lookup Relationship
cloud-based external data
• Indirect Lookup Relationship sources is available in:
This table summarizes the types of relationships that are available to external objects. Professional, Enterprise,
Performance, Unlimited,
Note: Federated Search supports only external lookup relationships, and the Federated and Developer Editions
Search external object is always the parent.
Federated Search is
available in: Enterprise,
Relationship Allowed Child Allowed Parent Parent Field for Matching Professional, Unlimited,
Objects Objects Records and Developer Editions
Lookup Standard Standard The 18-character Salesforce
Custom Custom record ID

External

External lookup Standard External The External ID standard field

Custom
External

Indirect lookup External Standard You select a custom field with

Custom the External ID and
Unique attributes

Lookup Relationship Fields on External Objects

Use a lookup relationship when the external data includes a column that identifies related Salesforce records by their 18-character
IDs.
External Lookup Relationship Fields on External Objects
Use an external lookup relationship when the parent is an external object.

1008
Extend Salesforce with Clicks, Not Code Work with External Data Sources

Indirect Lookup Relationship Fields on External Objects

Use an indirect lookup relationship when the external data doesn’t include Salesforce record IDs.

SEE ALSO:
Create Custom Fields
Change the Custom Field Type
Considerations for Object Relationships
Include a Files Connect Data Source in Global Search
Object Relationships Overview

Lookup Relationship Fields on External Objects

Use a lookup relationship when the external data includes a column that identifies related Salesforce
EDITIONS
records by their 18-character IDs.
A lookup relationship field links a child standard, custom, or external object to a parent standard Available in: both Salesforce
or custom object. A user who’s editing a child record can click the field’s lookup icon to select a Classic (not available in all
specific parent record, and a user who’s viewing a parent record can view a related list of child orgs) and Lightning
records. Experience

When you create a lookup relationship field on an external object, enter the External Column Name Salesforce Connect is
that contains the 18-character Salesforce IDs for identifying the parent records. available in: Developer
Edition and for an extra cost
Example: in: Enterprise, Performance,
• Account record (parent standard object) displays a related list of external SAP sales orders and Unlimited Editions
(child external object). Files Connect for
• Account record (parent standard object) displays a related list of support cases (child cloud-based external data
standard object). sources is available in:
Professional, Enterprise,
Performance, Unlimited,
SEE ALSO: and Developer Editions
External Object Relationships Federated Search is
Create Custom Fields available in: Enterprise,
Professional, Unlimited,
Considerations for Object Relationships and Developer Editions
Include a Files Connect Data Source in Global Search

1009
Extend Salesforce with Clicks, Not Code Work with External Data Sources

External Lookup Relationship Fields on External Objects

Use an external lookup relationship when the parent is an external object.
EDITIONS
An external lookup relationship links a child standard, custom, or external object to a parent external
object. Available in: both Salesforce
Classic (not available in all
The values of the standard External ID field on the parent external object are matched against the
orgs) and Lightning
values of the external lookup relationship field. For a child external object, the values of the external
Experience
lookup relationship field come from the specified External Column Name.
When you sync two external system tables with a lookup relationship field, an external lookup Salesforce Connect is
available in: Developer
relationship for the mapped external objects is automatically created. This auto mapping happens
Edition and for an extra cost
only if
in: Enterprise, Performance,
• The parent and child objects are synced from the same data source. and Unlimited Editions
• The parent object is already synced or the parent and child objects are in the same sync Files Connect for
operation. cloud-based external data
sources is available in:
Note: For the OData 2.0 adapter, creating an external lookup relationship is supported only
Professional, Enterprise,
in the default Olingo library and not supported in OData4J. Performance, Unlimited,
Example: and Developer Editions

• External product catalog item (parent external object) displays a related list of support Federated Search is
available in: Enterprise,
cases (child standard object).
Professional, Unlimited,
• External customer (parent external object) displays a related list of external orders (child and Developer Editions
external object).

Example: For the cross-org adapter for Salesforce Connect, suppose that you store contacts
and accounts in the provider org. From the subscriber org, you want to view each account’s
related contacts. To do so, create an external lookup field on the subscriber org’s Contact
external object. Link that external lookup field to the subscriber org’s Account external object.
Then set up the page layouts for the Account external object to include a related list that
displays the related Contact external object records.

Example: In this screenshot, a record detail page for the Business_Partner external object includes two related lists of child
objects. This example shows how external lookup relationships and page layouts enable users to view related data from within
and from outside their Salesforce org on a single page.
• Account standard object (1)
• Sales_Order external object (2)

1010
Extend Salesforce with Clicks, Not Code Work with External Data Sources

SEE ALSO:
External Object Relationships
Create Custom Fields
Change the Custom Field Type
Considerations for Object Relationships
Include a Files Connect Data Source in Global Search

1011
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Indirect Lookup Relationship Fields on External Objects

Use an indirect lookup relationship when the external data doesn’t include Salesforce record IDs.
EDITIONS
An indirect lookup relationship links a child external object to a parent standard or custom object.
When you create an indirect lookup relationship field on an external object, you specify the parent Available in: both Salesforce
object field and the child object field to match against each other. Classic (not available in all
orgs) and Lightning
Specifically, you select a custom unique, external ID field on the parent object to match against the
Experience
child’s indirect lookup relationship field, whose values are determined by the specified External
Column Name. Salesforce Connect is
available in: Developer
If the external system uses case-sensitive values in the specified External Column Name, make sure
Edition and for an extra cost
that the parent object field is also case-sensitive. When you define the parent object’s custom field,
in: Enterprise, Performance,
select External ID, Unique, and Treat "ABC" and "abc" as different values (case sensitive).
and Unlimited Editions
Note: Only objects that have a custom field with the External ID and Unique Files Connect for
attributes are available as parent objects in indirect lookup relationships. If you don't see the cloud-based external data
desired object when you create an indirect lookup relationship field, add a custom unique, sources is available in:
external ID field to that object. Professional, Enterprise,
Performance, Unlimited,
Example: and Developer Editions
• Account record (parent standard object) displays a related list of SAP sales orders (child Federated Search is
external object) with matching customer IDs that aren’t Salesforce IDs. available in: Enterprise,
• Contact record (parent standard object) displays a related list of social media posts (child Professional, Unlimited,
external object) with matching social media handles. and Developer Editions

SEE ALSO:
External Object Relationships
Create Custom Fields
Change the Custom Field Type
Considerations for Object Relationships
Include a Files Connect Data Source in Global Search

Connect Business Processes with Real-Time Events

Publish and subscribe to platform events to connect business processes in Salesforce and external sources through the exchange of
real-time event data. Also, use event relays to integrate platform events and change data capture events with Amazon EventBridge.

Define and Manage Platform Events

Use platform events to connect business processes in Salesforce and external sources through the exchange of real-time event data.
Platform events are secure and scalable. Define fields to customize your platform event data.
Event Relay
Integrate your real-time events with Amazon Web Services (AWS). Use Event Relay to send platform events and change data capture
events from Salesforce to Amazon EventBridge.

1012
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Define and Manage Platform Events

Use platform events to connect business processes in Salesforce and external sources through the
EDITIONS
exchange of real-time event data. Platform events are secure and scalable. Define fields to customize
your platform event data. Available in both Salesforce
By using platform events, publishers can send custom event data through Apex, a process, a flow, Classic and Lightning
or an API. Subscribers can receive custom event messages from Salesforce or an external system Experience
using Apex, CometD clients, processes, or flows. Based on the event message data, subscribers can
Available in: Performance,
process custom business logic, such as sending an email or logging a case. For example, a software Unlimited, Enterprise, and
system monitoring a printer can make an API call to publish an event when the ink is low. The Developer Editions
custom printer event can contain custom fields for the printer model, serial number, and ink level.
The event is processed in Salesforce by an Apex trigger that places an order for a new cartridge.
USER PERMISSIONS
Platform events simplify the process of communicating changes and responding to them without
writing complex logic. Publishers and subscribers communicate with each other through events. To create and edit platform
Multiple subscribers can listen to the same event and carry out different actions. event definitions:
• Customize Application

Define Your Platform Event

To define a platform event in Salesforce Classic or Lightning Experience:
1. From Setup, enter Platform Events in the Quick Find box, then select Platform Events.
2. On the Platform Events page, click New Platform Event.
3. Complete the standard fields, and optionally add a description.
4. For Publish Behavior, choose when the event message is published in a transaction.
• Publish After Commit to have the event message published only after a transaction commits successfully. Select this option
if subscribers rely on data that the publishing transaction commits. For example, a process publishes an event message and
creates a task record. A second process that is subscribed to the event is fired and expects to find the task record. Another reason
for choosing this behavior is when you don't want the event message to be published if the transaction fails.
• Publish Immediately to have the event message published when the publish call executes. Select this option if you want the
event message to be published regardless of whether the transaction succeeds. Also choose this option if the publisher and
subscribers are independent, and subscribers don't rely on data committed by the publisher. For example, the immediate
publishing behavior is suitable for an event used for logging purposes. With this option, a subscriber can receive the event
message before data is committed by the publisher transaction.

5. Click Save.
6. To add a field, in the Custom Fields & Relationships related list, click New.
7. To set up the field properties, follow the custom field wizard.

Note:
• If you change the publish behavior, expect up to a 5-minute delay for the change to take effect.
• In Lightning Experience, platform events aren’t shown in the Object Manager’s list of standard and custom objects and aren’t
available in Schema Builder.

A platform event is a special Salesforce entity, similar in many ways to an sObject. An event message is an instance of a platform event,
similar to how a record is an instance of a custom object. Unlike custom objects, you can’t update or delete event records. You also can’t
view event records in the Salesforce user interface, and platform events don’t have page layouts. When you delete a platform event
definition, it’s permanently deleted.

1013
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Standard Fields
Platform events include standard fields. These fields appear on the New Platform Event page.

Field Description
Label Name used to refer to your platform event in a user interface page.

Plural Label Plural name of the platform event.

Starts with a vowel sound If it’s appropriate for your org’s default language, indicate whether
the label is preceded by “an” instead of “a.”

Object Name Unique name used to refer to the platform event when using the
API. In managed packages, this name prevents naming conflicts
with package installations. Use only alphanumeric characters and
underscores. The name must begin with a letter and have no
spaces. It can't end with an underscore or have two consecutive
underscores.

Description Optional description of the object. A meaningful description helps

you remember the differences between your events when you
view them in a list.

Deployment Status Indicates whether the platform event is visible to other users.

Custom Fields
In addition to the standard fields, you can add custom fields to your custom event. Platform event custom fields support only these field
types.
• Checkbox
• Date
• Date/Time
• Number
• Text
• Text Area (Long)
The maximum number of fields that you can add to a platform event is the same as for a custom object. See Salesforce Features and
Edition Allocations.

ReplayId System Field

Each event message is assigned an opaque ID contained in the ReplayId field. The ReplayId field value, which is populated by
the system when the event is delivered to subscribers, refers to the position of the event in the event stream. Replay ID values aren't
guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve
events that are within the retention window. For example, a subscriber can retrieve missed events after a connection failure. Subscribers
must not compute new replay IDs based on a stored replay ID to refer to other events in the stream.

1014
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

EventUuid System Field

A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later. The
API version corresponds to the version that an Apex trigger is saved with, or the version specified in a CometD subscriber endpoint.

API Name Suffix for Custom Platform Events

When you create a platform event, the system appends the __e suffix to create the API name of the event. For example, if you create
an event with the object name Low Ink, the API name is Low_Ink__e. The API name is used whenever you refer to the event
programmatically, for example, in Apex. API names of standard platform events, such as AssetTokenEvent, don’t include a suffix.

Event Subscribers
The Subscriptions related list shows all triggers, processes, and platform event–triggered flows that are subscribed to a platform event.
CometD subscribers, such as your own CometD client or the empApi Lightning component, aren't listed in this page.
The list shows the replay ID of the event that the system last processed (Last Processed Id field) and the event last published (Last
Published Id field). Knowing which replay ID was last processed is useful when there’s a gap in the events published and processed. For
example, if a trigger contains complex logic that causes a delay in processing large batches of incoming events.

Note: For high-volume platform events, the Last Published Id value isn't available and is always shown as Not Available.

Also, the Subscriptions list shows the state of each subscriber, which can be one of the following.
• Running—The subscriber is actively listening to events. If you modify the subscriber, the subscription continues to process events.
• Error— The subscriber was disconnected and stopped receiving published events. A trigger reaches this state when it exceeds
the number of maximum retries with the EventBus.RetryableException. Trigger assertion failures and unhandled
exceptions don’t cause the error state. We recommend limiting the retries to fewer than nine times to avoid reaching this state.
When you fix and save the trigger, or for a managed package trigger, if you redeploy the package, the trigger resumes automatically
from the tip, starting from new events. Also, you can resume a trigger subscription in the subscription detail page that you access
from the platform event page.
• Suspended—The subscriber is disconnected and can’t receive events because a Salesforce admin suspended it or due to an
internal error. You can resume a trigger subscription in the subscription detail page that you access from the platform event page.
To resume a process, deactivate it and then reactivate it. If you modify the subscriber, the subscription resumes automatically from
the tip, starting from new events.

Note: Only one “Process” subscriber appears in the Subscriptions related list for all paused flow interviews that are subscribed to
the platform event. Processes and platform event–triggered flows are listed individually.
Also, information about event subscribers is exposed in the EventBusSubscriber object. You can query this object to obtain details about
subscribers.

Suspend or Resume an Apex Trigger Subscription

Resume a suspended trigger subscription where it left off, starting from the earliest available event message that is stored in the event
bus. If you want to bypass event messages that are causing errors or are no longer needed, you can resume a subscription from the tip,
starting from new event messages.
To manage a trigger subscription:
1. In the Subscriptions related list, click Manage next to the Apex trigger.
2. In the subscription detail page, choose the appropriate action.
• To suspend a running subscription, click Suspend.

1015
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

• To resume a suspended subscription, starting from the earliest event message that is available in the event bus, click Resume.
• To resume a suspended subscription, starting from new event messages, click Resume from Tip.

You can’t manage subscriptions for flows and processes through the Subscriptions related list.

Note:
• After you modify a subscriber, the subscription resumes automatically. For more information, see the Event Subscribers section.
• If you click Resume for a trigger that is in the error state, the trigger skips the events that were retried with
EventBus.RetryableException. The subscription starts with the unprocessed events sent after the error state and
that are within the retention window.

Platform Event Considerations

• Field-Level Security—All platform event fields are read only by default, and you can’t restrict access to a particular field. Field-level
security permissions don’t apply and the event message contains all fields.
• Enforcement of Field Attributes—Platform event records are validated to ensure that the attributes of their custom fields are enforced.
Field attributes include the Required and Default attributes, the precision of number fields, and the maximum length of text fields.
• Permanent Deletion of Event Definitions—When you delete an event definition, it’s permanently removed and can’t be restored.
Before you delete the event definition, delete the associated triggers. Published events that use the definition are also deleted.
• Renaming Event Objects—Before you rename an event, delete the associated triggers. If the event name is modified after clients
have subscribed to this event, the subscribed clients must resubscribe to the updated topic. To resubscribe to the new event, add
your trigger for the renamed event object.
• No Associated Tab—Platform events don’t have an associated tab because you can’t view event records in the Salesforce user
interface.
• No SOQL Support—You can’t query event messages using SOQL.
• No Record Page Support in Lightning App Builder—When creating a record page in Lightning App Builder, platform events that
you defined show up in the list of objects for the page. However, you can’t create a Lightning record page for platform events because
event records aren’t available in the user interface.
• Platform Events in Package Uninstall—When uninstalling a package with the option Save a copy of this package's data for 48
hours after uninstall enabled, platform events aren’t exported.
• Event Volume in Package Installations and Upgrades—Installing a managed or unmanaged package that contains a standard-volume
platform event causes the event type to be saved as high volume in the subscriber org. Upgrading a managed package doesn't
change t he event volume in the subscriber org.
• No Support in Professional and Group Editions—Platform events aren’t supported in Professional and Group Edition orgs. Installation
of a package that contains platform event objects fails in those orgs.

SEE ALSO:
Platform Events Developer Guide

Event Relay
Integrate your real-time events with Amazon Web Services (AWS). Use Event Relay to send platform events and change data capture
events from Salesforce to Amazon EventBridge.

1016
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Get Started
By using Event Relay in Salesforce with Amazon EventBridge in AWS, your Salesforce event-driven apps can use AWS services to
process events or send events to third-party and SaaS integrations. You can also send platform events from AWS to Salesforce, where
subscribers can process them using Salesforce Platform capabilities.
Relay Events from Salesforce to Amazon EventBridge
This section contains steps to create an event relay in Salesforce.
Event Relay Statuses and Options
Check out information about event relay statuses and the error recovery option.
Send Events from AWS Back to Salesforce Using an API Destination
An API destination is the target of a rule, and it enables you to route events to HTTP endpoints. Specifically, you can use an API
destination to publish an event to Salesforce from EventBridge using REST API.

Get Started
By using Event Relay in Salesforce with Amazon EventBridge in AWS, your Salesforce event-driven
EDITIONS
apps can use AWS services to process events or send events to third-party and SaaS integrations.
You can also send platform events from AWS to Salesforce, where subscribers can process them Available in: Lightning
using Salesforce Platform capabilities. Experience

Available in: Enterprise,

Bidirectional Event Flow Between Salesforce and AWS Unlimited, and Developer
With Event Relay, you don’t need an integration app to subscribe to events from Salesforce and editions.
publish them to AWS. After you set up an event relay, each custom platform event or change data Not Available in:
capture event that is published to the Salesforce event bus is automatically forwarded to an event Non-Hyperforce Public
bus in Amazon EventBridge. Cloud, Government Cloud,
Also, you can publish event messages from AWS back to Salesforce using EventBridge API and Hyperforce instances.
destinations. The bidirectional event flow between Salesforce and AWS enables your event-driven For a list of the unsupported
apps to use the capabilities of AWS services and the Salesforce Platform. instances, see "Public Cloud
Instances" and "Hyperforce
Instances" in Where is my
Salesforce instance
located?. To determine
which instance your
Salesforce org is on, see
View instance information
for your Salesforce
Organization.

1017
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Managed Event Stream

Event relay subscribes to the events in the channel and streams them from the Salesforce event bus to EventBridge. Event relay keeps
track of the point in the stream where the last event was sent to EventBridge. If transient errors occur, such as connectivity issues, event
relay resumes automatically after the errors are resolved. It attempts to resume the event stream from where it left off, if possible. Also,
you can monitor the status of your event relays, and can change the status by starting, pausing, and stopping an event relay.

Additional Resources
To learn more about Amazon EventBridge, see What Is Amazon EventBridge? in the AWS documentation. To learn more about event
relay and platform events, refer to these resources.
• Video: Salesforce Platform and AWS. This video covers event relays and another product that integrates with Amazon DynamoDB.
• Trailhead: Platform Events Basics
• Trailhead: Change Data Capture Basics
• Platform Events Developer Guide
• Change Data Capture Developer Guide

Event Integration with Amazon Eventbridge

After creating the event relay in Salesforce, the event relay creates a partner event source in EventBridge. You associate the partner
event source with an event bus. After you start the event relay in Salesforce, the event bus in EventBridge receives the events
published and relayed from the Salesforce event bus. You can process the received events using AWS services.
Sending Events to Salesforce using API Destinations
After processing the events in AWS, you can publish an event to Salesforce using an API destination. An API destination is an HTTP
endpoint that an EventBridge rule can invoke.

1018
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Event Relays in Setup

An event relay is a set of event configurations and a connection to a partner event source in Amazon EvenBridge. An event relay
streams events from the Salesforce event bus to EventBridge. You can create an event relay in Setup.
Event Channels
An event relay uses an event channel. A channel is a stream of events in the Salesforce event bus. A single channel can contain
multiple types of platform events or change data capture events, but not both.
Event Relay Security
Event relays send events to Amazon EventBridge securely using HTTP/1.1 with TLS. Event data is encrypted while in transit over the
web. Salesforce is a registered partner of Amazon EventBridge and uses EventBridge Partner APIs to send events to Amazon
EventBridge.
Event Type, Size, and Features
Check out what event types and features are supported with event relays.
Event Relay Considerations
Keep these considerations in mind when using Event Relay.
Event Relay Allocations
Check out allocations related to the event relays that you can create and events relayed to Amazon EventBridge.

Event Integration with Amazon Eventbridge

After creating the event relay in Salesforce, the event relay creates a partner event source in EventBridge. You associate the partner event
source with an event bus. After you start the event relay in Salesforce, the event bus in EventBridge receives the events published and
relayed from the Salesforce event bus. You can process the received events using AWS services.

For more information, see Amazon EventBridge Partner Onboarding Guide in the AWS documentation.

Process Events in Amazon EventBridge Using Rules

When you publish an event to the Salesforce event bus, Salesforce relays the event to AWS using the connection that is set up through
the event relay configuration. After events are received in Amazon EventBridge from Salesforce, you can process the received events in
EventBridge using rules.
Rules match incoming events in an event bus and assign them to targets. Use targets, such as AWS services, to perform actions on events.
You can add one or more targets to a rule. With rules, you can filter on the payload so that you can send specific events to specific targets.
For more information, see Amazon EventBridge rules and Amazon EventBridge targets in the AWS documentation.

1019
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Sending Events to Salesforce using API Destinations

After processing the events in AWS, you can publish an event to Salesforce using an API destination. An API destination is an HTTP
endpoint that an EventBridge rule can invoke.
To publish an event to Salesforce, the API destination configuration contains the REST API endpoint of the platform event and performs
a POST request to this endpoint. It uses the Salesforce org authentication credentials that you set. The sent event must be defined as a
custom platform event in Salesforce. Subscribers that have been set up for this platform event, such as a flow or an Apex trigger, receive
the sent platform event and can process it.

SEE ALSO:
AWS Documentation: API Destinations

Event Relays in Setup

An event relay is a set of event configurations and a connection to a partner event source in Amazon EvenBridge. An event relay streams
events from the Salesforce event bus to EventBridge. You can create an event relay in Setup.
This image shows a list of event relays set up for various event channels, in Setup, in the Event Relays page.

1020
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Event Relay Components

An event relay includes your AWS account information and a Salesforce event channel that you set up. The event relay status indicates
whether the relay is running or is in another state (1). The event channel is the stream of events in the Salesforce event bus to be relayed
to EventBridge (2). An event channel contains members for the events to stream. The number of members a channel contains is shown
in the event relays list (3). A named credential contains your AWS account and AWS region information where to relay the events (4).
After you create an event relay, Salesforce creates a corresponding partner event source in EventBridge.

Monitor the Event Relay Execution in Setup

Check your event relay's execution status, the date, and time of the last relayed event, and any error message.
To view the status of all the event relays, check the Status column in the Event Relays page.

If the status is Error, you can view the error message on the event relay detail page by clicking the event relay.
To get the timestamp of the last event relayed to Amazon EventBridge, click the event relay and check out the Last Relayed field.

Event Channels
An event relay uses an event channel. A channel is a stream of events in the Salesforce event bus. A single channel can contain multiple
types of platform events or change data capture events, but not both.

1021
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Each event relay is associated with a unique channel that’s identified by its channel ID. Don’t reuse a channel for another event relay.

Tip: To stream the same type of event to different AWS regions, create a separate channel for each AWS region, and then create
an event relay for each channel.

Custom Channels for Platform Events and Change Events

Use a custom channel to group event messages from one or more events through channel members. For example, for platform events,
if MyEvent1__e is a custom platform event defined in Salesforce, create a channel to receive event messages for MyEvent1__e
if you add a channel member for MyEvent1__e. To receive event messages for another event on that channel, such as MyEvent2__e,
add a channel member for MyEvent2__e.

Tip: If you’re using a custom platform event, make sure that platform event is defined in Salesforce. For more information, see
Platform Event Fields in the Platform Events Developer Guide.
Similarly, for change data capture, you can create a custom channel to receive change event messages. If you create a channel for
changes in one Salesforce object, such as AccountChangeEvent, the channel contains one member for AccountChangeEvent.
To receive events for another Salesforce object, such as LeadChangeEvent, add another channel member.

Tip: Salesforce provides change events, so you don’t define them.

For more information about creating custom channels, see Create a Channel and Channel Members.

The Standard ChangeEvents Channel

The pre-defined standard channel ChangeEvents includes all change events that correspond to the Salesforce objects that you
select in Setup. You can select ChangeEvents from the channels dropdown in the event relay creation wizard. Before you can use
the standard ChangeEvents channel, from Setup, select the objects that you want change events for in the Change Data Capture
page. For more information, see Select Objects for Change Notifications in the User Interface in the Change Data Capture Developer Guide.

Event Relay Security

Event relays send events to Amazon EventBridge securely using HTTP/1.1 with TLS. Event data is encrypted while in transit over the web.
Salesforce is a registered partner of Amazon EventBridge and uses EventBridge Partner APIs to send events to Amazon EventBridge.
As a registered partner of EventBridge, Salesforce creates partner event sources and streams events to EventBridge without the need
for AWS account authentication. Event relays use only the AWS account ID and region, which are stored in named credentials.

SEE ALSO:
Amazon EventBridge Partner Onboarding Guide
Create a Named Credential

Event Type, Size, and Features

Check out what event types and features are supported with event relays.
The event types and maximum event sizes that Event Relay supports are:
• Custom high-volume platform events
• Change data capture events
• The maximum event message size that Salesforce supports for published and received events is 1 MB.
• The maximum event message size that Amazon EventBridge supports for incoming and outgoing events is 256 KB.

1022
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

• If an event message larger than 256 KB is relayed from Salesforce to EventBridge, the event isn’t delivered to EventBridge.
These event types aren’t supported.
• Standard platform events, including real-time monitoring events
• Standard-volume custom platform events
These features aren’t supported with Event Relay.
• Change data capture event enrichment
• Stream filtering for change data capture or platform events
• Salesforce Private Connect
• Developer Edition orgs with namespaces

Event Relay Considerations

Keep these considerations in mind when using Event Relay.

Deleting an Event Relay

When you delete an event relay, its corresponding partner event source in Amazon EventBridge is deleted. The event bus that is associated
with the partner event source in AWS isn’t affected.

Packaging an Event Relay

You can’t package an event relay in a managed package because event relays don't support namespaces. Also, the objects that an event
relay references—the event channel and its members, and the named credential—can't have namespaces.
You can package an event relay in an unmanaged package. If you do so, make sure to also add to the package the named credential
that the event relay references. The package manager doesn't add it automatically.

Event Encryption with Platform Shield Encryption

Starting in Summer ’23, Event Relay supports Salesforce orgs with Shield Platform Encryption enabled. You can send platform events
and change data capture events encrypted at rest with Shield Platform Encryption to Amazon EventBridge. We recommend that you
wait until Summer '23 is deployed to you before you use event relays with Shield Platform Encryption. Using event relays with Shield
Platform Encryption enabled before Summer '23 can lead to unexpected behavior.
For more information about event encryption at rest with Shield Platform Encryption, see Encrypting Platform Event Messages at Rest
in the Event Bus in the Platform Events Developer Guide and Change Events for Encrypted Salesforce Data in the Change Data Capture
Developer Guide.

AWS Regions
The Event Relay service is globally available and can connect Salesforce orgs in first-party data centers to AWS accounts in any region.
Customer understands and agrees that the Event Relay service processes data, including Customer Data, on Hyperforce (a
Salesforce-controlled Amazon Web Services instance), and such processing may occur in a region outside of the region in which
Customer’s Salesforce org is located.
Regions:
• Processing occurs in the United States region.
Events aren’t persisted or stored outside the region your org is located.

1023
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Salesforce Org Migration to Hyperforce

The Event Relay service isn’t available for Salesforce orgs that run on the Hyperforce infrastructure. If you use event relays and your org
migrates to Hyperforce, you can no longer use event relays to forward events from Salesforce to Amazon EventBridge. However, you
can implement a workaround that mimics event relays. To learn how to implement a workaround, contact Salesforce Customer Success.

Event Relay Allocations

Check out allocations related to the event relays that you can create and events relayed to Amazon EventBridge.
Number of Event Relays
The maximum number of event relays that you can create is 200.
Events Delivered to Amazon EventBridge
The maximum number of platform events and change events delivered to Amazon EventBridge in the last 24 hours across all event
relays corresponds to your event allocations. The event delivery allocations are common for platform events and change events.
Also, they’re shared with CometD clients, Pub/Sub API clients, and empApi Lightning components. For more information, see Platform
Event Allocations in the Platform Event Developer Guide and Change Data Capture Allocations in the Change Data Capture Developer
Guide.

Relay Events from Salesforce to Amazon EventBridge

This section contains steps to create an event relay in Salesforce.

Create Prerequisite Items

Create the prerequisite items that your event relay uses, such as a named credential, a channel, a channel member, and optionally
a platform event.
Create an Event Relay in Setup
After creating the prerequisite items, follow the steps in this section to create an event relay using a point-and-click interface in
Setup.
Verify and Process Events in EventBridge
Verify receiving events in EventBridge and process them with AWS services.

Create Prerequisite Items

Create the prerequisite items that your event relay uses, such as a named credential, a channel, a channel member, and optionally a
platform event.

(Optional) Define a Platform Event

If you have a custom platform event defined in your Salesforce org that you want to use for the event relay, you can skip this step.
You can also skip this step if you want to use the event relay with a change data capture event. Otherwise, follow the steps in this
section to define an example platform event, Carbon_Comparison__e, which the event relay configuration steps use.
Create a Named Credential
A named credential stores your AWS account information. You use the named credential later to set up an event relay. You can
create a named credential in the Salesforce user interface in Setup.

1024
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Create a Channel and Channel Members

You can create a channel and add members using Tooling API. A channel is a stream of events. It contains members that specify the
type of events that can be received on the channel. A channel can contain a stream of platform events or change data capture
events, but not both. For a channel of change data capture events, you can select the standard ChangeEvents channel instead
of creating a custom channel.

(Optional) Define a Platform Event

If you have a custom platform event defined in your Salesforce org that you want to use for the
USER PERMISSIONS
event relay, you can skip this step. You can also skip this step if you want to use the event relay with
a change data capture event. Otherwise, follow the steps in this section to define an example To define a platform event:
platform event, Carbon_Comparison__e, which the event relay configuration steps use. • Customize Application
1. From Setup, in the Quick Find box, enter Platform Events, and then select Platform
Events.
2. Click New Platform Event.
3. Provide these values.
• Label: Carbon Comparison
• Plural Label: Carbon Comparisons

4. Save your changes.

5. Create these fields. In Custom Fields & Relationships, click New for each field, and follow the wizard.
• Field type: Number, Field Label: Annual Mileage, Length: 6, Decimal Places: 0
• Field type: Text, Field Label: Current Vehicle, Length: 100
• Field type: Text, Field Label: Model Year, Length: 4

Create a Named Credential

A named credential stores your AWS account information. You use the named credential later to
USER PERMISSIONS
set up an event relay. You can create a named credential in the Salesforce user interface in Setup.
1. From Setup, in the Quick Find box, enter Named Credentials, and then select Named To create a named
credential:
Credentials.
• Customize Application
2. Expand the dropdown next to New, and then click New Legacy.
3. Complete the fields.
a. For Label, enter AWS US-West-2.
b. For Name, enter AWS_US_West_2.
c. For URL, enter a URL in the format arn:aws:aws_region:aws_account_number. Replace the aws_region placeholder
with your AWS region. Replace the aws_account_number placeholder with your 12-digit AWS account ID. The URL is
case-sensitive, and aws_region is in capital letters. For example, the URL for an account in the US-WEST-2 region has this
format: arn:aws:US-WEST-2:XXXXXXXXXXXX. (XXXXXXXXXXXX is a placeholder for the 12-digit AWS account ID.)
d. Keep the defaults for Identity Type and Authentication Protocol.
e. Keep Generate Authorization Header selected.

4. Save your changes.

1025
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

SEE ALSO:
Tooling API Developer Guide: NamedCredential
Metadata API Developer Guide: NamedCredential

Create a Channel and Channel Members

You can create a channel and add members using Tooling API. A channel is a stream of events. It contains members that specify the
type of events that can be received on the channel. A channel can contain a stream of platform events or change data capture events,
but not both. For a channel of change data capture events, you can select the standard ChangeEvents channel instead of creating
a custom channel.
To learn about custom channels and the standard ChangeEvents channel, see Event Channels.

Prerequisite: Set Up a REST API Tool

The setup steps in this section use the Tooling REST API. To complete the steps, you can use your favorite REST API tool. We recommend
using Postman with the Salesforce API Collection, which contains handy templates for Salesforce API calls, including calls for creating
channels and channel members. For instructions on how to set up Postman, see Quick Start: Connect Postman to Salesforce in Trailhead.

Create a Channel for Custom Platform Events or Change Events

To create a channel and channel member for custom platform events, complete the steps in this section for custom platform events.
To create a channel and channel member for change events, complete the steps in this section for change events.

1026
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

After creating a channel, you can add members to the channel. Each member represents one event type. A channel can have multiple
members.

Create a Channel for a Custom Platform Event

Create a channel that holds a stream of custom platform events.
Add a Custom Platform Event in a New Channel Member
To add a platform event to the channel that you created, create a channel member.
Create a Channel for a Change Event
Create a channel that holds a stream of change data capture events.
Add a Change Event in a New Channel Member
To add a change event to the channel that you created, add a channel member.

Create a Channel for a Custom Platform Event

Create a channel that holds a stream of custom platform events.
USER PERMISSIONS
1. Send a POST request to this URI.
To create a
PlatformEventChannel:
• Customize Application

/services/data/v58.0/tooling/sobjects/PlatformEventChannel

2. If you’re using Postman, expand Event Platform > Custom Channels > Platform Event, and click Create channel.
3. To configure a channel that receives custom platform event messages, set channelType to event. The channel label
appears in the event relays UI. Use this example request body. In Postman, click Body, and replace the body with this JSON body.
{
"FullName": "Carbon_Comparison_Channel__chn",
"Metadata": {
"channelType": "event",
"label": "Carbon Comparison Channel"
}
}

4. Send the request. The response received looks similar to this response.
{
"id": "0YLRM00000001es4AA",
"success": true,
"errors": [],
"warnings": [],
"infos": []
}

1027
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Now that you created a channel for platform events, add a channel member for one custom platform event. See Add a Custom Platform
Event in a New Channel Member.

SEE ALSO:
Tooling API Developer Guide: PlatformEventChannel
Metadata API Developer Guide: PlatformEventChannel

Add a Custom Platform Event in a New Channel Member

To add a platform event to the channel that you created, create a channel member.
USER PERMISSIONS
Prerequisites:
To create a
• Create a Channel for a Custom Platform Event PlatformEventChannel:
• Define the Carbon_Comparison__e platform event in (Optional) Define a Platform Event for • Customize Application
this channel member.
1. Send a POST request to this URI.
/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember

2. If you’re using Postman, expand Event Platform > Custom Channels > Platform Event, and click Create channel member.
3. Specify the channel in the eventChannel field and the event in the selectedEntity field. This example references a
custom platform event, Carbon_Comparison__e. Use this example request body. In Postman, click Body, and replace the
body with this JSON body.
{
"FullName": "Carbon_Comparison_Channel_chn_Carbon_Comparison_e",
"Metadata": {
"eventChannel": "Carbon_Comparison_Channel__chn",
"selectedEntity": "Carbon_Comparison__e"
}
}

4. Send the request. The response received looks similar to this response.
{
"id": "0v8RM0000000G3iYAE",
"success": true,
"errors": [],
"warnings": [],
"infos": []
}

A channel (PlatformEventChannel) can have multiple channel members (PlatformEventChannelMember), which means that you can
add multiple platform events to a channel. This example adds only one platform event, Carbon_Comparison__e. To add another
event to the channel, create another PlatformEventChannelMember.

SEE ALSO:
Tooling API Developer Guide: PlatformEventChannelMember
Metadata API Developer Guide: PlatformEventChannelMember

1028
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Create a Channel for a Change Event

Create a channel that holds a stream of change data capture events.
USER PERMISSIONS
1. Send a POST request to this URI.
To create a
PlatformEventChannel:
• Customize Application

/services/data/v58.0/tooling/sobjects/PlatformEventChannel

2. If you’re using Postman, expand Event Platform > Custom Channels > Platform Event, and click Create channel.
3. To configure a channel that receives change event messages, set channelType to data. The channel label appears in the
event relays UI. Use this example request body. In Postman, click Body, and replace the body with this JSON body.
{
"FullName": "Account_Channel__chn",
"Metadata": {
"channelType": "data",
"label": "Account Channel"
}
}

4. Send the request. The response received looks similar to this response.
{
"id": "0YLRM00000001fR4AQ",
"success": true,
"errors": [],
"warnings": [],
"infos": []
}

Now that you created a channel for change events, add a channel member for one change event. See Add a Change Event in a New
Channel Member.

SEE ALSO:
Tooling API Developer Guide: PlatformEventChannel
Metadata API Developer Guide: PlatformEventChannel

Add a Change Event in a New Channel Member

To add a change event to the channel that you created, add a channel member.
USER PERMISSIONS
Prerequisites:
To create a
• Create a Channel for a Change Event PlatformEventChannel:
Change events are predefined by Salesforce so you don’t define them. To learn about Salesforce • Customize Application
objects that support change events, see Change Event Object Support in the Change Data Capture
Developer Guide.
1. Send a POST request to this URI.
/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember

1029
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

2. If you’re using Postman, expand Event Platform > Custom Channels > Platform Event, and click Create channel member.
3. Specify the channel in the eventChannel field and the event in the selectedEntity field. This example references a
change event, AccountChangeEvent. Use this example request body. In Postman, click Body, and replace the body with this
JSON body.
{
"FullName": "Account_Channel_chn_AccountChangeEvent",
"Metadata": {
"eventChannel": "Account_Channel__chn",
"selectedEntity": "AccountChangeEvent"
}
}

4. Send the request. The response received looks similar to this response.
{
"id": "0v8RM0000000GHCYA2",
"success": true,
"errors": [],
"warnings": [],
"infos": []
}

A channel (PlatformEventChannel) can have multiple channel members (PlatformEventChannelMember), which means that you can
add multiple change events to a channel. This example adds only one change event, AccountChangeEvent. To add another event
to the channel, create another PlatformEventChannelMember.

SEE ALSO:
Tooling API Developer Guide: PlatformEventChannelMember
Metadata API Developer Guide: PlatformEventChannelMember

Create an Event Relay in Setup

After creating the prerequisite items, follow the steps in this section to create an event relay using a point-and-click interface in Setup.
Event relays are available in Tooling API and Metadata API. As an alternative to creating an event relay in Setup, you can create it using
the API.

Create an Event Relay

An event relay associates the channel in the Salesforce event bus with Amazon EventBridge using a named credential. The creation
of the event relay results in a partner event source being created in Amazon EventBridge. The partner event source is created with
a pending status.
Activate the Partner Event Source in Amazon EventBridge
Salesforce creates a partner event source in Amazon EventBridge in pending status after you create an event relay. Associate the
event bus with the partner event source in EventBridge so that the event source is ready to receive events from Salesforce.

1030
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Start the Event Relay

Change the event relay state in the Edit window.

SEE ALSO:
Tooling API Developer Guide: EventRelayConfig
Metadata API Developer Guide: EventRelayConfig

Create an Event Relay

An event relay associates the channel in the Salesforce event bus with Amazon EventBridge using
USER PERMISSIONS
a named credential. The creation of the event relay results in a partner event source being created
in Amazon EventBridge. The partner event source is created with a pending status. To create an event relay:
1. From Setup, in the Quick Find box, enter Event Relays, and then select Event Relays. • Customize Application

2. In the Event Relays page, click New Event Relay. Use the event relay creation wizard and
provide the requested information in each step.

3. Enter a label for the event relay, for example, Carbon Comparison Relay. The label appears in the event relays list view and
the event relay detail page. Make sure you choose a meaningful name and try to make it unique. The name is auto populated based
on the label that you provide.

4. Select a named credential that contains your AWS account information from the dropdown. To create a named credential, see Create
a Named Credential.

1031
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

5. Select a channel that references the events that you want to send to EventBridge from the dropdown. To create a channel, see Create
a Channel and Channel Members.

6. Select an error recovery option. This option is used when the system can't resume from the last relayed event after it recovers from
an error. You can keep the default.

7. Review the summary screen, and save your changes to create the event relay.

After you create the event relay, the event relay detail page contains the Partner Event Source Name field. This field is
populated after a short delay with the name of the partner event source that’s created in Amazon EventBridge. Wait and then refresh
the detail page to get the partner event source. You use this field value in the next step to find the partner event source in Amazon
EventBridge.
The event relay is created in a stopped state, and no events are relayed to Amazon EventBridge. Before starting the event relay, activate
the partner event source in Amazon EventBridge. You perform these steps next.

1032
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Activate the Partner Event Source in Amazon EventBridge

Salesforce creates a partner event source in Amazon EventBridge in pending status after you create
USER PERMISSIONS
an event relay. Associate the event bus with the partner event source in EventBridge so that the
event source is ready to receive events from Salesforce. To create an event relay:
1. Get the partner event source name from the event relay. In the Event Relays page, click the • Customize Application
event relay. Copy the Partner Event Source Name field value.
There can be a small delay before this field value is displayed after you create the event relay.
Refresh the page until you get the partner event source name.

2. Log in to the AWS console. Navigate to https://aws.amazon.com and sign in using your AWS account credentials.
3. In the search box, enter Amazon EventBridge, and then from Services, select Amazon EventBridge.
4. In Amazon Eventbridge, under Integration, select Partner event sources.
5. In the search box, enter the name of your event source, the Partner Event Source Name field value that you copied
earlier.
6. Select your event source, and click Associate with event bus.
7. Click Associate. The status of the event source changes to Active.

Start the Event Relay

Change the event relay state in the Edit window.
USER PERMISSIONS
1. Start the event relay either from the event relays page or the event relay detail page.
To create an event relay:
a. In the Event Relays page, click the dropdown under the Actions column, and select Edit.
• Customize Application
b. In the Event relay detail page, click Edit.

1033
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

2. In the Edit window, in the State dropdown, select Run.

3. Save your changes.

Verify and Process Events in EventBridge

Verify receiving events in EventBridge and process them with AWS services.

Create an EventBridge Rule for Logging Events in a CloudWatch Log

To test the connection between Salesforce and AWS and ensure that the event messages are received in EventBridge, add a
CloudWatch log as a target of a rule. Incoming event messages from Salesforce are logged in CloudWatch.
Verify Receiving Events in CloudWatch
Verify that events sent from Salesforce are received in EventBridge using a CloudWatch log.
Processing Events with AWS Services
After receiving the events in EventBridge, you can process them with AWS using rules, or you can send them to third-party and SaaS
integrations using API destinations.

Create an EventBridge Rule for Logging Events in a CloudWatch Log

To test the connection between Salesforce and AWS and ensure that the event messages are received in EventBridge, add a CloudWatch
log as a target of a rule. Incoming event messages from Salesforce are logged in CloudWatch.
For more information, see Amazon EventBridge rules and Amazon EventBridge targets in the AWS documentation.
1. In Amazon Eventbridge, click Rules.

1034
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

2. Select your event bus from the dropdown. The name of the event bus is the same as the name of the partner event source that you
queried earlier. It’s in this format: aws.partner/salesforce.com/orgID/channelID
3. In the Rules section, click Create rule.
4. Provide a name for your rule.
5. Click Next.
6. Under Event source, select AWS events or EventBridge partner events.
7. Skip the Sample event section. In Event pattern, for Event source, select EventBridge partners.
a. From the partner dropdown, select Salesforce.
b. For Event type, select All Events. The event pattern box autopopulates to this value.
{
"source": [{
"prefix": "aws.partner/salesforce.com"
}]
}

8. The rule matches incoming events based on the defined pattern. If you want to add a filter to match a specific platform event, match
events whose detail-type field contains the API name of the platform event, for example, Carbon_Comparison__e.
For more information about event pattern matching, see Content filtering in Amazon EventBridge event patterns in the AWS
documentation.
a. Under Event pattern, click Custom patterns (JSON editor).
b. In the input box, In Define pattern, select Custom pattern, and replace the pattern with this pattern.
{
"source": [{
"prefix": "aws.partner/salesforce.com"
}],
"detail-type": ["Carbon_Comparison__e"]
}

9. Click Next.
10. Under Target 1, Target types, select AWS service.
11. Under Select a target, select CloudWatch log group.
12. Complete the log group path. For example: /aws/events/mygroup/log.
13. Click Next and then Next.
14. Review the rule that you created, and then click Create rule.
After creating the rule and the Cloudwatch log, verify receiving events in Verify Receiving Events in CloudWatch.

Verify Receiving Events in CloudWatch

Verify that events sent from Salesforce are received in EventBridge using a CloudWatch log.
1. Click the rule that you just created.
2. Under Targets, click the log. The CloudWatch log opens in a new tab.
3. Publish an event from Salesforce. In this example, we publish an event message with REST API.

1035
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

a. Perform a POST request to this URI. If using Postman, click REST > SObject > SObject Create, and replace the
:SOBJECT_API_NAME placeholder with Carbon_Comparison__e.

/services/data/v58.0/sobjects/Carbon_Comparison__e/

Use this request body.

{
"Annual_Mileage__c" : "12003",
"Current_Vehicle__c" : "Fast Car",
"Model_Year__c" : "2021"
}

To find out about methods for publishing an event, see Publishing Platform Events in the Platform Events Developer Guide. For
example, you can use REST API to publish this Carbon_Comparison__e event message.

4. You get a response similar to this response. The status of OPERATION_ENQUEUED means that the platform event message is
published asynchronously.
{
"id": "e00xx0000000001AAA",
"success": true,
"errors": [
{
"statusCode": "OPERATION_ENQUEUED",
"message": "e4aa03c9-d0e0-4c80-bf93-2e6779096018",
"fields": []
}
]
}

5. Refresh the CloudWatch log stream. The received event is displayed in the log group, similar to this event.
{
"version": "0",
"id": "6f33d717-8e35-4488-5690-89e681b5737c",
"detail-type": "Carbon_Comparison__e",
"source": "aws.partner/salesforce.com/00DRM000000LqxV2AS/0YLRM00000001es4AA",
"account": "XXXXXXXXXXXX",
"time": "2023-04-03T19:23:23Z",
"region": "us-west-2",
"resources": [],
"detail": {
"payload": {
"CreatedById": "005RM000002eap4YAA",
"Current_Vehicle__c": "Fast Car",
"CreatedDate": "2023-04-03T19:23:22.686Z",
"Model_Year__c": "2021",
"Annual_Mileage__c": 12003
},
"schemaId": "mVBhpA7tU9MCtBEbqjycBQ",
"id": "118dab75-7b45-498e-8478-52d0324c1060"
}
}

1036
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

The received event contains the payload of the Salesforce event in the detail field. The top-level fields, such as version and
detail-type, are EventBridge event fields. The detail-type field contains the Salesforce event API name. In combination
with the source field, the detail-type field identifies the fields and values that appear in the detail field. For more
information, see Amazon EventBridge events in the AWS documentation.

Processing Events with AWS Services

After receiving the events in EventBridge, you can process them with AWS using rules, or you can send them to third-party and SaaS
integrations using API destinations.
For example, you can use a Lambda function to make a computation, or you can use the Simple Notification Service (SNS) to send
messages to customers. For more information about AWS, see https://aws.amazon.com/ and the AWS documentation site. For more
information about API destinations, see API Destinations in the AWS documentation.

Event Relay Statuses and Options

Check out information about event relay statuses and the error recovery option.

Event Relay Execution Statuses

You can run, pause, or stop the execution of an event relay. After you change the execution state, it can take several minutes for the
new state to take effect. During this time, the event relay displays a transitional status in the UI. After the state change completes,
the final status appears.
Edit an Event Relay and Change Its Status
You can edit an event relay to change its status, label, and the error recovery option.
Error Recovery Options
If transient errors occur, such as connectivity issues or errors in the event relay configurations, event relay resumes automatically
after the connectivity issues are resolved or the configurations are fixed. The event relay attempts to resume sending events from
the event bus from where it left off. In rare occasions, if it can't resume after the last relayed event, it uses the error recovery option
to determine where to resume from.
Monitoring Event Relays Using SOQL Queries
You can perform a SOQL query on the EventRelayFeedback Salesforce object to get information about an event relay, including its
status, the date and time of the last relayed event, and any error message. The information contained in EventRelayFeedback is
available in Setup, in the Event Relays page.

Event Relay Execution Statuses

You can run, pause, or stop the execution of an event relay. After you change the execution state, it can take several minutes for the new
state to take effect. During this time, the event relay displays a transitional status in the UI. After the state change completes, the final
status appears.

Transitional Status and Final Status

Because a state change happens asynchronously, changing the event relay state isn't immediate and can take a short while. When the
state change is in progress, the event relays list view and the event relay detail page show a transitional status. The transitional status is
a visual indication that the state change is underway. Transitional statuses are available only in the UI and not in the API.
For example, when you change the state of a stopped relay to Run, the status first changes to Starting… before it changes to
Running. And when you change the state of a paused relay to Run, the status first changes to Resuming… before it changes to

1037
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Running. This image shows a transitional status of Starting for one event relay and a final status of Paused, Running, and
Stopped for the other event relays.

Note: Changing the state from the Error state doesn't cause a transitional status to appear.

These are the possible transitional states.

• Starting...
• Resuming...
• Pausing...
• Stopping...
The final statuses are listed in the next section.

Running Status
To start a stopped or paused event relay, set the event relay state to Run.

Paused Status
To pause the event relay and temporarily hold off sending events to Amazon EventBridge, set the event relay state to Pause. When
you resume a paused event relay, the relay of events continues from where it left off. Stored events are relayed from the Salesforce event
bus starting after the last relayed event, and new events.
When the event relay is paused, its current state information is saved in the EventRelayFeedback Salesforce object. There can be a delay
between when you set the state to Pause and when the event relay is paused. In this case, the saved state information corresponds to
the state when the event relay was actually paused.

Stopped Status
To stop relaying events from Salesforce to Amazon EventBridge, change the event relay state to Stop. When you start a stopped event
relay, new events published to the Salesforce event bus are delivered to Amazon EventBridge. Any events stored in the Salesforce event
bus that were received after the relay was stopped and before it was started aren’t sent.
When you stop an event relay, its current state information in EventRelayFeedback is deleted.

1038
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Error Status
The system sets the event relay status to Error if it encounters an error when attempting to run the event relay. Errors can be caused
by configuration problems or connectivity issues to Amazon EventBridge. You can view the error in Setup or by querying
EventRelayFeedback.
The system attempts to recover from the error periodically. When the system recovers from the error, the event relay resumes from
where it left off and the status changes to Running or a status you select. In rare occasions, if the system can't resume from where it
left off, it uses the error recovery option to determine from where to relay events. For more information, see Error Recovery Options.

Edit an Event Relay and Change Its Status

You can edit an event relay to change its status, label, and the error recovery option.
USER PERMISSIONS
1. Open the Edit window for the event relay either from the event relays page or the event relay
detail page. To edit an event relay:
• Customize Application
a. In the Event Relays page, click the dropdown under the Actions column, and select Edit.
b. In the Event relay detail page, click Edit.

2. In the Edit window, change the label, status, or the error recovery option.

Error Recovery Options

If transient errors occur, such as connectivity issues or errors in the event relay configurations, event relay resumes automatically after
the connectivity issues are resolved or the configurations are fixed. The event relay attempts to resume sending events from the event
bus from where it left off. In rare occasions, if it can't resume after the last relayed event, it uses the error recovery option to determine
where to resume from.
Specify the error recovery option when you create or edit the event relay in Setup. Choose one of these options.
• Resume from the latest events received. This option skips sending events that were published during the error. This option is the
default.
• Resume 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.
Also, you can specify the error recovery option in Tooling API or Metadata API via the relayOption field in EventRelayConfig. When
you create an event relay, add the relayOption field with the desired value in the EventRelayConfig POST request. Or you can
update an event relay by performing a PATCH request for EventRelayConfig and supplying a value for relayOption. For more
information about this field, see EventRelayConfig in the Tooling API Developer Guide and EventRelayConfig in the Metadata API Developer
Guide.

Monitoring Event Relays Using SOQL Queries

You can perform a SOQL query on the EventRelayFeedback Salesforce object to get information about an event relay, including its status,
the date and time of the last relayed event, and any error message. The information contained in EventRelayFeedback is available in
Setup, in the Event Relays page.
To run the queries given in this section, you can use one of these methods.
• The Developer Console’s Query Editor. For more information about the Developer Console, see Developer Console and Developer
Console Query Editor.
• The query REST API resource using a REST API tool, such as Postman. See Query in the REST API Developer Guide. For information on
how to set up Postman and use the Salesforce API Collection, see Salesforce APIs for Postman in GitHub. In REST API, spaces in the
query must be replaced with +. In Postman, you don’t replace spaces in queries because Postman handles them.

1039
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

You can perform a REST call, a GET request, to this endpoint with the SOQL query appended. Because EventRelayFeedback is a Salesforce
object, use the data REST API to query the object and not Tooling API. In Postman, navigate to REST > Query.
/services/data/v58.0/query/?q=<query>

To get all the fields of EventRelayFeedback, run this query.

SELECT FIELDS(ALL) FROM EventRelayFeedback LIMIT 200

Example of a REST query call.

/services/data/v58.0/query/?q=SELECT+FIELDS(ALL)+from+EventRelayFeedback+LIMIT+200

If you aren’t interested in the system fields returned, use this query, which specifies non-system fields in the SELECT clause.
SELECT EventRelayNumber, EventRelayConfigId, LastRelayedEventTime, RemoteResource, Status,

ErrorCode, ErrorMessage, ErrorTime, ErrorIdentifier FROM EventRelayFeedback

Example query response received using the REST query resource.

{
"totalSize": 1,
"done": true,
"records": [
{
"attributes": {
"type": "EventRelayFeedback",
"url": "/services/data/v58.0/sobjects/EventRelayFeedback/7k4RM0000004LjjYAE"

},
"EventRelayNumber": "00000004",
"EventRelayConfigId": "7k2RM0000004LoAYAU",
"LastRelayedEventTime": "2023-04-03T19:23:23.000+0000",
"RemoteResource":
"aws.partner/salesforce.com/00DRM000000G2tq2AC/0YLRM00000001es4AA",
"Status": "RUNNING",
"ErrorCode": null,
"ErrorMessage": null,
"ErrorTime": null,
"ErrorIdentifier": null
}
]
}

The fields returned in the query correspond to fields in the UI. For example, RemoteResource corresponds to the Partner
Event Source Name field, and LastRelayedEventTime corresponds to the Last Relayed field in the event relay
detail page. For more information, see Event Relays in Setup.
For a description of EventRelayFeedback non-system fields, see EventRelayFeedback in the Object Reference for the Salesforce Platform.

Send Events from AWS Back to Salesforce Using an API Destination

An API destination is the target of a rule, and it enables you to route events to HTTP endpoints. Specifically, you can use an API destination
to publish an event to Salesforce from EventBridge using REST API.

1040
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Create a Connected App in Salesforce for OAuth

To use OAuth to authorize the API call to Salesforce, set up a connected app in Salesforce. The connected app generates a consumer
key and secret that you can store in the EventBridge connection in AWS.
Create an API Destination and Connection in EventBridge
Create an API destination that uses a new connection. In this case, the API destination is a REST API call to Salesforce to publish a
platform event back. The connection contains the authentication information for the API call. The connection accepts several
authorization methods.
Create an EventBridge Rule and Connect it to the API Destination
The EventBridge rule routes events from the event bus to the API destination, which results in making a REST call to publish an event
back to Salesforce.

Create a Connected App in Salesforce for OAuth

To use OAuth to authorize the API call to Salesforce, set up a connected app in Salesforce. The connected app generates a consumer
key and secret that you can store in the EventBridge connection in AWS.
To create a connected app in Salesforce:
1. From Setup, in the Quick Find box, enter Apps, and then select App Manager.
2. Click New Connected App.
3. Enter a name.
4. Enter your contact email.
5. Optionally, fill out other fields as outlined in Configure Basic Connected App Settings.
6. In the API (Enable OAuth Settings) section, select Enable OAuth Settings.
7. Select Enable for Device Flow.
A callback URL isn’t used in the device flow. However, when this flow is enabled, the value for the callback URL defaults to a placeholder.

8. For OAuth scopes, select Manage user data via APIs.

9. Keep Require Secret for the Web Server Flow selected. This option requires the app’s client secret in exchange for an access
token.
10. Keep Require Secret for Refresh Token Flow selected. This option requires the app’s client secret in the authorization request of
a refresh token and the hybrid refresh token flow.
11. Select Enable Client Credentials Flow.
12. When you understand the security risks, accept the warning.
13. Save your changes.
14. Click Continue.
15. Click Manage Consumer Details.
A new window opens and a verification code is sent to your registered email address.

16. After you verify your identity, note the consumer key and consumer secret.
17. Select an execution user for the client credentials flow.
Although there’s no user interaction in the client credentials flow, Salesforce still requires you to specify an execution user. By selecting
an execution user, you allow Salesforce to return access tokens on behalf of this user.

1041
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

Note: Permitted Users policies, such as All users may self-authorize and Admin approved users are pre-authorized,
don’t apply to the execution user.
a. From Setup, in the Quick Find box, enter Apps, and then select Manage Connected Apps.
b. Click the connected app you just created.
c. Click Edit Policies.
d.
Under Client Credentials Flow, for Run As, click , and find the user who you want to assign the client credentials flow.
For Enterprise Edition orgs, we recommend that you select an execution user who has the API Only User permission.

e. Save your changes.

After you create the connected app, it can take up to 10 minutes for the connected app to be ready for use.

SEE ALSO:
Configure a Connected App for the OAuth 2.0 Client Credentials Flow
Connected Apps

Create an API Destination and Connection in EventBridge

Create an API destination that uses a new connection. In this case, the API destination is a REST API call to Salesforce to publish a platform
event back. The connection contains the authentication information for the API call. The connection accepts several authorization
methods.
Prerequisites:
To use OAuth authorization for the API destination connection, create a connected app in Salesforce by following the steps in Create a
Connected App in Salesforce for OAuth. You use the consumer key and secret from the connected app for the API destination connection.
1. To create an API destination in the EventBridge console, follow the steps in Create an API destination in the AWS documentation.
Then set up the configurations that are specific to Salesforce.
2. Get your Salesforce org’s My Domain name, which is on the My Domain page in Setup. You use the name in the endpoint in the
next step.
3. For the event that you want to send to Salesforce, use an existing custom platform event or define a new one. For example, you can
create a platform event with the label Carbon Estimate (API name Carbon_Estimate__e). To learn how to add fields to a
platform event, see (Optional) Define a Platform Event. Add the same fields as the ones in the Carbon Comparison event. Also, add
this field.
Field type: Number (3,0), Label: Carbon Reduction Percentage

4. For API destination endpoint, use this URL after replacing MyDomainName with your org’s domain name and MyEvent__e
with the API name of the platform event to return:
https://MyDomainName.my.salesforce.com/services/data/v58.0/sobjects/MyEvent__e
For example, for the Carbon Estimate event, the URL is:
https://MyDomainName.my.salesforce.com/services/data/v58.0/sobjects/Carbon_Estimate__e

5. For HTTP method, select POST.

6. For the connection, select Create a new connection, and enter a connection name.
7. For Destination type, select Partners, and then select Salesforce from Partner Destinations.
If you’re setting up OAuth authorization, provide this information for your Salesforce org.

1042
Extend Salesforce with Clicks, Not Code Connect Business Processes with Real-Time Events

8. For Authorization type, make sure that OAuth Client Credentials is selected.
9. For Authorization endpoint, replace the populated endpoint with one of these options.
a. If using a production org, enter this URL, and replace MyDomainName with your org’s My Domain name:
https://MyDomainName.my.salesforce.com/services/oauth2/token
b. If using a sandbox without enhanced domains, enter this URL, and replace MyDomainName with your org’s My Domain name
and SandboxName with your sandbox name:
https://MyDomainName--SandboxName.my.salesforce.com/services/oauth2/token
c. If using a sandbox with enhanced domains, enter this URL, and replace MyDomainName with your org’s My Domain name
and SandboxName with your sandbox name:
https://MyDomainName--SandboxName.sandbox.my.salesforce.com/services/oauth2/token

10. For HTTP method, select POST.

11. For Client ID, enter the consumer key from the connected app in Salesforce.
12. For Client secret, enter the consumer secret from the connected app in Salesforce.
13. Add OAuth HTTP parameters.
a. Parameter: Body field, Key: grant_type, Value: client_credentials

Note: If your Salesforce org uses multi-factor authentication (MFA) for API access, users must complete a second authentication
challenge to access Salesforce APIs. For more information, see Set Multi-Factor Authentication Login Requirements for API Access.
After you create the API destination, you can create a rule whose target is the destination. See Create an EventBridge Rule and Connect
it to the API Destination.

SEE ALSO:
AWS Documentation: API Destinations
AWS Compute Blog: Using API destinations with Amazon EventBridge
Platform Events Developer Guide: Publish Event Messages with Salesforce APIs

Create an EventBridge Rule and Connect it to the API Destination

The EventBridge rule routes events from the event bus to the API destination, which results in making a REST call to publish an event
back to Salesforce.
Prerequisites:
Create an API destination in Create an API Destination and Connection in EventBridge.
For more information about EventBridge rules, see Creating Amazon EventBridge rules that react to events in the AWS documentation.
1. In Amazon Eventbridge, click Rules.
2. Select an event bus from the dropdown that is the source of the events that you want to send to Salesforce.
3. In the Rules section, click Create rule.
4. Provide a name for your rule.
5. Click Next.

1043
Extend Salesforce with Clicks, Not Code Sync Data Between Salesforce and Heroku

6. Under Event pattern, select Custom patterns (JSON editor), and enter a filter. If you don’t want to be specific with the filter, use a
filter that matches anything except events whose source field is "dontSend".
{
"source": [{
"anything-but": ["dontSend"]
}]
}

For more information about event pattern matching, see Content filtering in Amazon EventBridge event patterns in the AWS
documentation.

7. Click Next.
8. In Select targets, under Target 1, select EventBridge API destination.
9. From the dropdown, select the API destination that you just created.
10. Expand Additional settings.
11. Select Part of the matched event, and provide the part of the event message to pass to the API destination. This step prevents
the top-level Amazon event fields from being sent to Salesforce. Only the part containing the Salesforce event fields from the detail
section of the original event are sent.
a. If the event format is an EventBridge event, provide this value: $.detail
b. If the event originates from a Lambda function, provide a path in the Lambda function result message. For example, to return a
section from the function response, use $.detail.responsePayload.{responseSection}.

12. Click Next and then Next.

13. Review the rule, and then click Create rule.

Tip: Troubleshooting Tip: To troubleshoot the execution of the API destination, you can add a dead letter queue to the target.
The dead letter queue is an Amazon SQS queue that receives the messages that couldn’t be delivered along with the errors. From
the Amazon SQS console, you can poll messages in the queue to view the messages and errors. For more information, see Event
retry policy and using dead-letter queues and Receiving and deleting messages (console) in the AWS documentation.

Sync Data Between Salesforce and Heroku

Heroku Connect lets you sync data between Salesforce and Heroku Postgres.
EDITIONS
Using Heroku Connect with Heroku Postgres, you can build Heroku apps that interact with your
Salesforce data using your favorite language, like Ruby, Node.js, Python, PHP, Java, Scala or Clojure Available in: Salesforce
or web framework like Rails, Django, or Play. For more information, refer to the Heroku Connect Classic
website and the Heroku Connect documentation on the Heroku Dev Center website.
Available for: Developer,
Enterprise, Performance,
and Unlimited Editions
Organization Sync
This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced
Salesforce org. Users could access a subset of Salesforce data in that org when the primary org was unavailable.

Managing Organization Sync

This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced Salesforce org. Users could
access a subset of Salesforce data in that org when the primary org was unavailable.

1044
Extend Salesforce with Clicks, Not Code Build Your Own Web Site

Actions in the Organization Sync Record Queue

This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced Salesforce org. Users could
access a subset of Salesforce data in that org when the primary org was unavailable.

Managing Organization Sync

This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced Salesforce org. Users could access
a subset of Salesforce data in that org when the primary org was unavailable.

Actions in the Organization Sync Record Queue

This feature is now retired. In previous releases, Organization Sync let you set up a secondary, synced Salesforce org. Users could access
a subset of Salesforce data in that org when the primary org was unavailable.

Build Your Own Web Site

Site.com and Salesforce Sites are legacy systems to create sites using Salesforce.
Use Experience Cloud to create scalable sites using the latest Salesforce web technologies.

Site.com
Site.com is a web content management system (CMS) that makes it easy to build dynamic, data-driven web pages quickly, edit
content in real time, and manage your websites.
Salesforce Sites
Salesforce Sites enables you to create public websites and applications that are directly integrated with your Salesforce
organization—without requiring users to log in with a username and password. You can publicly expose any information stored in
your organization through a branded URL of your choice. And you can make the site's pages match the look and feel of your company’s
brand.

Site.com
Site.com is a web content management system (CMS) that makes it easy to build dynamic,
EDITIONS
data-driven web pages quickly, edit content in real time, and manage your websites.

Note: If you’re a new customer who’d like to create a site, portal, or community, Communities Available in: Salesforce
are a great way to share information and collaborate with people outside your company, Classic (not available in all
orgs)
such as customers, partners, or employees. See Experience Cloud to learn more.
From the Site.com tab in the Site.com app, you can launch Site.com Studio, which provides a Available for purchase in:
separate, dedicated environment for creating and editing pixel-perfect, custom websites. Site Enterprise, Performance,
administrators and designers can create and style web pages, and add features such as navigation and Unlimited Editions
menus, images, and text areas using drag-and-drop page elements, while ensuring the site's pages Available (with limitations)
match the look and feel of the company's brand. And content contributors, such as marketing users, in: Developer Edition
can browse and update website content directly in a simplified Site.com Studio environment.
Additionally, websites built with Site.com benefit from running on Salesforce’s trusted global
infrastructure.

Note: The features available in Site.com Studio vary depending on whether you're a site administrator, designer, or contributor.

1045
Extend Salesforce with Clicks, Not Code Site.com

The following examples illustrate a few ways to use Site.com:

• Create an event site—Advertise upcoming events, such as grand openings, launches, or sales kick-offs on a public event site.
• Promote new products—Launch new products into the market with a promotional website that helps drive sales.
• Publish a support FAQ—Provide helpful information on a public website where customers can view solutions to their issues.
• Create microsites and landing pages—Create temporary landing pages or targeted microsites for marketing campaigns.
• Create a recruiting website—Post job openings to a public site and allow visitors to submit applications and resumes.
• Publish a catalog of products—List all of your company's products on a public website, with model numbers and current prices
pulled dynamically from your organization.
• Post company press releases—Publish your company’s press releases and sort by publication date.

System Requirements
To use Site.com Studio, we recommend:
• Mozilla® Firefox® or Google® Chrome for best performance.

Note: Microsoft® Edge is supported, but it is strongly recommended that you do not use Internet Explorer®.

• Disabling the Firebug extension for Firefox, if installed, as it can impact performance.
• A minimum browser resolution of 1024x768.

About Site.com Feature Licenses

Planning and Implementing a Site.com Website
Create a Site.com Community
Creating a Site.com Site
Importing and Managing Assets
Editing Site.com Pages as a Designer or Site Administrator
Site.com Page Elements
Setting Up the Contributor’s Studio View
Control what your contributors can do in Site.com Studio.
Cascading Style Sheets Overview
Site Branding Overview
Branding provides a flexible way for you to define different aspects of your website’s brand. Once branding properties are defined,
your editors can easily customize everything in one centralized place, the Branding Editor. When your website editors customize
the properties, they get a preview of their branding changes immediately.
Custom Site Properties Overview
With custom site properties, you can define and store frequently occurring content on your site. For example, you can store your
address and phone number as a custom property so that it can be reused by anyone who is editing your site. You can apply stored
properties to pages, headers and footers, and widgets quickly by using expression language syntax.
Site.com Data Services Overview
Site.com data services combine many features that let you connect to standard and custom Salesforce objects. Retrieve data from
your organization’s objects and dynamically display it on your site pages, or alternatively, gather and submit data from your customers.
And when you update data in your Salesforce object, the changes are reflected automatically on the live site—no site updates
required!

1046
Extend Salesforce with Clicks, Not Code Site.com

Widgets Overview
Widgets let you save time by building custom page elements that you and your team can reuse throughout the site.
Multilingual Sites Overview
Site.com Studio lets you to create different language versions of your site. And because all languages are maintained within the site,
you don’t need to create and manage a separate site for each language.
Content Lists and Categories Overview
Events Overview
Understanding the Contributor’s Page Editing View
Previewing How Pages Appear on Mobile Devices
With live mode, site administrators, designers, and contributors can preview how pages and templates appear on devices such as
cell phones and tablets.
Previewing Site.com Sites
Site.comIP Restrictions Overview
Managing Domains in Site.com
Before you can publish your site to the Internet, you must set the site's domain information.

SEE ALSO:
Setting Up Site.com Users
Planning and Implementing a Site.com Website
Using Site.com Studio as a Site Administrator or Designer
Using Site.com Studio as a Contributor

About Site.com Feature Licenses

To access Site.com, each user in your organization must have a Site.com feature license.
EDITIONS
• The Site.com Publisher feature license allows the user to access Site.com Studio to create and
style websites, control the layout and functionality of pages and page elements, and add and Available in: Salesforce
edit content. Classic (not available in all
orgs)
• The Site.com Contributor feature license allows the user to access Site.com Studio to edit site
content only. Available for purchase in:
Consider what your users need to do in a site and purchase feature licenses accordingly. See the Enterprise, Performance,
Site.com feature table for a complete list of the capabilities that come with each feature license. and Unlimited Editions
After you purchase feature licenses, you can set up Site.com users. Available (with limitations)
in: Developer Edition
You can view the number of assigned feature licenses on your organization's profile.

Note: Organizations using Performance, Unlimited, or Enterprise Editions must purchase

Site.com Publisher and Site.com Contributor feature licenses separately. Additionally, a Site.com
Published Site license is required for each site that’s published to the Internet. For information
on purchasing Site.com licenses, contact Salesforce.
Developer Edition organizations contain two Site.com Publisher feature licenses and one
Site.com Contributor feature license. Developer Edition organizations can’t publish sites.
Communities users with the “Create and Set Up Communities” permission are assigned the
role of site administrator in a community’s Site.com site. To let users who don’t have this

1047
Extend Salesforce with Clicks, Not Code Site.com

permission edit the site, you must purchase and assign a Site.com Publisher or a Site.com Contributor feature license. Then you
must assign a user role at the site level.

Setting Up Site.com Users

About Site.com User Roles
Managing Site.com Users and Roles
About Site.com Features

SEE ALSO:
About Site.com User Roles
Managing Site.com Users and Roles

Setting Up Site.com Users

Before users can access Site.com, you must allocate a Site.com feature license to each user and
EDITIONS
assign a user role at the site level. The features available when editing a site in Site.com Studio vary
depending on these settings. Available in: Salesforce
First, review the Site.com feature table for detailed information on the feature license, permissions, Classic (not available in all
and role required for each user. orgs)

After you’ve determined the appropriate access level required: Available for purchase in:
1. Allocate a feature license to the user by editing the user’s profile. To allocate: Enterprise, Performance,
and Unlimited Editions
• A Site.com Publisher feature license, select the Site.com Publisher User
Available (with limitations)
checkbox.
in: Developer Edition
• A Site.com Contributor feature license, select the Site.com Contributor User
checkbox.
After you allocate a feature license, users can access Site.com in the Lightning Platform app USER PERMISSIONS
menu in the Salesforce header.
To create or edit users:
Note: If the checkboxes don't appear, verify that Site.com is enabled for your organization. • Manage Internal Users
See About Site.com Feature Licenses on page 1047.

2. Ensure the “View Setup and Configuration” permission is enabled. All users who create or edit websites in Site.com Studio need this
permission.
3. Additionally, ensure that at least one user in your organization has both a Site.com feature license and the “Manage Users” permission.
This way, someone can always reallocate user roles if a site’s users are accidentally deleted.

Warning: The “Manage Users” permission is powerful. It allows a user to manage all other users in your organization and not
just Site.com.

4. Add users and assign user roles within a site. (When a user with the Site.com Publisher feature license creates a site, the user is
automatically allocated the role of site administrator at the site level.)
The feature license, permissions, and user role all determine what a user can do in each site. For example, to create an administrative
user who can manage all sites in your organization, assign a Publisher feature license and assign the role of site administrator at the site
level.

1048
Extend Salesforce with Clicks, Not Code Site.com

For users who need only limited access to edit site content, but no administrative access, assign a Contributor feature license and a
contributor role at the site level.
Alternatively, to create a user who can manage roles in a site, but without the ability to publish, assign a Publisher feature license, the
“Manage Users” permission, and the designer role at the site level.

Note: Any records created by unauthenticated guest users via a Site.com Site has the Site Guest User as the record's owner. Each
site has one Site Guest User.

SEE ALSO:
About Site.com User Roles

About Site.com User Roles

Each Site.com user must have a user role assigned at the site level, which controls what each user
EDITIONS
can do in a site. Users can have only one role per site, but their roles can vary between sites. For
example, a person can be a site administrator on one site and a contributor on another. Available in: Salesforce
To manage user roles in a site, you must either be the site administrator for that site, or have a Classic (not available in all
Site.com feature license and the “Manage Users” permission. orgs)

Note: Users with the “Create and Set Up Experiences” permission are assigned the role of Available for purchase in:
site administrator in a community’s Site.com site. However, they don’t appear in the User Enterprise, Performance,
Roles section on the Overview tab of Site.com Studio. and Unlimited Editions

Users can have one of three roles at the site level: Available (with limitations)
in: Developer Edition
• Site administrator—Site administrators are users who can create and manage all site content.
They can create sites, templates, style sheets, and pages, and also set up domains, publish sites,
and assign user roles. This role requires the Site.com Publisher feature license.
• Designer—Designers have the same control over site content as site administrators, but they can’t manage domains or publish sites.
By default, they can’t assign roles unless they have the “Manage Users” permission. This role requires the Site.com Publisher feature
license.
• Contributor—Contributors have the most restricted access to content and can typically just edit page text and images. By default,
they can’t assign roles unless they have the “Manage Users” permission. This role requires the Site.com Contributor feature license.
See the Site.com feature table on page 1051 for a detailed list each user role’s capabilities.

SEE ALSO:
Managing Site.com Users and Roles
Setting Up Site.com Users
Setting Up the Contributor’s Studio View
About Site.com Feature Licenses

1049
Extend Salesforce with Clicks, Not Code Site.com

Managing Site.com Users and Roles

After you create a site, you can add other users and assign roles to them. If you haven’t assigned
EDITIONS
Site.com feature licenses to your users, you won’t be able to add them to a site.

Note: Communities users with the “Create and Set Up Communities” permission are assigned Available in: Salesforce
the role of site administrator in a community’s Site.com site. However, they don’t appear in Classic (not available in all
orgs)
the User Roles section on the Overview tab of Site.com Studio.
When assigning a user role, be sure to add one that’s compatible with the user’s Site.com license. Available for purchase in:
When users log into Site.com, their licenses are checked against the role assigned to them at the Enterprise, Performance,
site level. If the license doesn’t allow the permissions associated with the role, then the user is given and Unlimited Editions
the permissions associated with the license. For example, if a user has a Site.com Contributor feature Available (with limitations)
license, but is assigned a role of site administrator, they will only have Contributor permissions in: Developer Edition
regardless of the assigned role.
To add users and assign roles:
USER PERMISSIONS
1. On the Overview tab in Site.com Studio, click Site Configuration > User Roles.
To manage Site.com users:
2. Click Add Users.
• Site.com
3. In the Available Users section, highlight the user you want to add. Publisher User
field enabled on the user
4. Select the role from the Add as drop-down list.
detail page
5. Click the arrow to move the user to the Selected Users section. AND
6. Click Save. Site administrator role
To delete users: assigned at the site level

1. In the User Roles view, select the user.

2. Click > Remove.
3. Click OK.
To change a user’s role:
1. In the User Roles view, hover over the user’s role.
2. Click the arrow to display all the roles.
3. Select the new role.
To delete or change the role of a group of users at the same time, use Bulk Actions.
1. In the User Roles view, select the check box beside each user’s name.
2. Click Bulk Actions.
3. Select the action.
4. Click Apply.

1050
Extend Salesforce with Clicks, Not Code Site.com

Note: When updating the roles of several users at once, you can only assign the same role to all selected users.

SEE ALSO:
Setting Up Site.com Users
Setting Up the Contributor’s Studio View
Planning and Implementing a Site.com Website
About Site.com Features

About Site.com Features

The features available when editing a site in Site.com Studio vary depending on your Site.com
EDITIONS
feature license and also your user role for that particular site.
This table lists the required feature licenses, permissions, and roles for many of the Site.com Studio Available in: Salesforce
features. Classic (not available in all
orgs)
Note:
Available for purchase in:
• Communities users with the “Create and Set Up Communities” permission are assigned
Enterprise, Performance,
the role of site administrator in a community’s Site.com site. and Unlimited Editions
• You can’t create, delete, or duplicate community sites in Site.com.
Available (with limitations)
in: Developer Edition
Site.com Studio Feature Requirements
Feature Feature Site.com Studio User Permissions
License Role
Assign feature license to user “Manage Internal
profile Users”

Add users and roles at the site Publisher Site administrator Additionally, any
level user with a
Site.com feature
license and the
“Manage Users”
permission.

Enable contributors to create Publisher Site administrator or

pages, add content blocks and designer
widgets, and edit content blocks
and graphics

Create websites Publisher Users who create a site are

automatically added to that
site as a site administrator.

Delete websites Publisher Site administrator or

designer

Import websites Publisher Users who import a site are

automatically added to the

1051
Extend Salesforce with Clicks, Not Code Site.com

Site.com Studio Feature Requirements

Feature Feature License Site.com Studio User Role Permissions
new site as a site administrator.

Export websites Publisher Site administrator or designer

Duplicate websites Publisher Site administrator or designer

Manage domains Publisher Site administrator

(Unavailable for Developer Edition)

Add and edit IP restrictions Publisher Site administrator

Publish changes to the live website Publisher Site administrator

(Unavailable for Developer Edition)

Create page templates Publisher Site administrator or designer

Create website pages Publisher or Site administrator or designer

Contributor Contributor only if enabled by the site
administrator or designer in the page
template’s Properties pane.

Create and modify style sheets Publisher Site administrator or designer

Modify layout and design Publisher Site administrator or designer

Add page elements Publisher or Site administrator or designer

Contributor Contributor can add content blocks and
widgets only if enabled by the site
administrator or designer.

Add data repeaters and other data-bound page Publisher Site administrator or designer
elements

Modify the Guest User profile to set public Publisher Site administrator or designer “Manage Profiles and
access permissions to Salesforce objects Permission Sets” and
“Customize Application”

Import assets, such as images and files Publisher or Any assigned role
Contributor

Edit content and images Publisher or Site administrator or designer

Contributor Contributor only if enabled by the site
administrator or designer in the page
template’s Properties pane.

Preview website pages Publisher or Any assigned role

Contributor

1052
Extend Salesforce with Clicks, Not Code Site.com

Planning and Implementing a Site.com Website

There are many approaches to building a website. The process that best suits you depends on many
EDITIONS
factors, such as the size of your team and the tasks you're responsible for.
If you're a site administrator or designer, you may be involved in every stage, including adding and Available in: Salesforce
maintaining the site's content. Alternatively, you may have contributors who add, edit, and maintain Classic (not available in all
this content. And if you're a contributor, you may be responsible for editing and updating all of the orgs)
site's content, or you may work with other contributors, designers, and site administrators to bring
Available for purchase in:
the site to completion. Enterprise, Performance,
This topic describes the various stages involved in creating a site with Site.com. and Unlimited Editions
• Plan the Site Design and Page Layout (Site administrator or designer)—Before building the Available (with limitations)
pages of the site, spend time planning the site design and basic layout. This stage is key to in: Developer Edition
ensuring a consistent look and feel with the minimum amount of effort. From a hierarchical
point of view, think about how many pages you need and whether they'll have subpages. Also
consider how you want site visitors to navigate around your site. USER PERMISSIONS
Next, plan the layout of the pages and identify the common elements that every page will have. To create or import Site.com
In this example, the site has a header section that includes the company's logo and menu (1), sites:
and a footer section (2). However, the main section of the home page (3) differs from the rest • Site.com
of the site pages (4). Take note of these similarities and differences, because they will affect Publisher User
how you create your site pages. field enabled on the user
detail page
To build, edit, and manage
Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

To edit only content in

Site.com sites:
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1053
Extend Salesforce with Clicks, Not Code Site.com

• Create the Site (Site administrator or designer)—Once you've completed the planning stage, you're ready to get started! Log into
the Site.com app and go to the Site.com tab, where you can create your first site. Your new blank site opens in Site.com Studio, a
powerful environment for building the pages of your site.

Note: Only users with the Site.com Publisher User field enabled on their user detail page can create and import
sites.

• Import Assets (Site administrator or designer)—If you're working with a design agency, they may provide all of the files and assets
you need, including a CSS style sheet. If you've created your own design, cut up the design and collect the assets, images, and files
you plan to use in the site. Import the assets into Site.com Studio, where they appear in the Assets section of the Overview tab.
• Create a Page Template (Site administrator or designer)—Once you've decided on the layout, the quickest and most effective
method is to use page templates to build the basic layout and then base your site pages on it. Try to keep the design of your main
page template simple to make it easier to modify in the future. For more complicated site designs, such as the example graphic, you
can use the main page template as the basis for a child template to achieve maximum flexibility. When you create your page template,
you can choose from predesigned layouts that include headers, footers, and columns, or you can create a blank page template.
• Lay Out the Page (Site administrator or designer)—After you create the page template, you can modify the layout further to match
the design of your site.
• Create the Site Pages (Site administrator or designer)—Using the template as a base, you can quickly create the site pages, which
automatically inherit all the elements of the page template. Or if you need a standalone page that doesn't follow the site's overall
design, you can create a blank page instead.
• Add Features and Page Elements (Site administrator or designer)—Use Site.com's prebuilt page elements to add features such
as navigation menus, images, and data services, and include content blocks that contributors can edit. And add interactive, animated
effects using events and actions.
• Make Your Website Look Good (Site administrator or designer)—Take advantage of cascading style sheets (CSS) to develop the
look and feel of your website. If you're not completely up to speed with CSS, the Style pane provides an easy, visual way to create
and manage styles. Or if you're a CSS expert who likes to get straight into the code, you can hand-code the site's style sheets.
• Add and Edit Content (Contributor)—At this stage, if you're a contributor, the site is usually ready for you to add and edit content
such as text, images, videos, and hyperlinks. And as you work, you can upload any images or files you need.
• Review and Test the Site (Contributor, designer, or site administrator)—Testing the changes to the pages of your site happens
throughout the development cycle. As a contributor, designer, or site administrator, you should always preview your changes to
ensure they display as expected in a browser. And if you're a site administrator or designer, you can send a preview link to the site's
reviewers so they can review the finished product before it goes live.
• Publish the Site (Site administrator only)—After testing is complete, you're ready to go live with your new site. Just set the site's
domain information and then publish your changes to make your site live!

Site.com Tab Overview

1054
Extend Salesforce with Clicks, Not Code Site.com

Using Site.com Studio as a Site Administrator or Designer

Using Site.com Studio as a Contributor
Understanding the Site Administrator and Designer's Overview Tab
Understanding the Contributors's Overview Tab

SEE ALSO:
Using Site.com Studio as a Site Administrator or Designer
Using Site.com Studio as a Contributor
Setting Up the Contributor’s Studio View

1055
Extend Salesforce with Clicks, Not Code Site.com

Site.com Tab Overview

If you can't see the Site.com tab, go to the Site.com app. It's available in the Lightning Platform app
EDITIONS
menu in the Salesforce header. Then click the Site.com tab to view the list of your Site.com sites.
From this page you can: Available in: Salesforce
• Click New to create or import a site. Only users with the Site.com Publisher User Classic (not available in all
field enabled on their user detail page can create and import sites. orgs)
• Filter the sites you see by selecting a predefined list from the drop-down list. My Sites shows Available for purchase in:
the sites you can access and your role. All Sites shows all the sites in your organization even if Enterprise, Performance,
you don’t have access to some of them. and Unlimited Editions
• Click Edit next to a site to open it in Site.com Studio. Available (with limitations)
• Click Preview next to a site to see how it looks when rendered in a browser window. in: Developer Edition
• Click next to a site to duplicate, export, or delete it. Only users with the Site.com
Publisher User field enabled on their user detail page and the role of site administrator
USER PERMISSIONS
or designer can duplicate, export, and delete sites. If a site has been published, you can't delete
it until you take it offline. To create or import Site.com
• See the status of your site. sites:
• Site.com
– In Development—The site has never been published. Publisher User
– Published—The site has been published at least once. field enabled on the user
detail page
• Click the title of any column to sort your site list. By default, sites are sorted by name.
To build, edit, and manage
Note: You can’t create, delete, or duplicate community sites in Site.com. Site.com sites:
• Site.com
Publisher User
SEE ALSO: field enabled on the user
detail page
Using Site.com Studio as a Site Administrator or Designer
AND
Using Site.com Studio as a Contributor
Site administrator or
Planning and Implementing a Site.com Website
designer role assigned
at the site level

To edit only content in

Site.com sites:
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1056
Extend Salesforce with Clicks, Not Code Site.com

Using Site.com Studio as a Site Administrator or Designer

Site.com Studio provides a dedicated site-building environment for site administrators and designers.
EDITIONS
Using the many features available, you can:
• Create page templates to base your site pages on. Available in: Salesforce
• Create site pages. Classic (not available in all
orgs)
• Import assets, such as images and files.
• Edit the site’s style sheet or create new style sheets. Available for purchase in:
Enterprise, Performance,
• View and edit a page or template. and Unlimited Editions
• Add page elements to your site pages to provide features and functionality.
Available (with limitations)
• Use data services to connect to Salesforce objects to retrieve and display, or to submit data. in: Developer Edition
• Create custom widgets that you and other users can reuse throughout the site.
• Create a multilingual site that lets site visitors choose their preferred language.
USER PERMISSIONS
• Create events to add interactive and animated effects to your website.
• Add IP restrictions to control site visitors’ access to the pages, page templates, folders, and To build, edit, and manage
sites Site.com sites:
assets in your site.
• Site.com
• Add URL redirects to inform users and search engines if site content has moved. Publisher User
• Create folders to organize your site content. field enabled on the user
detail page
• Preview your site or generate an anonymous preview link to send to other users.
AND
• Manage the domain information for your site.
Site administrator or
• Publish your recent changes to the live site.
designer role assigned
• Duplicate, import, and export sites. at the site level

Note: To manage domains and

publish Site.com sites:
• Designers can’t manage domains or publish content.
• Site.com
• You can’t create, delete, or duplicate community sites in Site.com. Publisher User
field enabled on the user
detail page
SEE ALSO:
AND
Understanding the Site Administrator and Designer's Overview Tab
Site administrator role
Planning and Implementing a Site.com Website assigned at the site level
Setting Up the Contributor’s Studio View
Site.com Tab Overview

1057
Extend Salesforce with Clicks, Not Code Site.com

Using Site.com Studio as a Contributor

Site.com Studio provides a dedicated content-editing environment for contributors, where you
EDITIONS
can:
• Open a page to edit it. Available in: Salesforce
• Create site pages, if your site administrator or designer has enabled page creation. Classic (not available in all
orgs)
• Edit the page text.
• Add images and hyperlinks to pages. Available for purchase in:
Enterprise, Performance,
• Add page elements to pages. and Unlimited Editions
• Import assets, such as images and files.
Available (with limitations)
• Preview the site in a browser window. in: Developer Edition

SEE ALSO:
USER PERMISSIONS
Understanding the Contributors's Overview Tab
Planning and Implementing a Site.com Website To edit only content in
Site.com sites:
Site.com Tab Overview
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1058
Extend Salesforce with Clicks, Not Code Site.com

Understanding the Site Administrator and Designer's Overview Tab

As a site administrator or designer, when you open a site in Site.com Studio, it opens on the Overview
EDITIONS
tab. Here you can access and manage the site’s components and configure the site’s properties.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

To manage domains and

publish Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator role
assigned at the site level

To manage user roles:

• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator role
assigned at the site level
OR
Manage Users

1059
Extend Salesforce with Clicks, Not Code Site.com

• Select a view (1) on the Overview tab to view its contents (2).
– All Site Content—Create folders to organize your site content. In this view, you can also create pages, templates, and style sheets,
and import assets.
– Site Pages—Create site pages, open and edit pages, access page options, create site map links, and organize the site map. You
can also switch between the default site map view ( ) and the list view ( ).
– Page Templates—Create page templates to base your site pages on, open and edit existing templates, and access template
options.
– Style Sheets—Edit the site’s style sheet or create new style sheets.
– Assets—Import and manage assets, such as images and files.
– Widgets—Build custom widgets that can you and your team can reuse throughout the site.
– Trash Can—Retrieve deleted items. When you delete a page, template, style sheet, or asset, it goes into the trash can. Deleted
items remain in the trash can indefinitely. Retrieved items are restored to their original location. If the original location no longer
exists, they are restored to the top-level root directory.
– Change History—View information about recently published files.
– Site Configuration—Configure site properties, add IP restrictions, create URL redirects, manage domain information, manage
user roles, and add and manage site languages.

• Use the toolbar (3) to:

– Import assets, such as images and files.
– Publish recent changes.
– Preview your site or generate an anonymous preview link to send to other users.
–
Duplicate or export the site, overwrite the site with a version from sandbox, or create a new site ( ).

• Use the site's pull-down menu (4) to:

1060
Extend Salesforce with Clicks, Not Code Site.com

– Open recently accessed sites.

– View Site.com Studio as your contributors see it to ensure that you set up the view correctly.
– Exit Site.com Studio and return to Salesforce.
– Create a new site.
– Duplicate the site.

Note: You can’t create, delete, or duplicate community sites in Site.com.

SEE ALSO:
Using Site.com Studio as a Site Administrator or Designer
Planning and Implementing a Site.com Website
Site.com

Understanding the Contributors's Overview Tab

As a contributor, when you open a site in Site.com Studio, it opens on the Overview tab. Here you
EDITIONS
can access and edit the site’s pages and content, and import images and files.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To edit only content in

Site.com sites:
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1061
Extend Salesforce with Clicks, Not Code Site.com

• Select a view (1) on the Overview tab to view its contents (2).
– All Site Content—View all of the site’s pages, images, and files.
– Site Pages—View and edit pages or create site pages, if available.
– Assets—Import assets, such as images and files.
– Site Configuration—Manage user roles in the site. This is available only if you have the “Manage Users” perm.

• Use the toolbar (3) to:

– Import assets, such as images and files.
– Preview the site in a browser window.

• Use the site's pull-down menu (4) to:

– Open recently accessed sites.
– Exit Site.com Studio and return to Salesforce.

SEE ALSO:
Using Site.com Studio as a Contributor
Site.com

Create a Site.com Community

Each community has one associated Site.com site that lets you add custom, branded pages to your community. By default, Site.com
pages are publicly available and don’t require login, but you can also create private pages that only community members can access.

Note: As of Spring ’15, the Community Template is no longer available for creating communities. If you already have a Site.com
community that’s based on the Community Template, it will continue to work. For information on creating a community with a
new Lightning Community template, see Create an Experience Cloud Site.

1062
Extend Salesforce with Clicks, Not Code Site.com

Before You Begin

Communities users with the “Create and Set Up Communities” permission automatically have full site administrator access to a community’s
Site.com site. To let users who don’t have the permission edit the site, you must purchase and assign a Site.com Publisher or a Site.com
Contributor feature license. And then you must assign a user role at the site level.
See About Site.com User Roles on page 1049.

Tips and Considerations

• Users with the “Create and Set Up Experiences” permission are assigned the role of site administrator in a community’s Site.com site.
However, they don’t appear in the User Roles section on the Overview tab of Site.com Studio.
• You can’t create, delete, or duplicate community sites in Site.com.
• When working with data-bound components, such as data repeaters and forms, keep in mind that the objects listed may not be
available to site visitors. For authenticated visitors, their user profiles control object access on public and private pages. For
unauthenticated visitors, the site’s guest user profile controls object access on public pages.
• When adding forms to authenticated community pages in Site.com, set the current user for Salesforce objects that require the Owner
ID field. Setting the current user (as opposed to the default guest user) lets you identify the authenticated user when the form is
submitted. To set the current user for the Owner ID field, select the field in the form, and click Configure. Under Field Properties in
the Properties pane, select Global Property as the source, and select Current userID as the value.
• The home page, 404 page, login page, and self-registration page that you specify for Site.com Community sites in Site Configuration
set the default pages for the Site.com Community site. These default URLs are used unless you specify different URLs in Community
Management under Administration Pages and Administration Login & Registration . Community error pages are specified in
Lightning Platform Setup, under Error Pages.
• When your Site.com Community site is inactive, users are redirected to the Service Not Available page defined in Community
Management under Pages.
• The contributor’s view is not available by default for Site.com Community sites. However, you can use a Site.com Contributor license
to grant contributor access to a specific user. See About Feature Licenses in the Site.com help for details. Alternatively, a user can
preview the Site.com Community site as a contributor by appending ?iscontrib to the site’s URL. For example:
MyDomainName.builder.salesforce-experience.com/?iscontrib

Use Site.com to Customize Your Community

Create Branded Pages Overview
When you create a Community site, Salesforce automatically creates a new Site.com site and associates it with your community.
Site.com Authorization Overview
Display Current Community User Information
Site.com designers creating authenticated pages for a community site can display the current user’s information by accessing
CurrentUser namespace expressions.
Expressions Available for Displaying Current User Information
Determine the URL of a Site.com Page
Add Authenticated Site.com Pages to Community Tabs
After you create a private Site.com page, you can add the page to a tab in your community.
Add Chatter News or Group Feeds to Community Site.com Pages
Use the Chatter News Feed to display a Chatter feed on your site pages, or display the feeds of a particular group using the Chatter
Group Feed.

1063
Extend Salesforce with Clicks, Not Code Site.com

Improve Performance with HTML Page Caching for Communities in Site.com

HTML caching lets you improve the performance and page rendering of your community’s Site.com site by controlling how often
the generated markup of the page is reloaded.

SEE ALSO:
Use Site.com to Customize Your Community
Experience Cloud

Use Site.com to Customize Your Community

Communities users can use Site.com to build custom, branded pages for a community. There are
EDITIONS
many approaches to building custom pages for your community, but these are some of the typical
stages involved: Available in: Salesforce
• Import Assets—Collect the assets, images, and files you plan to use on your custom page. Classic (not available in all
Import the assets into Site.com Studio, where they appear in the Assets section of the Overview orgs)
tab.
Available for purchase in:
• Create Branded Pages—The quickest and easiest way to create branded pages is to use the Enterprise, Performance,
Community Template, which is automatically included with all Site.com community sites. When and Unlimited Editions
you create a new page based on the Community Template, the page includes all of the branded Available (with limitations)
styles in your community, including the community’s header and footer. If you want even more in: Developer Edition
control over the look and feel of your community page, you can create your own page template,
drag community headers and footers to it from the Widgets section of the Page Elements pane,
and add other community styles. USER PERMISSIONS
Note: As of Spring ’15, the Community Template is no longer available for creating To build, edit, and manage
communities. If you already have a Site.com that’s based on the Communities Template, a community’s Site.com
it will continue to work. For information on creating a community with a new Lightning custom pages:
Community template, see Create an Experience Cloud Site. • Create and Set Up
Communities
• Use Branded CommunityStyles—Develop the look and feel of your custom pages by using
OR
the CommunityBranding style sheet, or by creating branded community styles in your own
cascading style sheets (CSS). If you're not completely up to speed with CSS, the Style pane Site.com
provides an easy, visual way to create and manage styles. Or if you're a CSS expert who likes to Publisher User
field enabled on the user
get straight into the code, you can hand-code community styles right in your own style sheets.
detail page
• Create Public Pages—Using the template as a base, you can quickly create pages, which
AND
automatically inherit all the elements of the page template. Or if you need a standalone page
that doesn't follow the overall design, you can create a blank page instead. Site administrator or
designer role assigned
• Make Pages Private—By default, any page you create in Site.com Studio is publicly available. at the site level
However, you can make pages private so that only logged-in Communities users can access
them.
• Add Features, Page Elements, and Community Widgets—Use Site.com's prebuilt page elements to add features such as
navigation menus, images, content blocks, and community widgets. Retrieve data from your organization’s objects and dynamically
display it on your site pages using data repeaters and data tables. Alternatively, gather and submit data from visitors using forms.
• Add and Edit Content—At this stage, the page is usually ready for you to add and edit content such as text, images, videos, and
hyperlinks. And as you work, you can upload any images or files you need.

1064
Extend Salesforce with Clicks, Not Code Site.com

• Review and Test the Page—Testing the changes to your page happens throughout the development cycle. You should always
preview your changes to ensure they display as expected in a browser. You can also send a preview link to reviewers so they can
review the finished product before it goes live.
• Publish the Page—After testing is complete, you're ready to make the page available to your community by publishing your
changes.
• Add Authenticated Pages to Your Community’s Tab—Now that the page is tested and published, if you’re working with
authenticated pages, the final step is to add the page to a tab in your community.
• Use Site.com in Sandbox—Site.com is now available on sandbox. When you create a sandbox copy from a production organization,
you can include your Site.com sites. You can also copy your sandbox site back to production using the overwrite feature.

SEE ALSO:
Create a Site.com Community
Experience Cloud
Brand Your Salesforce Tabs + Visualforce Site

Create Branded Pages Overview

When you create a Community site, Salesforce automatically creates a new Site.com site and
EDITIONS
associates it with your community.
With Site.com Community sites you can: Available in: Salesforce
Classic (not available in all
• Use the branded Community template to create Site.com pages for your community.
orgs)
Note: As of Spring ’15, the Community Template is no longer available for creating
Available for purchase in:
communities. If you already have a Site.com that’s based on the Communities Template,
Enterprise, Performance,
it will continue to work. For information on creating a community with a new Lightning and Unlimited Editions
Community template, see Create an Experience Cloud Site.
Available (with limitations)
• Use the CommunityBranding style sheet to style Site.com pages by using CSS. in: Developer Edition
• Create your own community CSS styles using a number of available Network namespace
expressions.

Create Branded Pages from the Community Template

Site.com Community sites include a branded template that you can use to create new community site pages.
Apply Community Styles from the CommunityBranding Style Sheet
The CommunityBranding style sheet contains a set of CSS styles created from Network namespace expressions.
Create Styles in a CSS Style Sheet
Branded styles are available in Site.com sites through Network namespace expressions.
Expressions Available for Community Branding
View the CommunityBranding Style Sheet
The CommunityBranding style sheet contains a set of branded styles from your community.

1065
Extend Salesforce with Clicks, Not Code Site.com

Create Branded Pages from the Community Template

Site.com Community sites include a branded template that you can use to create new community
EDITIONS
site pages.

Note: As of Spring ’15, the Community Template is no longer available for creating Available in: Salesforce
communities. If you already have a Site.com community that’s based on the Community Classic (not available in all
orgs)
Template, it will continue to work. For information on creating a community with a new
Lightning Community template, see Create an Experience Cloud Site. Available for purchase in:
The styles for the Community Template come from the CommunityBranding style Enterprise, Performance,
sheet, which is automatically included for all new Site.com Community sites. and Unlimited Editions

To create branded pages from the Community Template: Available (with limitations)
in: Developer Edition
1. On the Site.com Overview tab, hover over Site Pages and click New.
2. Type the new community page name. Page names can’t include spaces or special characters,
such as #, ?, or @. USER PERMISSIONS
3. Make sure Community Template is selected for the page template. To build, edit, and manage
a community’s Site.com
4. Click Create.
custom pages:
Note: • Create and Set Up
Communities
• Community branding options, such as headers, footers, and page colors, are set from the
OR
Administration > Branding section on the Experience Management page.
Site.com
• Empty community headers and footers, or headers that contain only images, won’t work
Publisher User
in Site.com. Be sure to specify customized HTML blocks for your community headers and
field enabled on the user
footers if you’re creating Site.com pages from the Community Template, or creating detail page
community headers and footers using Network namespace expressions.
AND
• Community headers and footers are available as widgets in Site.com community pages.
Site administrator or
To add a community header or footer to a blank page, drag it to the page from the Widgets designer role assigned
section of the Page Elements pane. at the site level

SEE ALSO:
Create Branded Pages Overview
View the CommunityBranding Style Sheet
Site.com Page Templates Overview
Creating Site.com Page Templates

1066
Extend Salesforce with Clicks, Not Code Site.com

Apply Community Styles from the CommunityBranding Style Sheet

The CommunityBranding style sheet contains a set of CSS styles created from Network
EDITIONS
namespace expressions.

Note: As of Spring ’15, the Community Template is no longer available for creating Available in: Salesforce
communities. If you already have a Site.com community that’s based on the Community Classic (not available in all
orgs)
Template, it will continue to work. For information on creating a community with a new
Lightning Community template, see Create an Experience Cloud Site. Available for purchase in:
The CommunityBranding style sheet is attached to the Community Template, and is Enterprise, Performance,
responsible for the template’s branded look and feel. You can access the styles in the and Unlimited Editions
CommunityBranding style sheet and apply them directly to elements on any page. Available (with limitations)
in: Developer Edition
To apply community styles using the CommunityBranding style sheet:
1. Make sure the CommunityBranding style sheet is attached to the Site.com page you
want to brand. USER PERMISSIONS
Note: All Site.com pages based on the Community Template automatically have To build, edit, and manage
the CommunityBranding style sheet attached to them. a community’s Site.com
custom pages:
2. Select the element on the page you want to style. • Create and Set Up
3. Open the Style pane. Communities
OR
4. Select Class.
Site.com
5. Start typing “brand”. Publisher User
A list of all of the available styles in the CommunityBranding styles sheet appears. field enabled on the user
6. Select the style you want to apply. detail page
AND
SEE ALSO: Site administrator or
designer role assigned
Create Branded Pages Overview at the site level
Create Branded Pages from the Community Template
View the CommunityBranding Style Sheet
Creating and Using CSS Style Sheets

1067
Extend Salesforce with Clicks, Not Code Site.com

Create Styles in a CSS Style Sheet

Branded styles are available in Site.com sites through Network namespace expressions.
EDITIONS
You can access a full list of available Network namespace expressions to create new community
styles in any CSS style sheet. When you add an expression to a CSS rule, Site.com “pulls in” the style Available in: Salesforce
as it’s defined in the community, and displays it on your page. Classic (not available in all
orgs)
To create community styles in a CSS style sheet:
1. Open an existing style sheet or create a new style sheet. (See Creating and Using CSS Style Available for purchase in:
Enterprise, Performance,
Sheets on page 1140.)
and Unlimited Editions
2. Click Edit Style Sheet Code.
Available (with limitations)
3. Add a new community style rule by using any of the available Network expressions. You can in: Developer Edition
create both ID styles and class styles. For example:

USER PERMISSIONS

To build, edit, and manage

a community’s Site.com
custom pages:
• Create and Set Up
Communities
OR
Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

#main_content_block {
background-color: {!Network.primaryColor};
color: {!Network.primaryComplementColor};
}
.secondary_content_blocks{
background-color: {!Network.zeronaryColor};
color: {!Network.zeronaryComplementColor};
}

4. Apply the new styles to elements on other pages.

1068
Extend Salesforce with Clicks, Not Code Site.com

Note: Remember, the style sheet that contains your community styles must be attached to the page containing your styled
elements.

SEE ALSO:
Create Branded Pages Overview
Expressions Available for Community Branding
Creating and Using CSS Style Sheets

Expressions Available for Community Branding

You can use the Network namespace expressions listed on this page to create your own
EDITIONS
Community styles.
Community branding options, such as headers, footers, and page colors, are set from the Available in: Salesforce
Administration > Branding section on the Experience Management page. Classic (not available in all
orgs)
Note:
Available for purchase in:
• Empty community headers and footers, or headers that contain only images, won’t work Enterprise, Performance,
in Site.com. Be sure to specify customized HTML blocks for your community headers and and Unlimited Editions
footers if you’re creating Site.com pages from the Community Template, or creating
Available (with limitations)
community headers and footers using Network namespace expressions.
in: Developer Edition
• Community headers and footers are available as widgets in Site.com community pages.
To add a community header or footer to a blank page, drag it to the page from the Widgets
section of the Page Elements pane.

Network Expression Corresponding Community Branding Page Element

{!Network.header} Custom content of the community header.

{!Network.footer} Custom content of the community footer.

{!Network.zeronaryColor} The background color for the community header.

{!Network.zeronaryComplementColor} The font color used with zeronaryColor.

{!Network.primaryColor} The color used for active tabs in the community.

{!Network.primaryComplementColor} The font color used with primaryColor.

{!Network.secondaryColor} The color used for the top border of lists and tables in the
community.

{!Network.tertiaryColor} The background color for section headers on edit and detail pages
in the community.

{!Network.tertiaryComplementColor} The font color used with tertiaryColor.

{!Network.quaternaryColor} The background color for pages in the community.

1069
Extend Salesforce with Clicks, Not Code Site.com

Network Expression Corresponding Community Branding Page Element

{!Network.quaternaryComplementColor} The font color used with quaternaryColor.

SEE ALSO:
Create Branded Pages Overview
Create Styles in a CSS Style Sheet

View the CommunityBranding Style Sheet

The CommunityBranding style sheet contains a set of branded styles from your community.
EDITIONS
Community branding options, such as headers, footers, and page colors, are set from the
Administration > Branding section on the Experience Management page. Available in: Salesforce
Classic (not available in all
To see the Community styles in the CommunityBranding style sheet, on the Site.com Overview
orgs)
tab, click Style Sheets, and click the CommunityBranding style sheet. The Community styles
are listed on the left. To see the code for the style sheet, click Edit Style Sheet Code. Available for purchase in:
Enterprise, Performance,
A total of fourteen Community class styles are provided. These are the default contents of the style
and Unlimited Editions
sheet:
Available (with limitations)
in: Developer Edition

.brandZeronaryBgr {
background-color: {!Network.zeronaryColor} !important;
}
.brandZeronaryFgr {
color: {!Network.zeronaryComplementColor} !important;
}
.brandPrimaryBgr {
background-color: {!Network.primaryColor} !important;
}
.brandPrimaryFgr {
color: {!Network.primaryComplementColor} !important;
}
.brandPrimaryBrd2 {
border-color: {!Network.primaryComplementColor} !important;
}
.brandPrimaryFgrBrdTop {
border-top-color: {!Network.primaryComplementColor} !important;
}
.brandPrimaryBrd {
border-top-color: {!Network.primaryColor} !important;
}
.brandSecondaryBrd {
border-color: {!Network.secondaryColor} !important;
}
.brandSecondaryBgr {
background-color: {!Network.secondaryColor} !important;
}
.brandTertiaryFgr {

1070
Extend Salesforce with Clicks, Not Code Site.com

color: {!Network.tertiaryComplementColor} !important;

}
.brandTertiaryBgr {
background-color: {!Network.tertiaryColor} !important;
color: {!Network.tertiaryComplementColor} !important;
background-image: none !important;
}
.brandTertiaryBrd {
border-top-color: {!Network.tertiaryColor} !important;
}
.brandQuaternaryFgr {
color: {!Network.quaternaryComplementColor} !important;
}
.brandQuaternaryBgr {
background-color: {!Network.quaternaryColor} !important;
}

SEE ALSO:
Create Branded Pages Overview
Create Branded Pages from the Community Template

Site.com Authorization Overview

As part of your site design, you might want to control what content is public and private to your
EDITIONS
site visitors. New sites are initially set so that all site resources, such as folders and pages, are public.
You can change the default setting from the Authorization view found under Site Configuration. Available in: Salesforce
The global site authorization options are: Classic
• No Authorization (default)—All resources are public. Available in: Enterprise,
• Requires Authorization—All resources are private. Performance, Unlimited,
and Developer Editions
• Custom—All resources are public by default, but can be made private.
The No Authorization and Requires Authorization options let you quickly make your site either all
public or all private. But, if you want to control access to individual pages, folders, and other resources, use the Custom option. Selecting
Custom enables a Requires Authorization checkbox on the Actions menu for all resources throughout the site. You
can define authorization at the site, folder, page, and individual resource level. As you mark items for authorization, a lock icon appears
on them. After a resource, like a page, is marked as private, users who aren’t logged into Salesforce are asked to log in when they try to
access it.
Resources can inherit their privacy setting from folders. For example, when a resource, such as a site folder, is marked for authorization,
anything placed in that folder inherits the folder’s authorization setting and becomes private. If you drag that resource into a public
folder, it becomes public again. But, if you explicitly mark a resource as private using the Actions menu, and then drag it into a public
folder, it still remains private because the privacy setting at the resource level dominates.
When you use the Custom option, an authorization table appears in the Authorization view that lets you manage your private
resources/items marked as private. You can remove authorization from a resource by either deleting it from the authorization table, or
by deselecting the Requires Authorization box on the item itself.

Setting Custom Authorization

1071
Extend Salesforce with Clicks, Not Code Site.com

Removing Site.com Authorization

SEE ALSO:
Setting Custom Authorization
Removing Site.com Authorization

Setting Custom Authorization

When you select Custom authorization, you get a great deal of flexibility in controlling access to
EDITIONS
your site. Not only can you control who has access to top level resources, like folders and pages,
but you can also set access at the individual resource level. Available in: Salesforce
Using Custom authorization at the folder level is a great way to make a large number of resources Classic
private without having to mark them individually. Let’s say you periodically run sale offers for your
Available in: Enterprise,
paid users. If you drag all the sale pages into a special folder you mark for authorization, they instantly
Performance, Unlimited,
inherit the folder’s setting. Users will need to log in to access them. Plus, if you decide to make one and Developer Editions
of the sale pages available to everyone, you can simply drag it back into a public folder, or to the
root of the All Site Content area.
USER PERMISSIONS
1. Open you site for editing.
2. Click Site Configuration > Authorization. To manage authorization:
• You must be an
3. Select Custom. administrative user on
4. Click All Site Content. the site
5. Create a folder to hold the private pages if it doesn’t already exist.
6. From the folder’s Actions menu, select Requires Authorization. You’ll see the lock appear on the folder. It is now private.
7. Drag any pages you want to make private into the folder. A lock appears on them too.

Example: Let’s take another example. If you have a page that you’d like to keep private no matter where it resides, you can set
its authorization using the Actions menu. After you set it at the individual resource level, it remains private even if you drag it into
a folder that isn’t set to private. In other words, an resource marked private is always private until you deselect Requires
Authorization on the Actions menu.
If you check the Authorization page, you’ll see all folders and resources marked private are listed in the authorization table where you
can view and delete them.

SEE ALSO:
Removing Site.com Authorization

1072
Extend Salesforce with Clicks, Not Code Site.com

Removing Site.com Authorization

You can remove authorization for a resource by either deleting it from the authorization table under
EDITIONS
Site Configuration, or by deselecting Requires Authorization from the menu.
1. Open your site for editing. Available in: Salesforce
Classic
2. Click Site Configuration > Authorization.
3. From the authorization table, click Delete next to the item you want to remove. Alternatively, Available in: Enterprise,
Performance, Unlimited,
navigate to the All Site Content view. Select the resource. From the Actions menu, deselect
and Developer Editions
Requires Authorization.

Example: If a resource is explicitly marked as private using the Actions menu, then you must
USER PERMISSIONS
remove authorization from it using the Actions menu. For example, if a page marked private
is dragged into a folder that’s public, it remains private. Likewise, if you drag it into a folder To manage authorization:
that’s already private, and remove the authorization on that folder, the page will still be private. • You must be an
administrative user on
the site
SEE ALSO:
Setting Custom Authorization

Display Current Community User Information

Site.com designers creating authenticated pages for a community site can display the current user’s
EDITIONS
information by accessing CurrentUser namespace expressions.
1. Open the page on which you want to display the current community user's information. Available in: Salesforce
Classic (not available in all
2. From the Page Elements pane, drag a Content Block or Custom Code page element onto
orgs)
the page.
3. Type {!CurrentUser. and the value that you want to display. Available for purchase in:
Enterprise, Performance,
For example, {!CurrentUser.firstName}.
and Unlimited Editions
Check the list of available expressions for displaying current user information.
Available (with limitations)
4. Add any additional text you require. in: Developer Edition
For example, Welcome back {!CurrentUser.firstName}!.
5. If you’re in a Content Block, click Save. If you’re in a Custom Code element, click Save and USER PERMISSIONS
Close.
To build, edit, and manage
Note: If an unauthenticated user views a page that contains CurrentUser expressions, a community’s Site.com
the current user information does not appear. For example, if an unauthenticated user viewed custom pages:
a page that contained the above example, the user would see “Welcome back !” as the • Create and Set Up
welcome message. Communities
OR
Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1073
Extend Salesforce with Clicks, Not Code Site.com

Expressions Available for Displaying Current User Information

Use these CurrentUser namespace expressions to display authenticated user information on
EDITIONS
a Site.com community page.
Available in: Salesforce
CurrentUser Expression Displays Classic (not available in all
{!CurrentUser.name} Combined first and last name of the user, as orgs)
displayed on the user detail page. Available for purchase in:
Enterprise, Performance,
{!CurrentUser.firstName} First name of the user, as displayed on the user
and Unlimited Editions
edit page.
Available (with limitations)
{!CurrentUser.lastName} Last name of the user, as displayed on the user in: Developer Edition
edit page.

{!CurrentUser.userName} Administrative field that defines the user’s login.

{!CurrentUser.id} User’s Salesforce ID.

{!CurrentUser.email} Email address of the user.

{!CurrentUser.communityNickname} Name used to identify the user in a site.

{!CurrentUser.accountId} Account ID associated with the user. It displays

a valid account id for partner and customer
users. For all others, it displays
'000000000000000'.

{!CurrentUser.effectiveAccountId} Account ID associated with the effective

account. This expression displays a valid account
ID for partner and customer users. For all others,
it displays '000000000000000'.

1074
Extend Salesforce with Clicks, Not Code Site.com

Determine the URL of a Site.com Page

After you create a Site.com page, you can determine the page’s URL to:
EDITIONS
• Provide your users with a URL that lets them access a public page directly.
• Create a link to the page from other pages, including Salesforce Sites and Visualforce pages. Available in: both Salesforce
Classic (not available in all
• Make it the home page for your community using a URL redirect in Salesforce Sites.
orgs) and Lightning
• Add a private page to a web tab in your community. Experience
1. To determine the correct URL for the page: Available in: Enterprise,
• From the Create Community wizard, click Customize. Performance, Unlimited,
and Developer Editions
• If you navigated away from the Create Community wizard, click Customize >
Communities > All Communities, then click the Manage button next to the community
name. USER PERMISSIONS
2. Click Administration Settings. To build, edit, and manage
a community’s Site.com
3. Copy the URL displayed on the page and paste it into a text editor.
custom pages:
4. To create a URL that points to: • Create and Set Up
• The Site.com site’s home page, append /s/ to the URL. For example, Communities
OR
Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

https://MyDomainName.my.site.com/ExperienceCloudSiteName/s/.
• A specific Site.com page, append /s/<page_name>, where <page_name> is the name of the Site.com page. For example,
https://MyDomainName.my.site.com/ExperienceCloudSiteName/s/promotion.
The URL is case-sensitive and “s” must be lowercase.

Note: If you’re not using enhanced domains, your org’s Experience Cloud sites URL is different. For details, see My Domain
URL Formats in Salesforce Help.

SEE ALSO:
Add Authenticated Site.com Pages to Community Tabs
Salesforce Sites URL Redirects

1075
Extend Salesforce with Clicks, Not Code Site.com

Add Authenticated Site.com Pages to Community Tabs

After you create a private Site.com page, you can add the page to a tab in your community.
EDITIONS
In this case, you need to create a Web tab that points to your Site.com page.
Available in: both Salesforce
1. In the Properties pane for your page, select Show Salesforce Header.
Classic (not available in all
Selecting this option ensures that you see tabs in your community. orgs) and Lightning
2. Enter the tab name as it should appear on the tab in your community. Experience

The web tab you create must have the same name. Available in: Enterprise,
Performance, Unlimited,
3. Determine the correct URL for the page. and Developer Editions
The URL must be in the following format
https://MyDomainName.my.site.com/mycommunity/s/<pagename>,
USER PERMISSIONS
where pagename matches the name of your page.
To build, edit, and manage
Note: If you’re not using enhanced domains, your org’s Experience Cloud sites URL is
a community’s Site.com
different. For details, see My Domain URL Formats in Salesforce Help. custom pages:
4. From Setup, enter Tabs in the Quick Find box, then select Tabs. • Create and Set Up
Communities
5. In Web Tabs, click New and enter the name of the tab as it appears in the Tab Name field in
OR
your page properties.
Site.com
6. On the Step 3 screen, paste the URL you created in the Button or Link URL text box. Publisher User
7. Return to the Create Community wizard and add the new tab to your community. field enabled on the user
detail page
To preview the private page in your community, you must publish your Site.com site.
AND
Note: You can’t publish your site from sandbox. Site administrator or
designer role assigned
at the site level
SEE ALSO:
Experience Cloud
Create Web Tabs
My Domain URL Formats

1076
Extend Salesforce with Clicks, Not Code Site.com

Add Chatter News or Group Feeds to Community Site.com Pages

Use the Chatter News Feed to display a Chatter feed on your site pages, or display the feeds of a
EDITIONS
particular group using the Chatter Group Feed.
1. Drag the News Feed or Group Feed from the Widgets section of the Page Elements pane Available in: both Salesforce
onto the page. Classic (not available in all
When you add a widget to a page, it creates a copy or instance of the widget. You can’t edit orgs) and Lightning
the content of a widget, but you can edit the properties. Experience

2. If you’re adding a group feed, enter the Group ID in the Properties pane. Available in: Enterprise,
The Group ID determines which group feed is displayed on your page. You can include more Performance, Unlimited,
than one group feed on a page if you want to show the feeds for multiple groups. and Developer Editions

3. Preview the page to test the feed, or use Live Mode to see how the feed renders in different
mobile devices.
USER PERMISSIONS

Consider the following limitations when using a news or group feed in your community Site.com To build, edit, and manage
sites: a community’s Site.com
custom pages:
• Chatter news and group feeds only appear if a user is logged in to the community. They don’t • Create and Set Up
appear to guest users or in anonymous preview mode. Communities
• Chatter news and group feeds may not render appropriately on pages less than 700px wide. OR
We recommend a minimum page width of 700px to view full content. We also recommend
Site.com
using a white background. Publisher User
• Chatter news and group feeds only inherit some page branding elements. field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1077
Extend Salesforce with Clicks, Not Code Site.com

Improve Performance with HTML Page Caching for Communities in Site.com

HTML caching lets you improve the performance and page rendering of your community’s Site.com
EDITIONS
site by controlling how often the generated markup of the page is reloaded.
Lets say 100 people visit the page at the same time. Without caching, the page makes 100 separate Available in: Salesforce
requests for the same markup, slowing performance considerably. However, with caching enabled, Classic (not available in all
the page markup is requested and retrieved only once—the first time someone visits the page. orgs)
Any subsequent page requests during a set time period are returned from the cache. When the
Available for purchase in:
specified time period expires, the cache is refreshed. Enterprise, Performance,
Note: The caching duration applies only to community pages that are accessed by guest and Unlimited Editions
users. When a user logs in to access the page, caching is disabled. Available (with limitations)
in: Developer Edition
1. In Site.com Studio, open the page.
2. In the Cache Duration (Minutes) field of the Cache section of the Properties tab,
specify the length of time to cache the page. USER PERMISSIONS
By default, the caching duration of a page is set to 30 minutes.
To build, edit, and manage
To disable caching, set the page’s caching duration to 0. a community’s Site.com
custom pages:
• Create and Set Up
Communities
OR
Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1078
Extend Salesforce with Clicks, Not Code Site.com

Creating a Site.com Site

To get started with Site.com, create a new blank site:
EDITIONS
1. On the Site.com tab in the Site.com app, click New. Alternatively, in Site.com Studio, click Create
a New Site in the site's drop-down menu. Available in: Salesforce
Classic (not available in all
2. Click Create a Blank Website.
orgs)
3. Enter the site name.
Available for purchase in:
4. Click Create. Your new website opens in Site.com Studio, where you can create page templates Enterprise, Performance,
and site pages, and add functionality to it. and Unlimited Editions
Note: You can’t create, delete, or duplicate community sites in Site.com. Available (with limitations)
in: Developer Edition

Deleting a Site.com Site

Duplicating a Site.com Site USER PERMISSIONS
Exporting a Site.com Site To create or import Site.com
sites:
Importing a Site.com Site
• Site.com
Configuring Site Properties Publisher User
Enable Clickjack Protection in Site.com field enabled on the user
detail page
Clickjacking is a type of attack that tricks users to click something, such as a button or link,
because they perceive they are clicking something safe. Instead, the button or link performs
malicious actions on your site, leading to data intrusion, unauthorized emails, changed credentials, or other site-specific results.
Hidden iframes can be placed maliciously on site pages and entice users to click a button or link that appears below the hidden
iframe. With clickjack protection, you can configure whether your browser allows external domains to frame your Site.com site pages.
Site.com Versioning Overview
Each time you publish your site, it’s tracked as a version. You can restore your site back to one of the previously published versions.
You can’t select individual components when restoring; you must restore the complete site.
Creating URL Redirects in Site.com
If you move or reorganize pages in your site, search engines may have trouble finding the new page locations. To avoid this, set up
URL redirects to inform users and search engines that site content has moved.
Importing External Websites into Site.com
With Site.com Studio, you can import your existing website and recreate it automatically as a Site.com site. This saves you the time
of having to re-code existing HTML pages.
Copy and Overwrite a Site
Export a copy of your site, and then use the overwrite feature to replace your current production Site.com or Site.com community
site with the exported file.
Using the Metadata API to Deploy a Site
As a user, you can migrate a site from sandbox to production. You can use the Metadata API to create a deployable package for
Site.com sites and Site.com Communities sites.

SEE ALSO:
Creating Site.com Page Templates
Creating Site.com Pages
Editing Site.com Pages as a Designer or Site Administrator

1079
Extend Salesforce with Clicks, Not Code Site.com

Deleting a Site.com Site

You can delete any site that isn’t published. If the site is published, you must first unpublish it before
EDITIONS
you can delete it. See Taking a Site Offline on page 1225.
1. On the Site.com tab in the Site.com app, select the site and click > Delete. Available in: Salesforce
Classic (not available in all
2. Click OK.
orgs)
Note: You can’t create, delete, or duplicate community sites in Site.com.
Available for purchase in:
Enterprise, Performance,
and Unlimited Editions
SEE ALSO:
Exporting a Site.com Site Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1080
Extend Salesforce with Clicks, Not Code Site.com

Duplicating a Site.com Site

To create a copy of a site:
EDITIONS
1. On the Site.com tab in the Site.com app, select the site and click > Duplicate. Alternatively,
Available in: Salesforce
on the Overview tab in Site.com Studio, click > Duplicate This Site. Classic (not available in all
2. Enter a name for the site. orgs)
3. Click Create. Available for purchase in:
Enterprise, Performance,
Note: and Unlimited Editions
• If you’re creating a copy of a site that uses data services, you must set the data access Available (with limitations)
permissions in the new site’s guest user profile. in: Developer Edition
• You can’t create, delete, or duplicate community sites in Site.com.

USER PERMISSIONS
SEE ALSO:
To build, edit, and manage
Creating a Site.com Site
Site.com sites:
Exporting a Site.com Site • Site.com
Importing a Site.com Site Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1081
Extend Salesforce with Clicks, Not Code Site.com

Exporting a Site.com Site

You can export your site from Site.com to your hard drive. The site is exported in a packaged format
EDITIONS
with a .site extension, which you can import into another Salesforce organization. The maximum
site size you can import is 2 GB. Available in: Salesforce
1. On the Site.com tab in the Site.com application, select the site and click > Export. Classic (not available in all
orgs)
Alternatively, on the Overview tab in Site.com Studio, click > Export This Site.
Available for purchase in:
2. If the site is: Enterprise, Performance,
• Smaller than 100 MB, select a location to save the exported .site file on your hard drive and and Unlimited Editions
click Save. Available (with limitations)
• Larger than 100 MB, you’ll receive an email when the export process has completed. Click in: Developer Edition
the link in the email to download the exported .site file.

Note: USER PERMISSIONS

• Exporting a site doesn’t remove it from the current organization. To build, edit, and manage
Site.com sites:
• Site.com
SEE ALSO: Publisher User
Creating a Site.com Site field enabled on the user
detail page
Importing a Site.com Site
AND
Site administrator or
designer role assigned
at the site level

Importing a Site.com Site

You can import an exported Site.com site into your organization. When you import a site, you’re
EDITIONS
given the site administrator role in the site. You can import a site file that was exported in Summer
’19 or later and has a maximum site size of 2 GB. Available in: Salesforce
1. On the Site.com tab in the Site.com app, click New. Alternatively, in Site.com Studio, click Create Classic (not available in all
a New Site in the site's dropdown menu. orgs)

2. Select Import a Site or Template. Available for purchase in:

3. Enter the site name. Enterprise, Performance,
and Unlimited Editions
4. To locate the exported site on your hard drive, click Browse. Exported sites have a .site extension.
Available (with limitations)
5. Click Create. in: Developer Edition
Note:
• If you’re importing a site that uses data services, you must set the data access permissions USER PERMISSIONS
in the imported site’s guest user profile. Additionally, data repeaters, data tables, data
functions, or forms can require reconfiguration. To create or import Site.com
sites:
• Site.com
Publisher User
field enabled on the user
detail page

1082
Extend Salesforce with Clicks, Not Code Site.com

• You can’t create, delete, or duplicate community sites in Site.com.

SEE ALSO:
Creating a Site.com Site
Exporting a Site.com Site

Configuring Site Properties

Set properties for the site, such as the home page, site name, and error page, and create an
EDITIONS
anonymous preview URL that allows other users to review the site before it goes live. The URL is
always valid (unless you disable it) and shows the latest work in progress. It’s only available to the Available in: Salesforce
people you send it to, and can’t be found by search engines. Classic (not available in all
1. On the Overview tab, click Site Configuration. orgs)

2. Click Edit. Available for purchase in:

3. In the Site Configuration view, you can: Enterprise, Performance,
and Unlimited Editions
• Replace the name in the Site Name field to rename the site.
Available (with limitations)
• See the Developer Name of the site. This read-only field may differ from the Site in: Developer Edition
Name. The Developer Name is used by the Metadata API.
• Select Enable Anonymous Preview to create a URL that allows other users to preview
the site before it goes live. (Click the View Anonymous Preview option that appears in USER PERMISSIONS
the Preview menu to access the preview URL, which you can copy and send to other users
To build, edit, and manage
to review and test your changes.) Enable Anonymous Preview is also available from the
Site.com sites:
Preview menu on the Overview tab.
• Site.com
• Access the site’s guest user profile. Publisher User
• Set the clickjack protection level. field enabled on the user
detail page
• Determine whether guest users can view features available only in Lightning. If you disable
AND
Lightning Features for Guest Users, Lightning features don’t load.
Site administrator or
• Enable Content Sniffing Protection to force the browser to use the Content-Type header
designer role assigned
only. at the site level
• Enable Browser Cross Site Scripting Protection to protect against reflected cross-site
scripting attacks.
• Select Referrer URL Protection to have the referrer header shows only Salesforce.com rather than the entire URL when loading
pages.
• Select the home page for your website in the Home Page drop-down list.
• Site.com Community sites only:
– Select the login page for your Site.com Community site in the Login Page drop-down list.
– Select the page that you’ve set up for Site.com Community site users who don’t have accounts yet from the Registration
Page drop-down list.
– Select the Forgot Password page you’ve set up for your community using Site.com.

• Select a user-friendly error page in the 404 Page drop-down list to display when a page can't be found. It's a good idea to create
a user-friendly error page to assist site visitors if they encounter a broken link.

4. Click Save.

1083
Extend Salesforce with Clicks, Not Code Site.com

Note:
• The home page, 404 page, login page, and self-registration page that you specify for Site.com Community sites in Site
Configuration set the default pages for the Site.com Community site. These default URLs are used unless you specify different
URLs in Community Management under Administration Pages and Administration Login & Registration . Community
error pages are specified in Lightning Platform Setup, under Error Pages.
• When your Site.com Community site is inactive, users are redirected to the Service Not Available page defined in Community
Management under Pages.

SEE ALSO:
Creating a Site.com Site
Using Site.com Studio as a Site Administrator or Designer
Enable Clickjack Protection in Site.com

Enable Clickjack Protection in Site.com

Clickjacking is a type of attack that tricks users to click something, such as a button or link, because
EDITIONS
they perceive they are clicking something safe. Instead, the button or link performs malicious actions
on your site, leading to data intrusion, unauthorized emails, changed credentials, or other site-specific Available in: Salesforce
results. Hidden iframes can be placed maliciously on site pages and entice users to click a button Classic (not available in all
or link that appears below the hidden iframe. With clickjack protection, you can configure whether orgs)
your browser allows external domains to frame your Site.com site pages.
Available for purchase in:
Note: To configure clickjack protection for Experience Cloud sites, see Enable Clickjack Enterprise, Performance,
Protection in Experience Cloud Sites. and Unlimited Editions
You can set the clickjack protection for a Site.com site to one of these levels: Available (with limitations)
in: Developer Edition
• Allow framing by any page (no protection): The least secure level. All external domains can
frame your site pages.
• Allow framing of site pages on external domains (good protection): Only trusted external USER PERMISSIONS
domains can frame your site pages. You specify the domains that you trust in the Trusted
Domains for Inline Frames list. To build, edit, and manage
Site.com sites:
• Allow framing by the same origin only (recommended): The default level for Site.com
• Site.com
sites. Allows framing of site pages by pages with the same domain name and protocol security.
Publisher User
• Don’t allow framing by any page (most protection): The most secure level, but this option field enabled on the user
can cause certain pages to appear as blank pages. To avoid this issue, use the default setting detail page
instead. AND
1. In Site.com Studio, click Site Configuration > Edit. Site administrator or
2. Select your preferred level of clickjack protection and save your changes. designer role assigned
at the site level
3. If you chose to allow framing of your site pages on external domains, specify the domains that
you trust to frame each site’s pages.
a. From Setup in Salesforce Classic, enter Sites in the Quick Find box, and then select Sites.
b. Click the site label to open the Site Details page.
c. Click Add Trusted Domain in the Trusted Domains for Inline Frames section and enter the domain you want to allow iframes
on. You can add up to 512 domains.

1084
Extend Salesforce with Clicks, Not Code Site.com

Tip: Added domains take effect only when Allow framing of site pages on external domains (good protection) is selected.

Note: Internet Explorer supports clickjack protection through the legacy X-Frame-Options HTTP Header only. This header supports
sameorigin, deny (none), allowall, and allow-from uri. In particular, allow-from uri supports only one
URI.
To support a list for IE users, the framing site must identify itself to the site domain by passing in a query parameter in the iframe
tag. For example, if you add https://www.example.com as a trusted external domain and your site URL is
https://MyDomainName.my.site.com, then the page on https://www.example.com must make its iframe
as follows:
<iframe
src="https://MyDomainName.my.site.com?_iframeDomain=https://www.example.com"></iframe>

You can also set the trusted external domain in the iframeDomain cookie. This method allows iframes if the _iframeDomain
URL variable isn’t saved when navigating between pages in IE.
Cookie iframeDomainCookie = ApexPages.currentPage().getCookies().get('iframeDomain');

if (iframeDomainCookie == null) {
iframeDomainCookie = new Cookie('iframeDomain','www.example.com');

// Set the new cookie for the page

ApexPages.currentPage().setCookies(new Cookie[]{iframeDomainCookie});
}

SEE ALSO:
Configuring Site Properties
Enable Clickjack Protection in Experience Cloud Sites
Create and Edit Salesforce Sites

Site.com Versioning Overview

Each time you publish your site, it’s tracked as a version. You can restore your site back to one of
EDITIONS
the previously published versions. You can’t select individual components when restoring; you
must restore the complete site. Available in: Salesforce
When working in Site.com Studio, you’re always working on an unpublished version of your site. Classic (not available in all
It’s your working copy. When you restore a version, you overwrite your working copy, not your live orgs)
site. You must publish the restored version before you see the change on your live site.
Available for purchase in:
In Site.com Studio, you’ll find your site versions in the Change History view on the Overview tab. Enterprise, Performance,
Not all items in a site are reverted when you restore a version. Some things, like user roles, remain and Unlimited Editions
unchanged even when you restore from a previous version. Everything in a site is under version Available (with limitations)
control except: in: Developer Edition
• Site name
• Anonymous preview setting
• Guest User Profile settings
• Clickjack protection level
• Domains and path prefixes

1085
Extend Salesforce with Clicks, Not Code Site.com

• User role settings

Restoring to a Previous Site Version

The Change History list in Site.com Studio tracks all published versions of your site. You can select any previously published version
and restore it. You can only restore an entire site, not parts of a site.

SEE ALSO:
Restoring to a Previous Site Version

Restoring to a Previous Site Version

The Change History list in Site.com Studio tracks all published versions of your site. You can select
EDITIONS
any previously published version and restore it. You can only restore an entire site, not parts of a
site. Available in: Salesforce
Note: The restore version feature is not available in Communities. Classic (not available in all
orgs)
When working in Site.com Studio, you’re always working on an unpublished version of your site.
Available for purchase in:
It’s your working copy. When you restore a version, you overwrite your working copy, not your live
Enterprise, Performance,
site. You must publish the restored version before you see the change on your live site. and Unlimited Editions
Warning: You can’t restore the working copy of your site after you revert to a previous Available (with limitations)
version. Therefore, it’s a good idea to back up the working copy of the site before reverting in: Developer Edition
to ensure you don’t lose any unpublished changes.
To revert to a previously published site version:
USER PERMISSIONS
1. Select the Overview tab.
To build, edit, and manage
2. From the Change History view, select the version you want to restore. Site.com sites:
3. Click > Restore Version. • Site.com
Publisher User
4. Click OK at the confirmation message.
field enabled on the user
After you restored your working site to a previous version, you can continue to make additional detail page
changes until you’re ready to publish the site. AND
Site administrator or
designer role assigned
at the site level

1086
Extend Salesforce with Clicks, Not Code Site.com

Creating URL Redirects in Site.com

If you move or reorganize pages in your site, search engines may have trouble finding the new
EDITIONS
page locations. To avoid this, set up URL redirects to inform users and search engines that site
content has moved. Available in: Salesforce
You can use URL redirects to: Classic (not available in all
orgs)
• Maintain search engine ranking. For example, if you change a page’s name from “Gadgets” to
“Widgets,” creating a redirect rule from /Gadgets to /Widgets lets you restructure the Available for purchase in:
site without affecting your page ranking. Enterprise, Performance,
• Make URLs more readable and memorable. For example, site visitors will find long or numeric and Unlimited Editions
page names, such as /widget65AD890004ab9923, difficult to remember. Instead, you Available (with limitations)
can provide them with a short, friendly URL, such as /widget, and create an alias that redirects in: Developer Edition
to the correct page when the user uses the short URL alias.
• Assist with migration from another system to Site.com if you’re still using the same domain.
USER PERMISSIONS
For example, if your old site ran on PHP, you can create a redirection rule from an old page,
such as /index.php, to a new page in Site.com, such as /myNewPage. To build, edit, and manage
To assign a redirect to a site page: Site.com sites:
• Site.com
1. On the Overview tab, click Site Configuration > URL Redirects. Publisher User
2. Click Create a Redirect. field enabled on the user
detail page
3. Specify the Redirect type:
AND
Option Description Site administrator or
designer role assigned
Permanent (301) Select this option if you want users and search at the site level
engines to update the URL in their systems
when visiting the page. Users visiting a page
redirected with this type are sent seamlessly
to the new page. Using a permanent redirect
ensures that your URLs retain their search
engine popularity ratings, and that search
engines index the new page and remove the
obsolete source URL from their indexes.

Temporary (302) Select this option if you want users and search
engines to keep using the original URL for the
page. Search engines interpret a 302 redirect
as one that could change again at any time,
and though they index and serve up the
content on the new target page, they also
keep the source URL in their indexes.

Alias Select this option if you don’t want the URL

to change in the user’s browser, but you want
to redirect to a different page. Search engines
won’t be aware of the change or update their
records.

1087
Extend Salesforce with Clicks, Not Code Site.com

Option Description
Alias redirects only work when you redirect from one Site.com
page to another. You can’t create an alias to an external address.

4. Specify the former page location in the Redirect from field.

• The page location must be a relative URL.
• The page can have any valid extension type, such as .html or .php, and can contain parameters. Parameter order is irrelevant.
• The URL can’t contain anchors, such as /siteprefix/page.html#target.
• You can create just one redirection rule from a particular URL. If you create a new rule with the same Redirect From information,
the old rule is overwritten.

5. Specify the new page location in the Redirect to field. This can be a relative URL or a fully-qualified URL with an http://
or https:// prefix. Unlike pages you’re redirecting from, pages you’re redirecting to can contain anchors.
6. To immediately enable the redirection rule, ensure Active is selected. To enable it at a later stage, deselect the property.
7. Click Save.
The URL Redirects section displays all URL redirection rules you've created for your site.
• Edit an assigned redirect rule by clicking > Edit Redirect.
• Delete a redirect rule by clicking > Delete Redirect.

Importing External Websites into Site.com

With Site.com Studio, you can import your existing website and recreate it automatically as a
EDITIONS
Site.com site. This saves you the time of having to re-code existing HTML pages.
Create a zipped file of your website and the content with the desired folder structure. Create a new Available in: Salesforce
Site.com site and then import your zipped file. Classic (not available in all
orgs)
During the creation of the new Site.com site, all your HTML pages and assets are copied into the
new site in the same locations they are in the zipped file. Here are some guidelines for importing Available for purchase in:
assets. Enterprise, Performance,
and Unlimited Editions
• Some code in style sheets may not convert properly to the Site.com format. If this happens,
you’ll receive a warning message. You can continue to import the zipped file or stop the import. Available (with limitations)
If you continue, the style sheet imports and you can then manually attach it to your pages. in: Developer Edition
• You can edit the <head> section of a page using Edit Head Markup in scripts section on the
properties pane. This is useful for manually editing the HTML.
• The maximum file size you can import is 50 MB unless you import and unzip a .zip file. In that case, you can import a .zip file of up
to 200 MB if you select Unzip files during the import process. If your site is larger than 200MB when zipped, you can create more
than one zipped file and import them individually.
• Site.com attempts to format links correctly when importing a page. Links are checked in content blocks, custom code, and head
script markup. You can check for any links that might still be broken on your page using the link checker. Open the page, select
> Find Broken Links. A dialog displays showing any broken links. To fix the link, click Edit. The link opens in the HTML editor.

SEE ALSO:
Importing a Site.com Site

1088
Extend Salesforce with Clicks, Not Code Site.com

Copy and Overwrite a Site

Export a copy of your site, and then use the overwrite feature to replace your current production
EDITIONS
Site.com or Site.com community site with the exported file.
First, export a copy of your site from your Site.com Studio. Next, import the exported .site file Available in: Salesforce
into production using the overwrite feature. Overwrite replaces your production site with the Classic (not available in all
imported site. You can only overwrite sites that are the same type. For example, you can’t overwrite orgs)
a Site.com site with a Site.com community site. Available for purchase in:
Note: We recommend only overwriting Aura sites, and only using Aura .site files to do Enterprise, Performance,
so. To replace a Build Your Own (LWR) site with an Aura .site file, or to replace any site and Unlimited Editions
using a Build Your Own (LWR) .site file, import the .site file to a new site instead. Available (with limitations)
in: Developer Edition
1. Create your .site file using the export feature in Site.com Studio.
2. From Site.com Studio in your production site, click Site Actions > Overwrite This Site.
Alternatively, if you have access to the Site.com tab, you can click next to the site name to USER PERMISSIONS
find Overwrite.
To overwrite sites:
3. Click Browse to find and select the .site file you exported. • Site administrator or
4. Click OK at the overwrite warning. designer role assigned
at the site level
Warning: You can’t revert after you overwrite a site.

Here are a few tips when using overwrite:

• You must publish the site you overwrote for changes to take effect.
• When copying a site, the production site is overwritten. Be sure to back up your production site by exporting a .site file before
you overwrite.
• Overwrite doesn’t copy data changes. For example, if you created a custom object to use in a repeater in the site that you’re copying
from, the repeater won’t work in the production site until you create the same custom object.
• If the production site has assets that don’t exist in the site that you’re copying from, they’re moved to the trash can during the
overwrite process so you can restore them if needed.
• If your copied site has a different name than your production site, the production name is preserved and only the contents are
changed. For example, if your site is called Site One and you overwrite your production site called Site Two, the production site is
still called Site Two.

SEE ALSO:
Exporting a Site.com Site
Using the Metadata API to Deploy a Site

1089
Extend Salesforce with Clicks, Not Code Site.com

Using the Metadata API to Deploy a Site

As a user, you can migrate a site from sandbox to production. You can use the Metadata API to
EDITIONS
create a deployable package for Site.com sites and Site.com Communities sites.

Note: For information on deploying a Lightning community or a Salesforce Tabs + Visualforce Available in: Salesforce
community, see Deploy a Community from Sandbox to Production. Classic (not available in all
orgs)
There are several tools that you can use to create a package:
Available for purchase in:
• Change sets (for Site.com and Site.com Communities sites only). The component type is called
Enterprise, Performance,
Site.com. and Unlimited Editions
• Workbench, which works for creating all site types. The metadata type is called SiteDotCom.
Available (with limitations)
• Lightning Platform Migration Tool for Ant, which works for creating all site types. The metadata in: Developer Edition
type is called SiteDotCom.
If using change sets, select Site.com from the list and follow the prompts to create your package.
If using Workbench or Lightning Platform as your tool, you must create a package.xml file. That file is submitted to the Metadata
API to create a package.

Note: You can include a Guest User Profile in your package.xml file. If you do so, that Guest User Profile is linked to the site
during deployment.
The packaging process generates a folder that contains a content file and a metadata xml file. The content file name is
[sitename].site. The metadata .xml file name is [sitename].site-meta.xml.
If you deploy a package that doesn’t include a .site file, an empty site is created. If the package contains a site file, and the organization
already contains a site with the same name, the site is updated.

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.
For help with the Metadata API, see the Metadata API Developer Guide. You can find help for change sets in the online help and for the
Migration Tool Guide at https://developer.salesforce.com/page/Migration_Tool_Guide.

Sample Package.xml Files

Here are some sample Site.com package.xml files.

SEE ALSO:
Change Sets
Sample Package.xml Files

1090
Extend Salesforce with Clicks, Not Code Site.com

Sample Package.xml Files

Here are some sample Site.com package.xml files.
EDITIONS
Here is a sample package.xml file for a Site.com site.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

<?xml version="1.0" encoding="UTF-8"?>

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>xyzsite</members>
<name>SiteDotCom</name>
</types>
<version>30.0</version>
</Package>

Here is an example of a package.xml for a Salesforce Communities site. The package also includes a Guest User Profile.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>xyzsite</members>
<name>CustomSite</name>
</types>
<types>
<members>xyzsite</members>
<name>Network</name>
</types>
<types>
<members>xyzsite1</members>
<name>SiteDotCom</name>
</types>
<types>
<members>xyzsite Profile</members>
<name>Profile</name>
</types>
<version>30.0</version>
</Package>

1091
Extend Salesforce with Clicks, Not Code Site.com

Importing and Managing Assets

Contributors, publishers, and site administrators can import a variety of assets, such as images,
EDITIONS
HTML pages, and PDFs, to use in a website. You can import assets and files individually, or use a
zipped file. When importing entire websites or large numbers of assets, it’s easier to create a zipped Available in: Salesforce
file of the content with the desired folder structure. When importing the zipped file for a website, Classic (not available in all
Site.com recreates your website and places everything in the same folder structure. orgs)
Note: The maximum file size you can import is 50 MB unless you import and unzip a .zip file. Available for purchase in:
In that case, you can import a .zip file of up to 200 MB if you select Unzip files during the Enterprise, Performance,
import process. and Unlimited Editions
The quickest way to import one or more files is to: Available (with limitations)
in: Developer Edition
1. Select the files from your computer and drag them directly onto the Studio interface. This is
supported for Mozilla® Firefox® and Google® Chrome only. You can drag individual files, or a
zipped file.
USER PERMISSIONS
2. Depending on the types of files you’re importing, a dialog box may appear that lets you:
To build, edit, and manage
• Select Unzip files to extract the contents of a .zip file. If the .zip file includes folders, this Site.com sites:
structure is maintained in your site. • Site.com
• Select Overwrite existing files to replace a file that already exists in the site. Publisher User
• Select Convert CSS files into style sheets, if you're a site administrator or designer, to field enabled on the user
detail page
convert a CSS file into a style sheet that you can use to style your website.
AND
Note: If you import a .zip file that includes CSS files, and they fail to convert, they
Site administrator or
may not be valid. Try unchecking this option and then re-importing the .zip file. designer role assigned
at the site level
• Select Convert HTML files into pages to import HTML pages into your website. The
structure of the HTML page is maintained in your site, but the HTML is not validated during To edit only content in
import. Site.com sites:
• Site.com
Alternatively, to import a single file: Contributor User
1. Click Import.... AND
2. Click Browse... to locate the file. Contributor role
assigned at the site level
3. Select the file and click Open.
4. Depending on the type of file you’re importing, you can:
• Select Unzip files to extract the contents of a .zip file. If the .zip file includes folders, this structure is maintained in your site.
• Select Overwrite existing files to replace a file that already exists in the site.
• Select Convert CSS files into style sheets, if you're a site administrator or designer, to convert a CSS file into a style sheet that
you can use to style your website.

Note: If you import a .zip file that includes CSS files, and they fail to convert, they may not be valid. Try unchecking this
option and then re-importing the .zip file.

• Select Convert HTML files into pages to import HTML pages into your website. The structure of the HTML page is maintained
in your site, but the HTML is not validated during import.

5. Click Import. A message appears indicating whether the file was imported successfully.
6. Click .

1092
Extend Salesforce with Clicks, Not Code Site.com

You can add images and videos to the text areas of your site pages, or create a hyperlink to any imported asset. If you're a site administrator
or designer, you can add also add images directly to the page.
View the list of imported assets in the Assets view on the Overview tab. You can also access assets in the All Site Content view, which
displays the folder hierarchy of your site.
• To view a thumbnail of an imported image, hover over it.
• To save an asset to your computer, hover over or select it and click > Download.
• To remove an asset from your site if you're a site administrator or designer, hover over or select it and click > Delete. If the
asset is being used in your site, you see a confirmation message with a list of locations where that asset is in use. After an asset file
is deleted, it exists in the Salesforce cache for up to 24 hours. After this it is permanently deleted from our systems.

Note: An asset may still be accessible if it's cached locally by a browser, or cached by an external system.

• To rename an asset on your site if you're a site administrator or designer, hover over the asset and click > Rename.

Exporting Assets
Designers and site administrators can export all site assets separately from the .site file. You can export assets together or
individually.
Creating and Managing Folders
As a site administrator or designer, you can create folders to manage your pages, style sheets, templates, and assets.

SEE ALSO:
Adding Site.com Page Elements
Using Site.com Studio as a Site Administrator or Designer
Using Site.com Studio as a Contributor
Exporting Assets

1093
Extend Salesforce with Clicks, Not Code Site.com

Exporting Assets
Designers and site administrators can export all site assets separately from the .site file. You
EDITIONS
can export assets together or individually.
When you export all assets, the assets are exported to a zipped file that is named after the site Available in: Salesforce
name—for example, sitename-Assets.zip. Classic (not available in all
orgs)
Export your assets from the Overview tab by clicking > Export Site Assets.
Available for purchase in:
To export a single asset, hover over the asset and select Download from the Actions menu. Enterprise, Performance,
and Unlimited Editions
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, Available (with limitations)
in: Developer Edition
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.
USER PERMISSIONS
SEE ALSO:
To build, edit, and manage
Importing and Managing Assets Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1094
Extend Salesforce with Clicks, Not Code Site.com

Creating and Managing Folders

As a site administrator or designer, you can create folders to manage your pages, style sheets,
EDITIONS
templates, and assets.
To create new folders: Available in: Salesforce
Classic (not available in all
1. In the All Site Content view on the Overview tab, click New Folder.
orgs)
2. Type in the folder name.
Available for purchase in:
3. Click Create. Enterprise, Performance,
Folders are created at the top level of the folder tree. Once created, you can drag them anywhere and Unlimited Editions
in the tree structure. Likewise, you can drag and drop files into the folders you create. To rename, Available (with limitations)
delete, and create sub-folders, right-click the folder or use the Actions menu ( ). in: Developer Edition

Note: The site map remains the same regardless of how you arrange folders in the All Site
Content view. USER PERMISSIONS

SEE ALSO: To build, edit, and manage

Site.com sites:
Understanding the Site Administrator and Designer's Overview Tab • Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1095
Extend Salesforce with Clicks, Not Code Site.com

Editing Site.com Pages as a Designer or Site Administrator

When working with page templates and site pages, you can add content, structure, and style, all
EDITIONS
in one place. Open a page or template on the Overview tab by double-clicking it or hovering over
it and clicking > Edit. The page opens as a new tab. Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

• Using the Page Elements and Page Structure panes (1), you can search for and add page elements to a page, and reorder
the page element hierarchy.

1096
Extend Salesforce with Clicks, Not Code Site.com

•
Using the Properties, Style, and Events panes (2), you can set properties, add style, and create events for a selected
page or element.
• Using the toolbar (3), you can:
– Undo and redo your actions.
– Cut, copy, or paste page elements.
– Import assets, such as images and files.
– Preview pages to see how they’ll appear when live on different devices.
– Preview your site or generate an anonymous preview link to send to other users.
– Publish your recent changes.
–
Access other page actions ( ), such as renaming or deleting the page.

• On the page canvas (4), you can lay out the page and select, edit, and move page elements.

Tip:
• Hide the side panes to increase the canvas size by clicking and . To reopen a pane, click its icon.
• As you edit a page, your changes are saved and the status icon ( ) on the page tab is updated automatically.
• If the site page or page template is based on another template, editable page elements are highlighted with a blue border on
the page.

Site.com Page Templates Overview

Creating Site.com Page Templates
Creating Editable Template Areas
As the template creator, you specify which elements users can edit in pages based on the template.
About Editable Page Elements
When you mark a page element as Editable on a page template, that page element becomes editable in any child pages or
templates derived from the parent template.
Creating Site.com Pages
Identifying Which Template a Site.com Page Uses
Renaming, Duplicating, and Converting Pages
Changing a Page’s Doctype Property
The Document Type Definition (DTD) or doctype of a page defines which version of HTML it’s using. This information is used by some
browsers to trigger a standard rendering mode. By default, each page’s doctype is set to HTML5, which is the latest version, but you
can change it to XHTML 1.0.

SEE ALSO:
Using Site.com Studio as a Site Administrator or Designer

1097
Extend Salesforce with Clicks, Not Code Site.com

Site.com Page Templates Overview

Before you begin building the pages of your website, take some time to plan the pages you need,
EDITIONS
and in particular, which pages will have a similar layout. Once you've decided on the layout, the
quickest method is to use a page template to build the basic layout. Available in: Salesforce
Classic (not available in all
About Page Templates orgs)

A page template lets you define the layout and functionality of site pages in one location. By adding Available for purchase in:
common page elements to the template and then basing site pages on it, you can achieve a Enterprise, Performance,
consistent look and feel throughout your site. Page templates don't appear on your public site. and Unlimited Editions

As the template creator, you specify which elements users can edit in pages based on the template. Available (with limitations)
By default, a page element in a template is “locked,” so users can't edit its contents in any in: Developer Edition
template-based page unless you mark the page element as “editable.” Conversely, when users edit
an editable page element in a template-based page, their changes are specific to that page and
don't affect your template.
For example, this main page template contains a non-editable header and navigation menu that are common to all the pages in the
site (1). The main template also has an editable center panel (2) to house the page-specific content of each page that's based on it.

Note:
• Page templates must contain at least one editable page element. Otherwise, users can't edit site pages that are based on the
template.
• Panels are ideal for adding editable areas to page templates.

You can use page templates to:

• Save time and effort by laying out the page structure and using it as a starting point when you create site pages. For example, you
could design a template with a fixed header panel and side menu, and an editable center panel, to which you add page-specific
page elements and content.
• Quickly make global updates to the layout or style of your website, as any changes you make to the template's design are reflected
immediately in all the pages that use it.
• Control how other users (such as contributors or other site administrators and designers) can modify site pages. For example, you
may allow contributors to edit specific content blocks only.
• Ensure your template design remains pixel-perfect. When users edit a page that's based on a template, their changes don't affect
your template.
• Reuse common design elements by creating child templates.
• Allow contributors to create site pages that are based on the template.

1098
Extend Salesforce with Clicks, Not Code Site.com

About Child Templates

Child templates are a useful way to reuse common design elements for more complicated page layouts. For example, your website will
probably have elements that are the same on every page in your site, such as a navigation menu. However, several pages may have
elements that are common only to them, such as pages in a subsection of your site that include a subsection header. By using a child
template, which is a template that's based on another template, you can reuse the main template design.
Using our main page template as a base, the child template inherits the non-editable header and navigation menu (1), and an editable
center panel (2) where we add the non-editable subsection header (3). We also need to add a new editable center panel (4) because
the center panel of the main template is editable only in pages directly based on the main template.

Now, any page based on the child template includes the non-editable main header, navigation menu, and subsection header, and an
editable center panel (5) for that page's content.

Best Practices
• Plan your site structure and the layout of your pages. Taking the time to plan your website first saves time when you build your site.
• Identify which elements are common to all the pages of your site, such as navigation menus or headers, as these are the elements
you can add to the page template.
• Use page templates wherever possible to promote content reuse and save time.
• Try to keep the design of your main page template as simple as possible to make it easier to modify in the future. For more complicated
site designs, use child templates to achieve maximum flexibility.

SEE ALSO:
Creating Site.com Page Templates
Creating Site.com Pages
Setting Up the Contributor’s Studio View
Identifying Which Template a Site.com Page Uses

1099
Extend Salesforce with Clicks, Not Code Site.com

Creating Site.com Page Templates

A page template lets you define the layout and functionality of site pages in one location. By adding
EDITIONS
common page elements to the template and then basing site pages on it, you can achieve a
consistent look and feel throughout your site. And because a template-based page inherits the Available in: Salesforce
template's elements, you can make site-wide changes from one location. Classic (not available in all
You can create a page template from a layout, or if you've already created a template, you can use orgs)
it as a base to create a child template, which lets you reuse the design of the main template.
Available for purchase in:
Enterprise, Performance,
Creating a Page Template from a Layout and Unlimited Editions

To start from scratch with a completely blank template or use a basic page layout: Available (with limitations)
in: Developer Edition
1. Hover over Page Templates on the Overview tab and click New, or click New Page Template
in the Page Templates view.
2. Enter the page template name. Template names can’t include special characters, such as #, ?, USER PERMISSIONS
or @.
To build, edit, and manage
3. Click Layouts and select either a blank page or a predefined page layout, such as a page with Site.com sites:
a header and footer. • Site.com
Publisher User
Note: Predefined page layouts use panels to create columns, headers, and footers. These field enabled on the user
panels use inline CSS to set their position, so you can easily modify the layout after the detail page
page is created. However, if you're familiar with CSS and prefer using CSS rules, you can
AND
remove the inline style by selecting the panel, deleting the code from the Code tab in
Site administrator or
the Style pane ( ), and clicking Apply. designer role assigned
at the site level
4. Choose a layout mode:
• To expand the page to fill the width of the browser window, click Full width.
• To set the page width, click Fixed width and enter the width.

5. Click Create. The page template opens.

Next, you must complete the template.

Tip:
• By default, any template you create is only available to other site administrators and designers in your organization. To let
contributors create pages based on the template, select Available to Contributor in the Properties pane ( ).
• You can also create templates by converting or duplicating other pages.

Creating a Child Template

To use an existing template as a base for a child template:
• The quickest option is to:
1. Select the template in the Page Templates view on the Overview tab and click > Create Child Template. Alternatively,
click Page Actions > Create Child Template if the template is open.
2. Enter the page template name. Template names can’t include special characters, such as #, ?, or @.
3. Click Create. The child template opens.

• Alternatively:

1100
Extend Salesforce with Clicks, Not Code Site.com

1. Hover over Page Templates on the Overview tab and click New, or click New Page Template in the Page Templates view.
2. Enter the page template name. Template names can’t include special characters, such as #, ?, or @.
3. Click Page templates and select the page template.
4. Click Create. The child page template opens.

Completing Your Template

Once you've created a template, you must take the next steps to complete it:
• Lay out the page template
• Add other page elements to the template
• Create editable areas
• Create template-based site pages

SEE ALSO:
Creating Editable Template Areas
Identifying Which Template a Site.com Page Uses
Site.com Page Templates Overview
Setting Up the Contributor’s Studio View

Creating Editable Template Areas

As the template creator, you specify which elements users can edit in pages based on the template.
EDITIONS
To make a page element editable in derived pages or child templates, select it on the page template
Available in: Salesforce
or in the Page Structure pane ( ) and click > Make Editable, or select Editable in the
Classic (not available in all
Properties pane ( ). orgs)
When the page template is open, editable page elements are highlighted with a blue border on Available for purchase in:
the page. They also display a pencil icon ( ) in the Page Structure pane and in the information Enterprise, Performance,
popup that appears when you hover over the element on the page. and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

SEE ALSO: Site.com sites:
About Editable Page Elements • Site.com
Setting Up the Contributor’s Studio View Publisher User
field enabled on the user
Creating Site.com Page Templates detail page
AND
Site administrator or
designer role assigned
at the site level

1101
Extend Salesforce with Clicks, Not Code Site.com

About Editable Page Elements

When you mark a page element as Editable on a page template, that page element becomes
EDITIONS
editable in any child pages or templates derived from the parent template.
Consider these tips when creating editable page elements. Available in: Salesforce
Classic (not available in all
• Editable page elements are highlighted with a blue border in child pages and templates.
orgs)
• If you make a page element within a panel editable, you can’t also make the container panel
editable. Available for purchase in:
Enterprise, Performance,
• Users can't alter the events, style, or properties of an editable page element in pages based on
and Unlimited Editions
the template.
Available (with limitations)
• Users can't resize, reposition, or delete editable page elements in pages based on the template.
in: Developer Edition
However, if the element's Auto Height property is enabled in the template, its height will adjust
to fit the content of the template-based page.
• Deleting an editable element from a page template removes it from all child pages and
templates.
• When you enable the Editable property of a page element, any pages or child templates based on the template also inherit
the enabled status. In turn, the enabled status in the child template cascades to any of its children, and so on. If you don’t want its
editability to cascade to any lower levels, disable the Editable property of a page element in a child template.

Editable Page Elements for Contributors

• Contributors can modify editable content blocks in site pages based on the template. They can also edit content blocks that you
place in an editable panel in template-based site pages.

Tip: To add a content block that only other site administrators or designers can edit, use custom code instead.

• Contributors can add content blocks to editable panels in site pages based on the template. If you make widgets available to
contributors, they can also add them to editable panels.
• Site administrators and designers can edit any page element you make editable.

Default Content in Editable Page Elements

The content of all editable page elements on a child page or template is linked to the content of the editable elements on its parent
page template. When you update the content of an editable page element on the parent template, the changes are pushed down to
any child pages or page templates. However, if you modify the content of an editable page element at the child page or template level,
you break the link between the elements, and any subsequent changes made to the page element on the parent template won't trickle
down to its children. (To return control of the content to the parent template, select the editable page element on the page or in the
Page Structure pane and click > Revert to Parent Content. When you do this, any custom content in the editable page element
is lost.)
Disabling the Editable property of a panel in a parent template overrides any changes made to that panel in child pages or templates.
Changes to the panel at the child level disappear, and the panel reflects only the content from the parent template. However, the changes

1102
Extend Salesforce with Clicks, Not Code Site.com

at the child level aren’t lost. Re-enabling the Editable property of the panel in the parent template restores the custom content
previously added to its children. Any changes made to the element at the parent level will no longer show up.

SEE ALSO:
Creating Editable Template Areas
Setting Up the Contributor’s Studio View
Creating Site.com Page Templates
Editing and Working With Site.com Page Elements

Creating Site.com Pages

As a site administrator or designer, when you create a site page, you can choose to base it on a
EDITIONS
page template. If you're creating several site pages that have common page elements, such as a
navigation menu, you can save time and effort and achieve a consistent look and feel by creating Available in: Salesforce
a page template first and then basing your site pages on it. Alternatively, if none of your site pages Classic (not available in all
have a similar structure or if you need to create a one-off site page that doesn't follow the overall orgs)
site design, such as a home page, you can create a page based on a basic layout.
Available for purchase in:
Enterprise, Performance,
Creating Site Pages from a Layout and Unlimited Editions
Start from scratch with a completely blank page or use a basic page layout. Available (with limitations)
1. Hover over Site Pages on the Overview tab and click New, or click New > Site Page when in: Developer Edition
the Site Pages view is open.
2. Enter the site page name. Page names can’t include spaces or special characters, such as #, ?, USER PERMISSIONS
or @.
To build, edit, and manage
3. Click Layouts and select either a blank page or a predefined page layout, such as a page with
Site.com sites:
a header and footer.
• Site.com
Note: Predefined page layouts use panels to create columns, headers, and footers. These Publisher User
panels use inline CSS to set their position, so you can easily modify the layout after the field enabled on the user
detail page
page is created. However, if you're familiar with CSS and prefer using CSS rules, you can
remove the inline style by selecting the panel, deleting the code from the Code tab in AND

the Style pane ( ), and clicking Apply. Site administrator or

designer role assigned
4. Choose a layout mode: at the site level

• To expand the page to fill the width of the browser window, click Full width.
• To set the page width, click Fixed width and enter the width.

5. Click Create. The site page opens.

Creating Site Pages from a Page Template

If you created a page template, you can base your site pages on it.
The quickest option is to:
1. Select the template in the Page Templates view and click > Create Page from Template. Alternatively, click Page Actions >
Create Page from Template if the template is open.

1103
Extend Salesforce with Clicks, Not Code Site.com

2. Enter the site page name. Page names can’t include spaces or special characters, such as #, ?, or @.
3. Click Create. The site page opens.
Alternatively:
1. Hover over Site Pages on the Overview tab and click New, or click New > Site Page when the Site Pages view is open.
2. Enter the site page name. Page names can’t include spaces or special characters, such as #, ?, or @.
3. Click Page templates and select the page template.
4. Click Create. The site page opens.

Tip: You can also create pages by converting or duplicating other pages.

SEE ALSO:
Editing Site.com Pages as a Designer or Site Administrator
Adding Site.com Page Elements

Identifying Which Template a Site.com Page Uses

When you edit a template-based page, you can't modify its non-editable page elements. You also
EDITIONS
can't reposition, resize, or delete editable page elements, or alter the events, properties, or style
associated with them. To update these elements or properties, you must edit them in the template Available in: Salesforce
the page is based on. Classic (not available in all
To identify which page template a site page is based on: orgs)

• Hover over the site page in the Sites Pages view on the Overview tab. An information popup Available for purchase in:
appears that displays the page template's name. Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
• Examine the Page Structure pane when the page is open. The template's name is displayed as detail page
a link that you can click to open the template.
AND
Site administrator or
designer role assigned
at the site level

1104
Extend Salesforce with Clicks, Not Code Site.com

Tip: To view and open the site pages associated with a particular page template, select or hover over the page template in the
Page Templates view of the Overview tab and click > Edit Pages Based on Template. Click a listed site page to open it.

SEE ALSO:
Creating Site.com Page Templates
Site.com Page Templates Overview

Renaming, Duplicating, and Converting Pages

When working with pages and templates, you can perform common tasks, such as renaming,
EDITIONS
deleting, or duplicating pages.
To access more page options, select or hover over a page on the Site Pages view of the Overview Available in: Salesforce
tab and click . Classic (not available in all
orgs)
To access more template options, select or hover over a template in the Page Templates view of
the Overview tab and click . Available for purchase in:
Enterprise, Performance,
Alternatively, if the page or template is open, click on the toolbar. and Unlimited Editions

The available options vary for pages and templates: Available (with limitations)
in: Developer Edition
Select To...
Edit Open the page or template for editing. Alternatively, double-click the USER PERMISSIONS
page or template.
To build, edit, and manage
Rename Change the page or template name. Site.com sites:
• Site.com
Preview View the page in a browser window.
Publisher User
Duplicate Create a copy of the page or template. field enabled on the user
detail page
Duplicating a page template doesn’t duplicate the pages or templates
AND
based on it.
Site administrator or
Delete Remove a page or template. You can't delete a template that has designer role assigned
at the site level
pages based on it.

1105
Extend Salesforce with Clicks, Not Code Site.com

Select To...
Create Child Template Create a child template based on the selected template.

Create Page from Template Create a page based on the template.

Convert Site Page to Template Change the page into a template.

Convert Template to Site Page Change the template into a page. You can't convert a template that has pages based on it.

Edit Pages Based on Template View and open the site pages that are based on the selected page template.

Add IP Restrictions Control access to the page or template by restricting the range of permitted IP addresses. When
you create a page that’s based on a template with IP restrictions, the page inherits the IP
restrictions.

SEE ALSO:
Editing Site.com Pages as a Designer or Site Administrator
Using Site.com Studio as a Site Administrator or Designer

Changing a Page’s Doctype Property

The Document Type Definition (DTD) or doctype of a page defines which version of HTML it’s using.
EDITIONS
This information is used by some browsers to trigger a standard rendering mode. By default, each
page’s doctype is set to HTML5, which is the latest version, but you can change it to XHTML 1.0. Available in: Salesforce
When the page is open: Classic (not available in all
orgs)
1. Select the page in the Page Structure pane.
2. In the Properties pane, select an option in the Doctype drop-down list. Available for purchase in:
Enterprise, Performance,
and Unlimited Editions
SEE ALSO:
Available (with limitations)
Changing a Page Element’s HTML Tag in: Developer Edition
Adding Custom HTML Attributes
HTML5 Semantic Page-Layout Tags
USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1106
Extend Salesforce with Clicks, Not Code Site.com

Site.com Page Elements

Page elements are the building blocks of your site pages and page templates. Combined, they
EDITIONS
provide the page's structure and content.
When a site page or page template is open in Site.com Studio, these page elements are available Available in: Salesforce
to site administrators and designers. Classic (not available in all
orgs)
Page Element Description Available for purchase in:
Content Block Contains the page text, and can also house Enterprise, Performance,
images, media, and hyperlinks. Also available to and Unlimited Editions
contributors if the page has editable areas. Available (with limitations)
in: Developer Edition
Custom Code Lets you customize your site by adding markup,
such as HTML and JavaScript for elements that
aren't provided in Site.com Studio.

Image Adds images directly to the page.

Breadcrumb Adds a breadcrumb navigation element to the

page.

Menu Creates a menu that lets users navigate through

the pages of your site.

Panel Adds structure to the page and lets you group

other page elements together.

Button Adds a button to the page. You can use the

actions in the Events pane to add functionality
to the button.

Form Lets you create web-to-lead forms or gather

customer feedback, and submit the data to
Salesforce objects.

Input Fields Provides several field types to add to forms or

pages. When added to a form, binds to fields in
the form’s object. See Input Field Types.

Data Element Must be contained in a data repeater. Binds to

a field in the data repeater’s object and acts as
a placeholder that shows the content of a
specified field for the current record.

Data Function Connects to a standard or custom Salesforce

object, performs calculations on the returned
results, and displays the calculation on the page.

Data Repeater Connects to a Salesforce object and returns a

dataset based on filters that you specify.
Combines with data elements or custom code
page elements to display the results on the
page.

1107
Extend Salesforce with Clicks, Not Code Site.com

Page Element Description

Data Table Connects to a standard or custom Salesforce object, retrieves a
data set based on the filter criteria that you specify, and displays
one or more record as rows in the table.

Adding Site.com Page Elements

Editing and Working With Site.com Page Elements
Laying Out Site.com Pages Using Panels
Positioning Panels Using CSS
Adding Images Directly to the Page
Adding Content Blocks to Pages
Content blocks contain the text of your website pages, and can also house images, videos, and hyperlinks. Designers and site
administrators can add content blocks to pages when in Design Mode.
Adding Custom Code to Pages
Custom code lets you customize your site using markup, such as HTML and JavaScript.
About the Site Map and Page Hierarchy
Adding Custom HTML Attributes
You can add custom HTML attributes to pages and page elements, which are rendered on the HTML tag of the page element. For
example, this is useful when working with third-party frameworks that render page elements differently based on certain attributes.
Changing a Page Element’s HTML Tag
By default, panels, data repeaters, data elements, custom code, and content blocks are each defined as a div, but you can change
this to any other HTML tag using the HTML Tag property. This gives you greater flexibility and control over how the page element
is displayed on the page.
HTML5 Semantic Page-Layout Tags

SEE ALSO:
Adding Site.com Page Elements
Editing and Working With Site.com Page Elements

1108
Extend Salesforce with Clicks, Not Code Site.com

Adding Site.com Page Elements

Page elements are the building blocks of your site pages and page templates. Panel elements add
EDITIONS
structure to your pages. You can think of both pages and panels as “containers” for the page elements
that you add to them. Available in: Salesforce
If a site page or page template is based on another page template, you can only add page elements Classic (not available in all
to editable panels, which are highlighted with a blue border on the page. orgs)

Pages, panels, data repeaters, and forms are “container” page elements, so you can add other page Available for purchase in:
elements to them when the page is open. Enterprise, Performance,
and Unlimited Editions
• In the Page Elements pane ( ), either:
Available (with limitations)
– Drag the page element onto the page canvas or container page element. in: Developer Edition
– Click the page element, select where to place it in the popup that appears, and click Apply.

• In the Page Structure pane ( ), hover over a container page element and click > Add USER PERMISSIONS
Page Elements. Click the item you want to add or drag it onto the container page element.
To build, edit, and manage
• Select a container page element on the page and click > Add Page Elements. Click the Site.com sites:
item you want to add or drag it into the container page element. • Site.com
When you drag a page element into an editable panel, the page element displays a permitted icon Publisher User
and a green border shows where you're placing the element. field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

If you try dragging a page element into a panel that isn't editable, the page element displays a
not-permitted icon.

SEE ALSO:
Editing and Working With Site.com Page Elements
Adding Images Directly to the Page
Adding Content Blocks to Pages
Adding Custom Code to Pages
Adding a Navigation Menu

1109
Extend Salesforce with Clicks, Not Code Site.com

Editing and Working With Site.com Page Elements

The Page Structure pane ( ) displays the hierarchy of all elements on the page and is a very EDITIONS
useful way of selecting, moving, and reordering elements, particularly for more complicated page
designs. Available in: Salesforce
Classic (not available in all
• To select a page element, either click it on the page, or select it in the Page Structure pane. This
orgs)
highlights the element on the page and displays the item's selector bar and Actions menu
( ). Available for purchase in:
• To edit a page element, such as a content block, image, or custom code, either: Enterprise, Performance,
and Unlimited Editions
– Double-click the element on the page.
Available (with limitations)
– Select the element on the page and click > Edit on its selector bar. in: Developer Edition
– Select or hover over the element in the Page Structure pane and click > Edit.
– Click Edit Content on the toolbar (for content blocks only).
USER PERMISSIONS
• To move a page element, either:
To build, edit, and manage
– Select the element on the page and drag it to the correct position, or click > Move Site.com sites:
on its selector bar. • Site.com
– Drag the item to your preferred location in the Page Structure pane, or select it and click Publisher User
> Move > Direction. You can also drag all page elements other than panels to field enabled on the user
detail page
your preferred location in the Page Structure pane.
AND
• To resize a page element, select it and drag the resize handles to the correct size. If the corner
Site administrator or
resize handles are grayed out, it means the item's Auto Height property is enabled, which adjusts designer role assigned
the height depending on its contents. To resize it to a set height, disable the property by either at the site level
deselecting Auto Height in the Properties pane ( ), or by clicking one of the bottom resize
handles and clicking Disable Auto Height in the popup message that appears.

Tip: If you disable the Auto Height property on an image, but you want it to retain its aspect ratio—the relationship of height
to width—press and hold down the SHIFT key while you drag to resize it.
Alternatively, if you're using CSS to style the page element, adjust the style of the class or ID that styles it.

• To delete an element, select it and either:

– Click > Delete on the item's selector bar.
– Press DELETE.
–
Click on the toolbar.
– In the Page Structure pane, click > Delete.

If a site page or page template is based on another page template:

• The content of all editable page elements on a child page or template is linked to the content of the editable elements on its parent
page template. When you update the content of an editable page element on the parent template, the changes are pushed down
to any child pages or page templates. However, if you modify the content of an editable page element at the child page or template
level, you break the link between the elements, and any subsequent changes made to the page element on the parent template
won't trickle down to its children.
• You can't reposition or resize its page elements. However, if the element's Auto Height property is enabled in the template, the
height will adjust to fit the content in the template-based page. To edit the page element, you must edit it in the page template.
• You can't delete its page elements. To delete the page element, you must delete it from the page template.

1110
Extend Salesforce with Clicks, Not Code Site.com

• You can't alter the events, properties, or style of an editable page element, such as its color, position, and size.

SEE ALSO:
Site.com Page Elements
Adding Site.com Page Elements
Adding Content Blocks to Pages
Laying Out Site.com Pages Using Panels
About Editable Page Elements

Laying Out Site.com Pages Using Panels

A panel is a useful layout tool that defines the logical divisions of your page and lets you group
EDITIONS
page elements together for easy movement and positioning. Think of it as a container for other
page elements, including other panels, or as a div that wraps around the content placed within Available in: Salesforce
it. Panels are ideal for adding editable areas to page templates. Classic (not available in all
When you create a page template or site page, you can use predefined page layouts that include orgs)
headers, footers, and columns, which are created using panels. Once created, you can then further Available for purchase in:
modify the layout to match your site's design. Enterprise, Performance,
If you need to add more divisions to the page and you're not familiar with CSS, the easiest method and Unlimited Editions
is to use row and column panels. This feature adds panels with predefined CSS positioning to ensure Available (with limitations)
they align correctly on the page. in: Developer Edition
Note: Predefined page layouts, and row and column panels use inline CSS to set their position.
If you're familiar with CSS and are using CSS rules to style your site, you can remove the inline
USER PERMISSIONS
CSS by deleting it from the Code tab in the Style pane ( ) and clicking Apply.
To build, edit, and manage
To add row and column panels to a page: Site.com sites:
1. Select the page (the top folder icon) in the Page Structure pane ( • Site.com
).
Publisher User
2. Click > Add Rows and Column Panels. field enabled on the user
detail page
3. Select the number of row or column panels you require. If the page already contains content,
it is placed in the first new panel. AND

To add a row panel: Site administrator or

designer role assigned
• Above a panel, select the panel on the page or in the Page Structure pane and click > at the site level
Add Rows and Column Panels > Insert Row Above
• Below a panel, select the panel on the page or in the Page Structure pane and click >
Add Rows and Column Panels > Insert Row Below
To add row and column panels to another panel:
1. Select the panel on the page or in the Page Structure pane.
2. Click > Add Rows and Column Panels.
3. Select the number of row or column panels you require. If the page already contains content, it is placed in the first new panel.

To add a single panel, drag a Panel from the Page Elements pane ( ) onto the page.

1111
Extend Salesforce with Clicks, Not Code Site.com

By default, the height of a panel automatically adjusts when you add content to it because its Auto Height property is enabled. You can
disable the property to resize and reposition panels. If you hover over a panel on the page, an information popup appears that displays
the width and height of the panel.

When you drag a page element onto a panel, the edges change color, indicating that the element is now grouped within it. To remove
the element from the group, drag it outside the panel.

SEE ALSO:
Adding Site.com Page Elements
Positioning Panels Using CSS
Changing a Page Element’s HTML Tag

Positioning Panels Using CSS

A panel is a useful layout tool that defines the logical divisions of your page. Using CSS, you can
EDITIONS
position panels and improve the layout of the page.
Available in: Salesforce
Adding Padding and Margins to Panels Classic (not available in all
orgs)
Two CSS properties—margins and padding—can help with your page layout by creating space
between the rows and columns, and the content within. The margin property controls the space Available for purchase in:
outside the panel between its border and outer edge, while the padding property controls the Enterprise, Performance,
space between the panel's content and border. and Unlimited Editions

To add margins and padding: Available (with limitations)

in: Developer Edition
1. Select the panel.
2. Open the Dimensions section of the Style pane.
USER PERMISSIONS
3. In the Margins section, either:
• Set the margin width for all four sides by entering a value in the All text box and selecting To build, edit, and manage
the unit of measurement. Site.com sites:
• Site.com
• Set the margin widths for the top, right, bottom, or left sides independently by entering a Publisher User
value in the appropriate text box and selecting the unit of measurement. field enabled on the user
detail page
4. Similarly, in the Padding section, set the padding widths as required. Adding padding increases
the total width of the panel. For example, if you have a panel with a width of 500px and you AND
add padding of 20px to all sides, the total width of the panel will be 540px. Site administrator or
designer role assigned
Tip: You can center a panel or block page element using the margin property. Enter 0 in at the site level
the All text box and select Auto in the drop-down list.

Creating Column Panels Using the Float Property

If you need to add more divisions to the page and you're not familiar with CSS, the easiest method is to use row and column panels.
Alternatively, using the CSS float property, you can position panels to the left or right to create columns. (When you add panels using

1112
Extend Salesforce with Clicks, Not Code Site.com

the row and column panels feature, they're automatically positioned using the float property.) For example, you could add two single
panels to a container panel and set both panel's float and width properties to create a two-column page layout.
To create a column panel:
1. Select the panel.
2. Open the Layout section of the Style pane.
3.
Click to float the panel to the left, or click to float the panel to the right. If you're creating a two-column layout, for
example, ensure you set the float property of both panels.
4. Adjust the width of the panel to ensure the panels align correctly by either setting the width in the Dimensions section or dragging
the panel's border on the page. For example, if you're creating two columns of equal width, set the width of both panels to 50%.

Tip: When you use the float property, remember to set the overflow property of the container panel to “hidden.” This allows the
container panel to grow as the height of the column panels increase. Select the container panel and in the Layout section of the
Style pane, select Hidden in the Overflow drop-down list.

SEE ALSO:
Cascading Style Sheets Overview
Laying Out Site.com Pages Using Panels

Adding Images Directly to the Page

As a site administrator or designer, you can add images directly to your site pages and page templates
EDITIONS
or you can add images to content blocks.
To add an image directly to the page: Available in: Salesforce
Classic (not available in all
1. Open the site page or page template.
orgs)
2. Drag an Image from the Page Elements pane onto the page.
Available for purchase in:
3. In the Add an Image dialog box, either: Enterprise, Performance,
• Find an existing image by typing its name in the Search Image text box and selecting and Unlimited Editions
it from the list. Available (with limitations)
• Upload an image from your computer in the Upload tab by browsing to the image, clicking in: Developer Edition
Upload, and selecting it from the list.

4. Click Apply. The image is added to the page. USER PERMISSIONS

5. Enter a brief description of the image in the Alternative Text field in the Properties
To build, edit, and manage
pane. The description is used by screen reader users or as a substitute if the browser can’t display Site.com sites:
the image. It can also help with search engine optimization (SEO). • Site.com
Publisher User
SEE ALSO: field enabled on the user
detail page
Adding Site.com Page Elements
AND
Editing and Working With Site.com Page Elements
Site administrator or
designer role assigned
at the site level

1113
Extend Salesforce with Clicks, Not Code Site.com

Adding Content Blocks to Pages

Content blocks contain the text of your website pages, and can also house images, videos, and
EDITIONS
hyperlinks. Designers and site administrators can add content blocks to pages when in Design
Mode. Available in: Salesforce
To add a content block when the page is open, either drag it from the Page Elements pane onto Classic (not available in all
the page or target a container page element. orgs)

To edit a content block, double-click it. For greater control over the text, you can edit the HTML Available for purchase in:
directly by selecting the content block and clicking > Edit HTML. Enterprise, Performance,
and Unlimited Editions
If you make a content block in a page template editable, contributors can edit the content block
in any page based on the template. To add a content block that only other site administrators or Available (with limitations)
designers can edit, use custom code instead. in: Developer Edition

Understanding the Content Editing Toolbar USER PERMISSIONS

Editing Content Blocks in Design Mode
To build, edit, and manage
Designers and site administrators can edit content blocks on the page. Content blocks contain Site.com sites:
the text for site pages, and can also house images, videos, and hyperlinks. • Site.com
Adding Images to Content Blocks in Design Mode Publisher User
field enabled on the user
Adding Video to Content Blocks in Design Mode detail page
Attaching Hyperlinks to Text and Images in Design Mode AND
Adding Anchors to Pages in Design Mode Site administrator or
designer role assigned
at the site level
SEE ALSO:
Adding Images to Content Blocks in Design Mode
Attaching Hyperlinks to Text and Images in Design Mode

Understanding the Content Editing Toolbar

Designers and site administrators can edit content blocks when in Design mode. Content blocks
EDITIONS
contain the site page's text, along with images, videos, and hyperlinks.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

1114
Extend Salesforce with Clicks, Not Code Site.com

When in Design Mode, you can use the content editing toolbar to:
• Undo and redo your edits, and remove the formatting of text copied and pasted from Microsoft® Office, which can often include
hidden formatting (1).
• Cut, copy, and paste text (2).
• Apply direct formatting (3), such as:
– Font family and size
– Bold, italic, underline, subscript, superscript, and strikethrough
– Font and highlight color

• Control the text style and layout (4) by:

– Applying paragraph and heading styles
– Setting paragraph indentation
– Left-aligning, centering, right-aligning, or justifying text
– Inserting numbered or bulleted lists

• Insert a table, and add rows, columns, and spacing (5).

• Add images, videos, and special characters (6).
• Add and remove hyperlinks and anchors (7).

Tip: Avoid applying formatting, such as different fonts or highlighting, directly to text whenever possible. Instead, it’s best practice
to use the paragraph and heading styles to quickly apply consistent formatting throughout the site. This also ensures that all page
text is updated automatically if a site administrator or designer modifies the site's paragraph and heading styles.

1115
Extend Salesforce with Clicks, Not Code Site.com

Editing Content Blocks in Design Mode

Designers and site administrators can edit content blocks on the page. Content blocks contain the
EDITIONS
text for site pages, and can also house images, videos, and hyperlinks.
When the page is open in Design Mode: Available in: Salesforce
Classic (not available in all
1. Double-click the content block on the page.
orgs)
2. Add or edit text and format it using the content editing toolbar.
Available for purchase in:
Tip: Enterprise, Performance,
• If you copy and paste text from Microsoft® Office, highlight the text and click and Unlimited Editions
to
remove any hidden formatting, which can adversely affect how the text appears on Available (with limitations)
in: Developer Edition
the page.
• Avoid applying formatting, such as different fonts or highlighting, directly to text
whenever possible. Instead, it’s best practice to use the paragraph and heading styles USER PERMISSIONS
to quickly apply consistent formatting throughout the site. This also ensures that all
page text is updated automatically if a site administrator or designer modifies the To build, edit, and manage
site's paragraph and heading styles. Site.com sites:
• Site.com
3. Add images, videos, hyperlinks, or anchors as required. Publisher User
field enabled on the user
4. Click Save. detail page

Note: The content of all editable page elements on a child page or template is linked to the AND
content of the editable elements on its parent page template. When you update the content Site administrator or
of an editable page element on the parent template, the changes are pushed down to any designer role assigned
child pages or page templates. However, if you modify the content of an editable page at the site level
element at the child page or template level, you break the link between the elements, and
any subsequent changes made to the page element on the parent template won't trickle
down to its children.

1116
Extend Salesforce with Clicks, Not Code Site.com

Adding Images to Content Blocks in Design Mode

Designers and site administrators can add images to content blocks when viewing a page in Design
EDITIONS
Mode.
When the page is open: Available in: Salesforce
Classic (not available in all
1. Double-click the content block on the page.
orgs)
2. Position your cursor where you want to insert the image and click .
Available for purchase in:
3. In the Image Properties dialog box, either: Enterprise, Performance,
and Unlimited Editions
• Enter a URL to an image in the Image URL field.
• Select an image from your website by clicking From Website and selecting the image in Available (with limitations)
in: Developer Edition
the list that appears.
• Upload an image from your computer by opening the Upload tab, browsing to the image,
and clicking Upload. USER PERMISSIONS
4. Enter a brief description of the image in the Alternative text field. The description is To build, edit, and manage
used by screen reader users or as a substitute if the browser can’t display the image. It can also Site.com sites:
help with search engine optimization (SEO). • Site.com
5. Optionally, preview how the image appears in relation to the text on the page and set: Publisher User
field enabled on the user
• The width and height of the image detail page
• How much space surrounds the image (which is controlled by the HSpace and VSpace AND
properties) Site administrator or
• How it aligns with the text on the page designer role assigned
at the site level
• The image border (for example, to set a dotted green border that's 10 pixels wide, you enter
10px dotted green in the Border field) To edit only content in
Site.com sites:
6. Click Apply. • Site.com
7. Click Save. Contributor User
AND
SEE ALSO: Contributor role
Editing Content Blocks in Design Mode assigned at the site level

Understanding the Content Editing Toolbar

Importing and Managing Assets

1117
Extend Salesforce with Clicks, Not Code Site.com

Adding Video to Content Blocks in Design Mode

Designers and site administrators can add YouTube®, Google®, Adobe® Flash®, Windows Media®,
EDITIONS
and Apple QuickTime® videos to content blocks when viewing a page in Design Mode.
When the page is open: Available in: Salesforce
Classic (not available in all
1. Double-click the content block on the page.
orgs)
2. Position your cursor where you want to insert the video and click .
Available for purchase in:
3. In the Video Properties dialog box, select the video type and either: Enterprise, Performance,
• Enter the URL to the video in the Video URL text box—for example, and Unlimited Editions
http://www.youtube.com/watch?v=123abc. Available (with limitations)
• Select a video from your website by clicking From Website and selecting the video in the in: Developer Edition
list that appears.
• Upload a video from your computer by opening the Upload tab, browsing to the image, USER PERMISSIONS
and clicking Upload.
To build, edit, and manage
Note: You can only select or upload Flash, Windows Media, and QuickTime videos. Site.com sites:
• Site.com
4. To specify how the video is displayed on the page, you can set: Publisher User
field enabled on the user
• The width and height of the video detail page
• How much space surrounds the video (which is controlled by the HSpace and VSpace AND
properties)
Site administrator or
• How it aligns with the text on the page designer role assigned
at the site level
You can also preview the video.
5. Click Apply. The video appears as an icon in the content block. To edit only content in
Site.com sites:
6. Click Save. • Site.com
Note: You can view all video types, other than Windows Media videos, when you preview Contributor User
a page. AND
Contributor role
SEE ALSO: assigned at the site level

Editing Content Blocks in Design Mode

Understanding the Content Editing Toolbar

1118
Extend Salesforce with Clicks, Not Code Site.com

Attaching Hyperlinks to Text and Images in Design Mode

When viewing a page in Design Mode, designers and site administrators can create hyperlinks to:
EDITIONS
• External Web pages or websites
• Pages and assets in the site Available in: Salesforce
Classic (not available in all
• Email messages
orgs)
• Anchors on the page
Available for purchase in:
When the page is open: Enterprise, Performance,
1. Double-click the content block on the page. and Unlimited Editions
2. Select the text or image that you want to attach a hyperlink to and click Available (with limitations)
.
in: Developer Edition
3. Select the link type in the Link to drop-down list. To link to:
• A Web page:
USER PERMISSIONS
a. Select A URL.
To build, edit, and manage
b. Type the address in the URL field—for example,
Site.com sites:
http://www.externalsite.com.
• Site.com
c. Go to step 4. Publisher User
field enabled on the user
• A page or item in your site: detail page
a. Select An item in your site. AND
b. Select the item type, such as a page or image. Site administrator or
designer role assigned
c. Select the item. (If you can’t see the list of items, place your cursor in the URL field and at the site level
press the DOWN key on your keyboard.)
d. Go to step 4.

• An anchor that you previously added to the page:

a. Select An anchor on the page.
b. Select the anchor in the drop-down list. Alternatively, enter a new anchor name and create the anchor afterwards.
c. Go to step 5.

• An email message:
a. Select An email.
b. Enter the recipient's email address and the message information.
c. Go to step 5.

Note: For content blocks in a data repeater, you can use expressions to add a custom link, such as a URL query string, to an
item in your site or to a Web page.

4. To select which window the item should open in, select an option in the Target drop-down list:
• Popup window loads the item into a popup window. When you select this option, you can set the title for the popup and
control its appearance and size with the options that appear.
• New window (_blank) loads the item into a new, unnamed browser window.
• Same window (_self) loads the item into the same frame or window as the link. This is the default setting.
• Topmost window (_top) loads the item into the topmost parent frameset or window of the frame that contains the link.

1119
Extend Salesforce with Clicks, Not Code Site.com

• Parent window (_parent) loads the item into the parent frameset or window of the frame that contains the link.

5. Optionally, enter a tooltip description for the link. The tooltip displays as a pop-up when the user hovers over the link.
6. Click Apply.
7. Click Save.

To delete a hyperlink, select it and click .

SEE ALSO:
Editing Content Blocks in Design Mode
Understanding the Content Editing Toolbar

Adding Anchors to Pages in Design Mode

An anchor is an invisible marker that identifies a particular location on a page. If you’re a designer
EDITIONS
or site administrator, you can add an anchor to the page and then create a hyperlink that jumps to
that specific location. This can be useful if a page is particularly long; for example, if your page has Available in: Salesforce
several sections, you could add links to each section at the top of the page to aid navigation. Classic (not available in all
When the page is open in Design Mode: orgs)

1. Double-click the content block on the page. Available for purchase in:
2. Place your cursor at the beginning of the line where you want to link to and click Enterprise, Performance,
. and Unlimited Editions
3. Enter a name for the anchor and click Apply. Ideally, use a name that helps identify the anchor’s Available (with limitations)
location on the page—for example, top. in: Developer Edition
4. Now create a hyperlink that links to the anchor.

USER PERMISSIONS
SEE ALSO:
Attaching Hyperlinks to Text and Images in Design Mode To build, edit, and manage
Site.com sites:
Editing Content Blocks in Design Mode
• Site.com
Understanding the Content Editing Toolbar Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

To edit only content in

Site.com sites:
• Site.com
Contributor User
AND
Contributor role
assigned at the site level

1120
Extend Salesforce with Clicks, Not Code Site.com

Adding Custom Code to Pages

Custom code lets you customize your site using markup, such as HTML and JavaScript.
EDITIONS
• Add markup to a specific location on a page using the Custom Code page element. JavaScript
added using the Custom Code page element loads when that part of the page loads. Available in: Salesforce
• Add markup to the page head. JavaScript in the page head loads first. Classic (not available in all
orgs)
• Add JavaScript to the page body. JavaScript added to the page body is positioned at the
end of the body tag and only loads when the DOM is ready. Available for purchase in:
Enterprise, Performance,
• Add a reference to a JavaScript file or library in the page head or body.
and Unlimited Editions
Tip: Available (with limitations)
• Scripts can't execute while you're editing a page in Site.com Studio. To test your code, in: Developer Edition
preview the page.
• If you are building a Site.com site from an existing HTML site, avoid using the Custom
USER PERMISSIONS
Code page element to paste large chunks HTML from the original site. Instead, use the
available page elements, such as panels, content blocks, and data tables. This will let you To build, edit, and manage
make future updates and design changes much more easily. Site.com sites:
• Site.com
Publisher User
Adding Markup Directly to the Page field enabled on the user
detail page
1. Drag a Custom Code page element from the Page Element pane onto the page.
AND
2. Enter the code in the Edit Code dialog box.
Site administrator or
3. Click Save and Close to add the code directly to the page. designer role assigned
at the site level
Adding Markup to the Page Head
1. In the Scripts section of the Properties pane, click Configure in the Edit Head Markup section.
2. Enter the markup in the Edit HTML Code dialog box.
3. Click Save and Close to insert the markup into the page head.

Adding JavaScript to the Page Body

1. In the Scripts section of the Properties pane, click Configure in the Edit Body Scripts section.
2. Enter the code in the Edit JavaScript Code dialog box. Don't add <script> tags, as they're already included.
3. Click Save and Close to add the code to the bottom of the page body.

Using JavaScript Files or Libraries

Instead of adding JavaScript code directly to a page, you can include links to imported or external JavaScript files, or to an open-source
library (via the Google Libraries API).
1.
In the Scripts section of the Properties pane, click in either the Body Scripts or the Head Scripts section.
2. To link to:
• A JavaScript file that you've imported, select An imported script and select the file.
• An open-source JavaScript library, select A Google AJAX library and select the library.
• An external JavaScript file, select A URL to an external script and enter the address.

1121
Extend Salesforce with Clicks, Not Code Site.com

3. Click Apply.

SEE ALSO:
Displaying Data Using Custom Code
Adding Site.com Page Elements

About the Site Map and Page Hierarchy

The Site Pages view on the Overview tab contains the pages and site map links of your website.
EDITIONS
The Site Map folder reflects the hierarchy or tree structure of your site by housing site pages and
links that are included in the site map. When you create new pages or site map links, they're Available in: Salesforce
automatically added to this folder. The Landing Pages folder houses standalone pages that are Classic (not available in all
excluded from the site map, making it ideal for temporary pages, such as promotional or competition orgs)
pages.
Available for purchase in:
Tip: If you can’t see the Site Map folder in the Site Pages view on the Overview tab, click Enterprise, Performance,
. and Unlimited Editions

When adding a navigation menu to your site, it's important to organize the hierarchy of your site Available (with limitations)
in: Developer Edition
pages and links accurately, because this structure is used to generate the menu. Pages and site
map links are displayed in navigation menus in the order you arrange them.
In this representation of the site hierarchy, you can more clearly see the tree structure.

1. The Site Map folder, which contains four site pages.

2. A top-level page in the site hierarchy.
3. A top-level, parent page with two child pages. A child page is a page at a lower level in the site hierarchy than its parent page.
4. Two child pages.
5. The Landing Pages folder, which contains a temporary page that's not part of the site map or navigation menu.

1122
Extend Salesforce with Clicks, Not Code Site.com

Tip: If a page has child pages, the icon appears beside it indicating that you can expand the branch.

By default, when you create a menu, it’s generated from the pages and site map links in the Site Map folder in the Site Pages view.
However, you can also create a menu that’s generated from the pages in the Landing Pages folder or from the child or sibling pages of
a site page.
You can hide a page in menus, breadcrumbs, and the site map by selecting the Hide Page checkbox found on the Properties pane
for each page. This setting also prevents website visitors from accessing the page’s direct URL. By default, all pages are visible.

Adding Links to a Site Map

Pages aren’t the only things you can assign to your site map. Add internal or external URLs to your site map to customize your
navigation menus and breadcrumbs, and achieve greater flexibility and control.
Adding Breadcrumb Navigation to Pages
Add a Breadcrumb page element to your page to help users navigate through your site and show the page’s location in the site
hierarchy.
Adding a Navigation Menu
Styling Navigation Menus

SEE ALSO:
Adding a Navigation Menu
Creating Site.com Pages

1123
Extend Salesforce with Clicks, Not Code Site.com

Adding Links to a Site Map

Pages aren’t the only things you can assign to your site map. Add internal or external URLs to your
EDITIONS
site map to customize your navigation menus and breadcrumbs, and achieve greater flexibility and
control. Available in: Salesforce
For example, let’s say you have a top-level Products page that has a menu based on its child pages. Classic (not available in all
You also want to include a page called Testimonials in the menu, but it’s not a child page of the orgs)
Products page. You can create a site map link that points to the Testimonials page and add the link
Available for purchase in:
under Products in the site map. Now when visitors view the Products page, they see a menu Enterprise, Performance,
consisting of its child pages, along with a menu item that takes them directly to Testimonials. and Unlimited Editions
1. On the Overview tab, click New > Site Map Link. Available (with limitations)
2. Enter a name for the link. in: Developer Edition

3. Enter a URL. URLs can be either relative or absolute, and are case sensitive.

Note: You can’t preview absolute site map links in Site.com Studio unless they include USER PERMISSIONS
a prefix, such as http:// or https://.
To build, edit, and manage
Site.com sites:
4. Click Create.
• Site.com
The link appears at the bottom of the site map.
Publisher User
5. Drag the link to the correct position in the site map. field enabled on the user
detail page
Note: Site map links are automatically included in navigation menus and breadcrumbs.
AND
However, you can’t set a site map link as a custom root node in a breadcrumb.
Site administrator or
designer role assigned
SEE ALSO: at the site level
Adding Breadcrumb Navigation to Pages
Adding a Navigation Menu
About the Site Map and Page Hierarchy

1124
Extend Salesforce with Clicks, Not Code Site.com

Adding Breadcrumb Navigation to Pages

Add a Breadcrumb page element to your page to help users navigate through your site and show
EDITIONS
the page’s location in the site hierarchy.
Breadcrumb navigation is based on the pages and links in the site map and usually supplements Available in: Salesforce
menu navigation. You can hide a page in menus, breadcrumbs, and the site map by selecting the Classic (not available in all
Hide Page checkbox found on the Properties pane for each page. This setting also prevents orgs)
website visitors from accessing the page’s direct URL. By default, all pages are visible. Available for purchase in:
Tip: To save time and effort, add a Breadcrumb page element to a page template to Enterprise, Performance,
automatically include it on every template-based site page. The breadcrumb on each derived and Unlimited Editions
page dynamically updates based on its location in your site map. Available (with limitations)
in: Developer Edition
1. Open the page or page template that you want to add the breadcrumb element to.
2. Drag a Breadcrumb from the Page Elements pane onto the page.
3. In the Properties pane, under Root, specify a custom root node for the breadcrumb. By default, USER PERMISSIONS
the root value is set to None, which builds the breadcrumb structure based on the page’s
To build, edit, and manage
location in the site map. Site.com sites:
• Select Home Page to set the site’s home page as the first item in the breadcrumb. To • Site.com
find out how to set a site’s home page, see Configuring Site Properties. Publisher User
field enabled on the user
• Select a specific site page to set it as the first item in the breadcrumb.
detail page
Note: You can’t set a site map link as a custom root node in a breadcrumb. AND
Site administrator or
4. In the Properties pane, under Separator, you can customize the separator used between designer role assigned
breadcrumb nodes. at the site level
By default, the separator is >. However, you can change it to another text symbol or insert HTML
code for an image in your site, such as <img src='/separatorimage.jpg'/>.

5. To style the breadcrumb:

a. Click the Style pane and ensure Class is selected.
b. Choose an option from the Style drop-down list.
c. Adjust the values in the Visual tab as desired.

SEE ALSO:
Adding a Navigation Menu
Editing and Working With Site.com Page Elements

1125
Extend Salesforce with Clicks, Not Code Site.com

Adding a Navigation Menu

By default, when you create a menu, it’s generated from the pages and site map links in the Site
EDITIONS
Map folder in the Site Pages view. However, you can also create a menu that’s generated from the
pages in the Landing Pages folder or from the child or sibling pages of a site page. Available in: Salesforce
1. Arrange site pages and site map links in the Site Map folder or the Landing Pages folder in the Classic (not available in all
order you want them to appear in the menu by dragging them to the desired location. Drag a orgs)
page or site map link onto another page or link to make it a child of that item. Drag pages or
Available for purchase in:
links into the Landing Pages folder to exclude them from the site map. Enterprise, Performance,
Tip: If you can’t see the Site Map folder in the Site Pages view on the Overview tab, click and Unlimited Editions

. Available (with limitations)

in: Developer Edition
2. Open the page template or site page that you want to add the navigation menu to.
3. Drag a Menu from the Page Elements pane onto the page.
USER PERMISSIONS
4. In the Properties pane, under Menu Source, select the pages that you want to use for the menu.
By default, the Site Map folder is used to create the menu. Any site map link in the applicable To build, edit, and manage
Site.com sites:
hierarchy also shows up in your menu.
• Site.com
• Select Landing Pages to create the menu from the pages in the Landing Pages folder. Publisher User
• Select Child Pages to create the menu from the current page’s child pages. field enabled on the user
detail page
• Select Sibling Pages to create the menu from all of the pages that share the same
parent as the current page. AND

• Select a specific site page to create the menu from just its child pages. Site administrator or
designer role assigned
Note: If you add a menu element to a page template, the menu doesn’t display correctly at the site level
in the template if you select Child Pages or Sibling Pages as the menu
source, because page templates aren’t part of the site map hierarchy. However, the menu
appears as expected on site pages based on the page template.

5. To alter the appearance of the menu, you can select a different theme from the Theme Name drop-down list. For example, to create
a drop-down menu, select Horizontal Drop-down. You can modify the style of any theme to suit your needs.
6. To change the name of a page in the menu, open the associated page and update its Navigation Name field in the Properties
pane. Navigation names can include spaces and special characters.
Alternatively, to change the name of a site map link in your menu, hover over the link in the Site Pages view on the Overview tab,
click Edit, and update the name.

Tip:
• When you add a new page or site map link, update a page’s Navigation Name property, or rearrange pages or links, the
menu updates automatically to reflect the changes.
• To automatically include a menu on every site page, add the menu to a page template and base the site pages on it.

1126
Extend Salesforce with Clicks, Not Code Site.com

• You can hide a page in menus, breadcrumbs, and the site map by selecting the Hide Page checkbox found on the Properties
pane for each page. This setting also prevents website visitors from accessing the page’s direct URL. By default, all pages are
visible.

SEE ALSO:
Styling Navigation Menus
About the Site Map and Page Hierarchy
Adding Site.com Page Elements

Styling Navigation Menus

Navigation menus are styled using CSS themes that you can customize to match the design of your
EDITIONS
website. When you add a navigation menu to a page, it uses a default theme to control its
appearance. Choose from other existing themes in the Theme Name drop-down list in the Properties Available in: Salesforce
pane. Classic (not available in all
Alternatively, to customize a theme to suit your needs: orgs)

1. Select the navigation menu on the page. Available for purchase in:
2. Select a theme to use as a base in the Theme Name drop-down list in the Properties pane. Use Enterprise, Performance,
and Unlimited Editions
a theme that most closely matches your site design or select Blank to start with a completely
blank theme. Available (with limitations)
in: Developer Edition
3. Open the Style pane and ensure Class is selected.
4. In the Style drop-down list, select the part of the menu that you want to style. When you select
an item, it's highlighted for a few seconds, so you can easily see which part you're styling. USER PERMISSIONS
Tip: If you're familiar with CSS, you can also modify the style of the menu in the site's To build, edit, and manage
style sheet. Site.com sites:
• Site.com
5. To style the selected menu item, use the Style pane properties. Your changes are immediately Publisher User
reflected in the menu. field enabled on the user
detail page
6. Repeat as required for each part of the menu.
AND

SEE ALSO: Site administrator or

designer role assigned
Adding a Navigation Menu at the site level
About the Site Map and Page Hierarchy

1127
Extend Salesforce with Clicks, Not Code Site.com

Adding Custom HTML Attributes

You can add custom HTML attributes to pages and page elements, which are rendered on the
EDITIONS
HTML tag of the page element. For example, this is useful when working with third-party frameworks
that render page elements differently based on certain attributes. Available in: Salesforce
When the page is open: Classic (not available in all
orgs)
1. Select the relevant page or page element in the Page Structure pane.
2. Available for purchase in:
In the HTML Attributes section of the Properties pane, click . Enterprise, Performance,
3. Enter a name and value for the HTML attribute. and Unlimited Editions

4. Click Save. Available (with limitations)

in: Developer Edition
To delete an HTML attribute, select it and click .

To change the order in which an HTML attribute is rendered, select it and click or . USER PERMISSIONS

To build, edit, and manage

SEE ALSO: Site.com sites:
Changing a Page Element’s HTML Tag • Site.com
Publisher User
HTML5 Semantic Page-Layout Tags field enabled on the user
Changing a Page’s Doctype Property detail page
AND
Site administrator or
designer role assigned
at the site level

1128
Extend Salesforce with Clicks, Not Code Site.com

Changing a Page Element’s HTML Tag

By default, panels, data repeaters, data elements, custom code, and content blocks are each defined
EDITIONS
as a div, but you can change this to any other HTML tag using the HTML Tag property. This
gives you greater flexibility and control over how the page element is displayed on the page. Available in: Salesforce
Warning: The HTML Tag property provides a powerful way to control how page elements Classic (not available in all
orgs)
are displayed. However, if you change a page element’s HTML tag, you may generate invalid
HTML. Before publishing any changes, test the page thoroughly. Available for purchase in:
To redefine a panel, data repeater, data element, custom code, or content block: Enterprise, Performance,
and Unlimited Editions
1. Select the element on the page.
Available (with limitations)
2. In the HTML Tag field in the Properties pane, start typing the tag name. in: Developer Edition
3. In the auto-complete list that appears, select the relevant HTML tag. Alternatively, you can
define your own HTML tag—for example, if you’re working with a JavaScript library or if new
HTML5 tags are introduced in the future. You can also remove the HTML tag on a panel, data USER PERMISSIONS
repeater, data element, custom code, or content block to disable its ID, class, or inline styles.
To edit page element
Note: The following tags aren't included in the auto-complete list: properties:
• Site.com
• base Publisher User
• body field enabled on the user
detail page
• doctype
AND
• head
Site administrator or
• html designer role assigned
• meta in Site.com Studio
• style
• title

SEE ALSO:
HTML5 Semantic Page-Layout Tags
Adding Custom HTML Attributes

HTML5 Semantic Page-Layout Tags

HTML5 defines several semantic page-layout tags that describe the content they contain. These
EDITIONS
tags make it easier for search engines and screen readers to read and organize your content.
By default, several page elements are defined as a div, including panels, data repeaters, data Available in: Salesforce
elements, content blocks, and custom code. Using a page element’s HTML Tag property, you Classic (not available in all
can change the tag to a semantic HTML5 block tags, such as: orgs)

Available for purchase in:

Option Description Enterprise, Performance,
Article A section containing an independent item of and Unlimited Editions
content, such as a magazine article or a forum Available (with limitations)
post. in: Developer Edition

1129
Extend Salesforce with Clicks, Not Code Site.com

Option Description
Aside A section containing content that’s only superficially related to the
main page content, such as a sidebar or advertising.

Details A section containing additional details that the user can view or
hide using an interactive widget. It can also include a summary
section.

Header A section containing an introduction, or a group of navigation

elements.

Footer A footer section for the page or parent section. It typically contains
information about the parent section and appears at the end of
the section.

Nav A section that contains navigation links.

Section A generic section of the page.

Summary A summary or caption section for a details section.

Tip: If you use a HTML5 semantic tag, it’s good practice to also change the page’s doctype to HTML5.

SEE ALSO:
Changing a Page Element’s HTML Tag
Adding Custom HTML Attributes

1130
Extend Salesforce with Clicks, Not Code Site.com

Setting Up the Contributor’s Studio View

Control what your contributors can do in Site.com Studio.
EDITIONS
The contributor’s Site.com Studio view lets users browse and update website content. To enable
contributors to edit the site’s content, however, you must first create template-based pages with Available in: Salesforce
editable areas and enable several properties. Classic (not available in all
orgs)
To enable your contributors to:
• Edit the text on a page, create template-based pages with editable content blocks Available for purchase in:
Enterprise, Performance,
• Add content blocks to the page, create template-based pages with editable panels and Unlimited Editions
• Create site pages based on a page template, select Available to Contributors in the Properties
Available (with limitations)
pane when the page template is open in: Developer Edition
• Add widgets to the page, select Available to Contributors in the Widgets view on the Overview
tab or in the Properties pane when the widget is open
• Update the appearance of pages and widgets, set up branding properties USER PERMISSIONS
To ensure that the contributor’s Site.com Studio view is set up correctly, click View Studio as a To build, edit, and manage
Contributor in the site’s pull-down menu (on the top toolbar). To exit, click Return to My Studio Site.com sites:
View. • Site.com
Publisher User
The contributor’s view is not available by default for Site.com Community sites. However, you can
field enabled on the user
use a Site.com Contributor license to grant contributor access to a specific user. See About Feature detail page
Licenses in the Site.com help for details. Alternatively, a user can preview the Site.com Community
AND
site as a contributor by appending ?iscontrib to the site’s URL. For example:
MyDomainName.builder.salesforce-experience.com/?iscontrib Site administrator or
designer role assigned
Note: If you’re not using enhanced domains, your org’s Salesforce Sites URL is different. For at the site level
details, see My Domain URL Formats in Salesforce Help.

SEE ALSO:
Creating Site.com Page Templates
Creating Widgets
Site Branding Overview
Understanding the Contributor’s Page Editing View
My Domain URL Formats

Cascading Style Sheets Overview

Cascading Style Sheets (CSS) provide a flexible way to add style to the pages of your website. This
EDITIONS
collection of formatting rules governs the appearance of your pages, and lets you define the fonts,
colors, layout, and other presentation features. Available in: Salesforce
By using CSS to control your fonts, you can ensure greater consistency in the appearance and layout Classic (not available in all
of your pages in multiple browsers. Some of the many text properties that CSS lets you control orgs)
include font family and size, text and background color, text formatting, and link color.
Available for purchase in:
Using CSS, you can also position, add color to, float text around, and set margins and borders for Enterprise, Performance,
block-level elements. A block-level element is a standalone piece of content that's visually formatted and Unlimited Editions
as a block. For example, content blocks (which are equivalent to p tags) and panels (which are the Available (with limitations)
same as div tags) are both block-level elements. in: Developer Edition

1131
Extend Salesforce with Clicks, Not Code Site.com

Site.com supports CSS3, which is the latest specification for CSS.

About Inline Styles Versus Style Sheets

In Site.com Studio, you can:
• Apply styles directly to a selected page or page element using the Inline option in the Style pane ( ). Inline styles apply only to
the selected item.
• Add style items such as CSS classes or IDs to a style sheet, and apply the style items to the selected page or page element. This
approach separates the content (your web pages) from the presentation (the style sheet).
If you’re not familiar with CSS, you’ll probably find the inline option the easiest to use and understand. However, inline styles lose many
of the advantages of style sheets because they mix content with presentation—the inline style is only applied to that individual element.
If you need to update the style of your site, you have to update the style properties of every affected page and page element.
By contrast, although style sheets may be more difficult to understand at first, they enable you to make site-wide changes from one
convenient location. When you update a style item in your style sheet, it immediately updates the style of every page or page element
that uses it.
It’s worth taking the time to become familiar with CSS because it:
• Saves you time and effort when building and designing your site
• Produces cleaner, more consistent site designs
• Simplifies navigation for people with accessibility issues (such as site visitors using screen readers)
For more information about using CSS and creating style sheets, go to the World Wide Web Consortium (W3C) at
www.w3.org/Style/CSS. There are also many tutorials available on the Internet that provide in-depth CSS training.

About CSS Classes and IDs

When you use style sheets to style your site, you can redefine the formatting of HTML tags such as body or h1. You can also create
CSS classes and IDs to define the style of particular elements, such as headers or repeating content. A CSS class lets you define and apply
style properties to many elements on a page, whereas a CSS ID is ideal for targeting a single item on a page. For example, in a page's
structure, IDs are often used to define the header and footer areas, as each page has only one header or footer, but classes are used to
define repeating page elements, such as a blog post.

Best Practices
• Include a CSS reset in your style sheet to reset all style items to a baseline value. This helps avoid cross-browser differences due to
their built-in default style settings.
• Use CSS classes and IDs instead of inline styles wherever possible. This promotes the separation of presentation and content, and
makes it easier to updates the site's styles.
• Use IDs when there is only one occurrence per page. Once you've used the ID, you can't use it again on that page. Use classes when
there are one or more occurrences per page.
• Use groups to organize your CSS logically and make it easier to maintain your style sheet.
• If you’re using CSS3, ensure you preview and test your site in each browser that you want it to support, because some browsers
haven't yet fully implemented CSS3 features.

Using the Style Pane

Style Pane Properties

1132
Extend Salesforce with Clicks, Not Code Site.com

Understanding the Style Sheet View in Site.com

Creating and Using CSS Style Sheets
Creating Style Sheet Items and Groups
Using CSS Reset

SEE ALSO:
Using the Style Pane
Understanding the Style Sheet View in Site.com
Creating and Using CSS Style Sheets

Using the Style Pane

The Style pane is a visual CSS editor that lets you modify style properties, such as the background
EDITIONS
color, font size, and border style, as you work with pages and page elements. If you're using CSS
classes or IDs to style your pages, you can modify or create style items directly from the Style pane, Available in: Salesforce
rather than opening the style sheet. Classic (not available in all
To apply a style to a selected page or page item: orgs)

1. Open the Style pane ( ). Available for purchase in:

Enterprise, Performance,
2. To apply: and Unlimited Editions
• An inline style, select Inline. Inline styles affect the selected item only and aren't included Available (with limitations)
in a style sheet. in: Developer Edition
• A CSS class, select Class and start typing the name. If the class already exists in your style
sheet, select it in the list that appears. To create a new class, type the name, select it, and
click Yes to add it to the style sheet. USER PERMISSIONS
• To build, edit, and manage
A CSS ID, select ID and select it in the drop-down list. To create a new ID, click , enter
Site.com sites:
the ID name, and click .
• Site.com
Menu page elements have several components, which you can style individually by selecting Publisher User
your preferences in the Style drop-down list that appears. field enabled on the user
detail page
3. In the Visual tab, apply style properties as appropriate. Alternatively, in the Code tab, you can AND
type your CSS styles directly and click Apply.
Site administrator or
Tip: To view the style properties associated with a selected page or page element, open the designer role assigned
Code tab of the Style pane. To remove the style properties, click Clear. at the site level

SEE ALSO:
Creating Style Sheet Items and Groups
Creating and Using CSS Style Sheets
Cascading Style Sheets Overview

1133
Extend Salesforce with Clicks, Not Code Site.com

Style Pane Properties

The Style pane is a visual CSS editor that lets you modify style properties, such as the background
EDITIONS
color, font size, and border style, as you work with pages and page elements.
Available in: Salesforce
The Background Section Classic (not available in all
orgs)
Property Description Available for purchase in:
Background Color Sets the element's background color. Click the color box and use Enterprise, Performance,
and Unlimited Editions
the color picker to select a color, or enter a specific hexadecimal
code in the text box. You can also choose from a list of colors in Available (with limitations)
the Background Color drop-down list. in: Developer Edition

Background Image Adds a background image to the element. Click URL and enter
the image URL, or click to select an imported image.

Background Repeat Tiles the element's background image.

•
ensures that only one copy of the image appears.
•
repeats the image horizontally.
•
repeats the image vertically.
•
tiles the image both horizontally and vertically.

Position Specifies the position of the element's background image.

• To set the horizontal position of the background image, enter
a value in the X text box and select a unit of measurement.
Alternatively, select Left or Right in the drop-down list.
• To set the vertical position of the background image, enter
a value in the Y text box and select a unit of measurement.
Alternatively, select Top or Bottom in the drop-down list.

Cursor Sets the cursor type, such as crosshair or pointer.

The Font & Color Section

Property Description
Font Sets the font family of the selected element.

Color Sets the font color. Click the color box and use the color picker to select a color, or enter
a specific hexadecimal code in the text box. You can also choose from a list of colors in
the Color drop-down list.

1134
Extend Salesforce with Clicks, Not Code Site.com

Property Description
Size Sets the font size. Enter a value in the Size text box and select a unit of measurement
such as em, point, or %. Alternatively, select a predefined value such as XX-Small. Select
Inherit to use the same font size as the parent element (for example, the page or panel).

Tip: Use relative sizes such as em or a percentage to enable your end users to
resize the font size in their Web browsers.

Style Formats the element's font style.

•
makes the font bold.
•
makes the font bold and italic.
•
makes the font italic.
• None removes existing styles.

Font Variant Specifies whether to render the font as small capitals.

Line Height Modifies the amount of space between lines of text. Enter a value in the text box and
select a unit of measurement such as pixels, percentage, or em. Select Inherit to use the
same line height as the parent page element.

Text Decoration Applies decorative effects to the element's text. For example, you could remove the
underline that usually appears under hyperlinks, which is a standard CSS rule that's built
in to most Web browsers.
•
underlines the text.
•
applies strikethrough formatting.
•
displays a line over the text.
• None removes existing text decoration.

Align Aligns the text of the selected element.

•
aligns the text to the left.
•
aligns the text to the right.
•
centers the text.
•
aligns the text with both the left and right margins.

Case Changes the capitalization of the element's text.

•
capitalizes the first character of each word.
•
capitalizes all characters.
•
lowercases all characters.
• None removes existing capitalization formatting.

1135
Extend Salesforce with Clicks, Not Code Site.com

Property Description
Text Indent Indents the first line of text of the selected page element. Enter a value in the text box
and select a unit of measurement. Select Inherit to use the same indentation as the parent
page element.

White Space Controls how white spaces such as spaces, tabs, and hard returns are handled inside an
element.

The Layout Section

Property Description
Positioning Positions page elements outside the normal flow of the document. Usually, elements on
a page are rendered in Web browsers in the order they appear in the document. Block
elements such as p tags and div tags appear one beneath the other, whereas inline
elements such as em, strong, and span tags are rendered next to text or each other.
• Absolute positions the content using the settings in the Top, Bottom, Left, and
Right text boxes.
• Relative renders the page element in the normal layout flow, but moves the element
relative to its normal position depending on the values in the Top, Bottom, Left,
and Right text boxes. For example, if you set an element's left position to 20 pixels,
the page element will be positioned 20 pixels further to the left.

Display Overrides a page element's default layout behavior. For example, you can hide page
elements, make block elements render inline, or make inline elements render as blocks.
• None hides the page element.
• Block displays the page element as a block-level page element, with a line break
before and after the element.
• Inline, which is the default setting, displays the page element as an inline page element
without a line break before or after the element.
• Inline-block renders the page element as an inline rectangle, but with content that
behaves as if it's inside a block element.

Position When used in conjunction with the Absolute or Relative positioning options, these four
properties place page elements outside the normal flow of the document. Enter a value
in the text boxes as appropriate and select a unit of measurement in the respective
drop-down lists.
• Top sets how far the top edge of an element is above or below the top edge of the
parent element.
• Bottom determines how far the bottom edge of an element is above or below the
bottom edge of the parent element.
• Right sets how far the top edge of an element is to the right or left of the right edge
of the parent element.
• Left defines how far the left edge of an element is to the right or left of the left edge
of the parent element.

1136
Extend Salesforce with Clicks, Not Code Site.com

Property Description
Z-index Specifies the order in which elements overlap each other when they need to be rendered
in the same space. An element with a greater z-index value covers an element with a
lower value. The default value is 0.

Click and to increase and decrease the z-index, or enter a value in the text box.

Float Floats a page element to the left or right so that subsequent elements—text for
example—wrap around the floating page element.
•
floats the page element to the left.
•
floats the page element to the right.
• None removes an existing float setting.

Clear Specifies whether the selected page element allows floating page elements beside it.
•
moves the page element below any floating page element on its left.
•
moves the page element below any floating page element on its right.
•
moves the page element below floating page elements on either side.
• None removes existing float settings.

Visibility Specifies whether the selected page element is visible.

• Visible is the default value.
• Hidden hides the page element and renders an invisible rectangle in its place.
• Collapse is used to hide table elements. (For other page elements, it has the same
result as hidden.)

Note: Invisible page elements still occupy the same space in the page's layout.

Overflow Specifies whether the content of a page element should be clipped when it overflows
its area.
• Visible does not clip the content.
• Hidden clips the content.
• Scroll clips the content, but provides scroll bars so that users can view the remaining
content.
• Auto is dependent on the browser, but should display a scroll bar to view the rest of
the content.

1137
Extend Salesforce with Clicks, Not Code Site.com

The Dimensions Section

Property Description
Width Sets the width of the selected page element. Enter a value in the Width text box and
select a unit of measurement. Select Inherit to use the width of the parent page element.

Height Sets the height of the selected page element. Enter a value in the Height text box and
select a unit of measurement. Select Inherit to use the height of the parent page element.

Margins Sets the width of the page element's margin, which is the space between its border and
outer edge. Set the margins for all four sides by entering a value in the All text box, or
add margins to the top, right, bottom, or left sides as required.

Padding Sets the width of the page element's padding, which is the space between its content
and border. Set the padding for all four sides by entering a value in the All text box, or
add padding to the top, right, bottom, or left sides as required.

The Borders Section

Property Description
Type Specifies whether to set border properties for each side separately or for all four sides.

Style Sets the border's style such as dashed, dotted, or double.

Color Sets the border's color. Click the color box and use the color picker to select a color, or
enter a specific hexadecimal code in the text box. You can also choose from a list of colors
in the Color drop-down list.

Thickness Specifies the border's thickness. Enter a value in the Thickness text box and select a
unit of measurement. Alternatively, select Thin, Medium, or Thick.

The Tables Section

Property Description
Border Collapse When designing tables:
• Collapse uses a common border between cells
• Separate gives each cell its own border

Horizontal Spacing Sets the horizontal distance that separates cell borders. Enter a value in the text box and
select a unit of measurement. This value is used only if Border Collapse is set to Separate.

Vertical Spacing Sets the vertical spacing that separates cell borders. Enter a value in the text box and
select a unit of measurement. This value is only used if Border Collapse is set to Separate.

SEE ALSO:
Using the Style Pane

1138
Extend Salesforce with Clicks, Not Code Site.com

Understanding the Style Sheet View in Site.com

When working with style sheets, you can add style items, organize them into groups, and edit the
EDITIONS
CSS code directly. Open a style sheet on the Overview tab by double-clicking it or hovering over it
and clicking > Edit. The style sheet opens as a new tab. Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To build, edit, and manage

Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

• Using the toolbar (1), you can import a style sheet and edit the style sheet’s CSS code directly.
• Using the style sheet pane (2), you can:
– Create style items and groups

1139
Extend Salesforce with Clicks, Not Code Site.com

– Preview, edit, and delete style items

– Move style items and groups by dragging them to the correct location
– Add a CSS reset

• Using the Style Preview section (3), you can preview and manually edit a selected style item.

Note: You can’t preview at-rules, such as @media or @font-face, in the Style Preview section.

• Using the visual CSS editor (4), you can define the CSS properties for the selected style item.

SEE ALSO:
Creating and Using CSS Style Sheets
Cascading Style Sheets Overview

Creating and Using CSS Style Sheets

A default style sheet called “Site Style Sheet” is included with every site you create. However, if
EDITIONS
you're familiar with CSS and need multiple style sheets, you can create new ones to use in your site.
To create a style sheet: Available in: Salesforce
Classic (not available in all
1. Click Style Sheets > New on the Overview tab. Alternatively, click New Style Sheet in the
orgs)
Style Sheets view.
2. Enter a name for the style sheet. Available for purchase in:
Enterprise, Performance,
3. Click Apply. The style sheet opens. and Unlimited Editions
4. Add style items and groups to the style sheet. Available (with limitations)
in: Developer Edition
Note:
• Style sheet names can only contain alphanumeric characters, hyphens, colons, and
underscores. USER PERMISSIONS
• You can also import a CSS file to use in your site.
To build, edit, and manage
After you create a new style sheet, you must attach it to a page to apply its styles to the page. Site.com sites:
• Site.com
To attach a style sheet to a page: Publisher User
1. Select the page in the Page Structure pane ( field enabled on the user
). detail page
2. AND
In the Style Sheets section of the Properties pane ( ), click .
Site administrator or
3. Select the style sheet in the list that appears.
designer role assigned
4. at the site level
Attach the style sheet to the page by clicking beside the drop-down list.

Tip: If you used a page template to create your site pages, the quickest way to include the
new style sheet on every pages is to attach it to the template. This automatically includes a
reference to the style sheet in every page that's based on the template.

SEE ALSO:
Understanding the Style Sheet View in Site.com
Cascading Style Sheets Overview

1140
Extend Salesforce with Clicks, Not Code Site.com

Creating Style Sheet Items and Groups

When adding style items to style sheets, you can define CSS classes and IDs, or you can redefine
EDITIONS
the formatting of HTML tags such as body or h1. When you change the CSS style of an HTML
tag, anything formatted with that tag is immediately updated. Available in: Salesforce
Classic (not available in all
Creating Style Items orgs)

To open a style sheet, double-click it in the Style Sheets view of the Overview tab, or hover over it Available for purchase in:
and click > Edit. Enterprise, Performance,
and Unlimited Editions
If you're very familiar with CSS and prefer coding by hand, click Edit Style Sheet Code to edit the
style sheet directly using the CSS editor. Additionally, to add at-rules (for example, @media), you Available (with limitations)
must edit the style sheet directly. in: Developer Edition

Alternatively:
1. Select the style sheet and click > Insert Style Item. USER PERMISSIONS
2. Enter the name of the style item: To build, edit, and manage
Site.com sites:
• To redefine the default formatting of a specific HTML tag, enter the HTML tag name—for
• Site.com
example, body or h1.
Publisher User
• To create a CSS class, enter the class name and ensure that you include a period before field enabled on the user
it—for example, .classname. detail page
• To create a CSS ID, enter the ID name preceded by #—for example, #contentID. AND
Site administrator or
3. Click Apply.
designer role assigned
4. Add style definitions by either: at the site level
• Setting style properties in the visual style editor on the right
• Typing CSS styles in the text box in the Style Preview section and clicking Save

As you modify the definition of a selected style item, you can see how your changes appear in the Style Preview section.

Tip:
• A class name must begin with a period or it will not be recognized as a CSS class.
• An ID name must begin with # or it will not be recognized as a CSS ID.
• Use IDs when there is only one occurrence per page. Once you've used the ID, you can't use it again on that page. Use classes
when there are one or more occurrences per page.
• Class and ID names can contain alphanumeric characters, hyphens, and underscores only, and can't begin with a number or
include spaces.

Creating Style Groups

Use groups to organize your CSS logically. This makes it easier to locate and maintain styles.
When the style sheet is open:
1. Select the style sheet and click > Insert Style Group.
2. Enter a name for the group and click Apply.
3. To add a new style to the group, select the group and click > Insert Style Item. To add an existing style to the group, drag it
onto the folder icon.

1141
Extend Salesforce with Clicks, Not Code Site.com

Assigning Style Items

After you've created styles, you can assign them to the pages and pages elements of your site.
To assign a class to a page or page element, select it and either:
• Type the class name in the Class field of the Properties pane ( ).
• Select Class in the Style pane ( ), start typing the name, and select it in the list that appears.
To assign an ID to a page or page element, either:
• Type the ID name in the ID field in the Properties pane ( ).
• Select ID in the Style pane ( ) and select it in the drop-down list.

SEE ALSO:
Creating and Using CSS Style Sheets
Understanding the Style Sheet View in Site.com
Cascading Style Sheets Overview

Using CSS Reset

Every browser has set presentation defaults, but unfortunately they aren't standardized across all
EDITIONS
browser types. This means that when you use CSS to style your site, it may not render as expected
when you view it in different browsers. For example, browsers differ in how they display: Available in: Salesforce
• Unordered and ordered lists Classic (not available in all
orgs)
• Top and bottom margins for headings
• Indentation distances Available for purchase in:
Enterprise, Performance,
• Default line-heights
and Unlimited Editions
A CSS reset cancels the differences between browsers to control how browser elements are presented
Available (with limitations)
to the end user. You can either use Site.com's CSS reset, or you can add your own CSS reset code.
in: Developer Edition
To use Site.com's CSS reset:
1. In the Style Sheets view on the Overview tab, open the style sheet by double-clicking it, or
hovering over it and clicking > Edit.
USER PERMISSIONS

2. Click > Insert CSS Reset. To build, edit, and manage

Site.com sites:
3. Ensure the CSS reset is positioned at the top of the style sheet. To move it, drag it to the correct
• Site.com
location in the pane on the left. Publisher User
To add your own CSS reset code: field enabled on the user
detail page
1. In the Style Sheets view on the Overview tab, open the style sheet by double-clicking it, or
AND
hovering over it and clicking > Edit.
Site administrator or
2. Click Edit Style Sheet Code to open the CSS editor. designer role assigned
3. Paste the code at the top of the style sheet code. at the site level

1142
Extend Salesforce with Clicks, Not Code Site.com

4. Click Save and Close.

SEE ALSO:
Creating and Using CSS Style Sheets
Cascading Style Sheets Overview

Site Branding Overview

Branding provides a flexible way for you to define different aspects of your website’s brand. Once
EDITIONS
branding properties are defined, your editors can easily customize everything in one centralized
place, the Branding Editor. When your website editors customize the properties, they get a preview Available in: Salesforce
of their branding changes immediately. Classic (not available in all
By adding branding properties to your website, page templates, or widgets, you can easily define orgs)
and change those aspects of your website’s brand without needing to edit your Cascading Style
Available for purchase in:
Sheet. Enterprise, Performance,
Here are examples of aspects that you might define that are related to your website’s brand: and Unlimited Editions
• The website’s background, page, or link colors Available (with limitations)
in: Developer Edition
• Font size and color
• The logo or header background image
• The thickness and color of lines
To use branding in your website, you must:
1. Define the parts of your site that make up your brand by creating a branding property for each aspect such as background color,
logo, and fonts. You complete this task from Branding Properties within Site Configuration.
2. Use expression language syntax to replace the current definitions for these properties within your Cascading Style Sheets with the
new branding properties.
3. Use the Branding Editor to customize the properties and preview how your website will look.
The branding properties can also be accessed by using expression language syntax directly from within a custom code block or content
block.

Creating Branding Properties

With branding , you can quickly create style properties that can be reused by editors of your site.
Setting Up Branding Properties
After you create branding properties, the next step is to reference them as expressions in your Cascading Style Sheets (CSS) or
Site.com page elements such as content blocks or custom code elements.
Using the Branding Editor
The Branding Editor provides a centralized place to customize and then preview the changes that you make to the branding properties
in your site.

SEE ALSO:
Creating Branding Properties
Setting Up Branding Properties
Using the Branding Editor

1143
Extend Salesforce with Clicks, Not Code Site.com

Creating Branding Properties

With branding , you can quickly create style properties that can be reused by editors of your site.
EDITIONS
When creating your branding properties, you can organize properties into multiple sections to
make them easier to find in the Branding Editor. You can also organize your properties within Available in: Salesforce
sections. Classic (not available in all
orgs)
• Order properties within sections in a logical manner. For example, organize them alphabetically.
• Order sections and properties by dragging and dropping them within the Branding Properties Available for purchase in:
view. Enterprise, Performance,
and Unlimited Editions
1. From within your site, click Site Configuration > Branding Properties.
The Branding Properties editor appears. Available (with limitations)
in: Developer Edition
2.
Click .
3. Enter a name for the property in the Label field. USER PERMISSIONS
The expression name is filled in automatically. The expression name is used in style sheets and
To build, edit, and manage
code blocks.
Site.com sites:
4. Choose a type. • Site.com
Publisher User
5. Set the default value.
field enabled on the user
6. To make the property required, click Required. detail page
AND
Hover over any property and use the menu to edit or delete it. You can double-click any
Site administrator or
section name to edit it.
designer role assigned
at the site level
SEE ALSO:
To edit only content in
Site Branding Overview Site.com sites:
Custom Property Types • Site.com
Setting Up Branding Properties Contributor User

Using the Branding Editor AND

Contributor role
assigned at the site level

1144
Extend Salesforce with Clicks, Not Code Site.com

Setting Up Branding Properties

After you create branding properties, the next step is to reference them as expressions in your
EDITIONS
Cascading Style Sheets (CSS) or Site.com page elements such as content blocks or custom code
elements. Available in: Salesforce
The expression syntax for branding properties is {!Site.branding-property-name}. Classic (not available in all
For example, if you create a color property with the name HeaderColor, you can insert the property orgs)
into a CSS or code block by typing {!Site.HeaderColor}. Available for purchase in:
Note: The expression names are case-sensitive! Enterprise, Performance,
and Unlimited Editions
1. Open your CSS or code block. Available (with limitations)
2. Locate the place where you want to insert the expression. in: Developer Edition

3. Type {!
and a drop-down list of available properties appears. USER PERMISSIONS
4. Select the property and double-click to enter it on the page.
To build, edit, and manage
Example: For example, if part of your website’s brand is to use blue for the background of Site.com sites:
the header section,you would normally statically set the color’s HEX value in your CSS rules. • Site.com
Publisher User
.site-header { field enabled on the user
background-color: #3793DD; detail page
}
AND
With branding, you can create a property that maps directly to the HEX color and then use Site administrator or
the property’s expression name in your CSS. designer role assigned
at the site level
.site-header {
background-color: {!Site.HeaderColor}; To edit only content in
} Site.com sites:
• Site.com
Now the color can be easily changed by any of your site editors by using the Branding Editor
Contributor User
instead of editing the CSS.
AND
Contributor role
SEE ALSO:
assigned at the site level
Site Branding Overview
Creating Branding Properties
Using the Branding Editor

1145
Extend Salesforce with Clicks, Not Code Site.com

Using the Branding Editor

The Branding Editor provides a centralized place to customize and then preview the changes that
EDITIONS
you make to the branding properties in your site.
The Branding Editor includes two areas: Available in: Salesforce
Classic (not available in all
• The editor palette, on the left side, contains all of the branding properties that you can edit.
orgs)
• The preview area on the right side shows a live preview of how your website will appear after
you change a style. Available for purchase in:
Enterprise, Performance,
1. Open the page that you want to edit. and Unlimited Editions
2. Available (with limitations)
Click .
in: Developer Edition
3. From the left pane, select the style property that you want to edit.
Your results appear immediately in the right pane.
USER PERMISSIONS
SEE ALSO:
To build, edit, and manage
Site Branding Overview Site.com sites:
Creating Branding Properties • Site.com
Publisher User
Setting Up Branding Properties
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

To edit only content in

Site.com sites:
• Site.com
Contributor User
AND
Contributor role
assigned at the site level

Custom Site Properties Overview

With custom site properties, you can define and store frequently occurring content on your site.
EDITIONS
For example, you can store your address and phone number as a custom property so that it can be
reused by anyone who is editing your site. You can apply stored properties to pages, headers and Available in: Salesforce
footers, and widgets quickly by using expression language syntax. Classic (not available in all
To use custom properties in your website, you must: orgs)

1. Define the custom property. You complete this task from Custom Properties within Site Available for purchase in:
Configuration. Enterprise, Performance,
and Unlimited Editions
2. Use expression language syntax to replace the current definitions for these properties within
your Cascading Style Sheets or custom code blocks. Available (with limitations)
in: Developer Edition

1146
Extend Salesforce with Clicks, Not Code Site.com

After you create a new property and specify its value and type, you can access the property in custom code or content blocks by using
expressions. Expressions are placeholders for data that will be replaced with the custom property when the page loads.

Creating Custom Site Properties

You can quickly create Custom Properties that can be reused by editors of your site.
Setting Up Custom Properties
You can use custom properties in your website by using expression language syntax within a style sheet, code block, widget, or the
HTML page editor.
Custom Properties for Page Templates or Widgets Overview
When you create a page template or a widget, you can add custom properties to it and specify the value and type of each property
to achieve greater flexibility over how templates and widgets are reused.
Adding Custom Properties to Page Templates or Widgets
When you create a page template or a widget, you can add custom properties to it and specify the value and type of each property.
Custom Property Types
Property types are available when designers or site administrators create site branding properties, site custom properties, widget
branding properties, and widget custom properties.

SEE ALSO:
Creating Custom Site Properties
Setting Up Custom Properties

1147
Extend Salesforce with Clicks, Not Code Site.com

Creating Custom Site Properties

You can quickly create Custom Properties that can be reused by editors of your site.
EDITIONS
When creating your custom properties, you’ll probably want to organize them logically.
Available in: Salesforce
• Organize properties into multiple sections to make them easier to manage and easy to find.
Classic (not available in all
• Order properties within sections in a logical manner. For example, organize them alphabetically. orgs)
• Order sections and properties by dragging and dropping them within the Custom Properties
Available for purchase in:
view.
Enterprise, Performance,
1. From within your site, click Site Configuration > Custom Properties. and Unlimited Editions
The Custom Properties view appears.
Available (with limitations)
2. in: Developer Edition
Click .
3. Enter a name for the property in the Label field.
The expression name is filled in automatically. The expression name is used in style sheets and
USER PERMISSIONS
code blocks. To build, edit, and manage
4. Choose a type. Site.com sites:
• Site.com
5. Set the default value. Publisher User
6. To make the property required, click Required. field enabled on the user
detail page
To edit or delete properties, hover over any property and use the menu . To edit section AND
names, double-click the name make changes. Site administrator or
designer role assigned
SEE ALSO: at the site level

Custom Site Properties Overview To edit only content in

Custom Property Types Site.com sites:
• Site.com
Setting Up Custom Properties
Contributor User
AND
Contributor role
assigned at the site level

1148
Extend Salesforce with Clicks, Not Code Site.com

Setting Up Custom Properties

You can use custom properties in your website by using expression language syntax within a style
EDITIONS
sheet, code block, widget, or the HTML page editor.
To reference a site custom property in custom code or a content block, use the syntax Available in: Salesforce
{!Site.expression_name}}. For example, create a custom property to store the company Classic (not available in all
phone number with PhoneNumber as the expression name. In a content block, enter Contact orgs)
us at {!Site.PhoneNumber}. When the page loads, it replaces the value that is
Available for purchase in:
represented by {!Site.PhoneNumber} and displays “Contact us at 1-800-667-6389” on the page. Enterprise, Performance,
Note: The expression names are case-sensitive! and Unlimited Editions
Available (with limitations)
1. Open a website element such as a code block or widget. in: Developer Edition
2. Locate the place where you want to insert the expression.
3. Type {! USER PERMISSIONS
to see the list of available custom properties.
4. Select the property and double-click to enter it on the page. To build, edit, and manage
Site.com sites:
Example: Setting up custom properties is great for things that might change over time such • Site.com
as your address or a particular product phrase. Because expressions are just placeholders, if Publisher User
you update the value of a property in the Custom Properties view, the value is updated field enabled on the user
automatically wherever the custom property is referenced on a page. detail page
AND

SEE ALSO: Site administrator or

designer role assigned
Custom Site Properties Overview at the site level
Creating Custom Site Properties
To edit only content in
Site.com sites:
• Site.com
Contributor User
AND
Contributor role
assigned at the site level

Custom Properties for Page Templates or Widgets Overview

When you create a page template or a widget, you can add custom properties to it and specify the
EDITIONS
value and type of each property to achieve greater flexibility over how templates and widgets are
reused. Available in: Salesforce
Then, by adding custom code or content blocks to the page template or the widget, you can access Classic (not available in all
the property values by using expressions. Expressions serve as placeholders for data that will be orgs)
replaced with information when the page loads.
Available for purchase in:
In turn, when you or your team create a page from the template, the page is a copy or instance of Enterprise, Performance,
the template. Similarly, when you add the widget to a page, it creates an instance of the widget. and Unlimited Editions
You can’t edit the instance, but you can update its property values. Available (with limitations)
Because expressions are just placeholders, their values are updated automatically when you update in: Developer Edition
the values in the Properties pane of the page or widget.

1149
Extend Salesforce with Clicks, Not Code Site.com

You can also create sections to group related properties. These sections control how properties are grouped in the Properties pane.

Example: For example, let’s say you add a content block to a template to contain the page’s heading. In this case, when users
create a page from the template, you want to let them replace part of the text to suit their needs, but without letting them edit
the entire content block.
By adding a custom property that’s called pageSubject and specifying an initial value, you can instead use the following
expression in the content block:
Learn About {!pageSubject}
This action lets team members rename any page that’s derived from the template by updating the Page Subject property
in the page’s Properties pane, which automatically updates the value that’s represented by the {!pageSubject} expression.

Example: Alternatively, let’s say you want to create a YouTube widget using the following embed code:
<iframe width="560" height="315" src="//www.youtube.com/embed/hcUaN6XBTz4"
frameborder="0" allowfullscreen></iframe>

However, you want users to specify which video to display when they add an instance of the widget to the page. In this case, you
could create a section called YouTube, add a custom property labeled Video URL with videoURL as the expression name,
and instead use the following code:
<iframe width="560" height="315" src="{!videoURL}" frameborder="0"
allowfullscreen></iframe>

Now, when users add the YouTube widget to the page, they can point to any video by updating the Video URL property in
the YouTube section of the Properties pane, which automatically updates the value represented by the {!videoURL} expression.

1150
Extend Salesforce with Clicks, Not Code Site.com

SEE ALSO:
Widgets Overview
Adding Custom Properties to Page Templates or Widgets
Custom Property Types
About Displaying Dynamic Data Using Expressions

Adding Custom Properties to Page Templates or Widgets

When you create a page template or a widget, you can add custom properties to it and specify the
EDITIONS
value and type of each property.
Then, by adding custom code or content blocks to the page template or widget, you can access Available in: Salesforce
the property values using expressions, which serve as placeholders for the values. When you or Classic (not available in all
your team create a page from the template or add an instance of the widget to the page, you can orgs)
update the property values to modify the instance.
Available for purchase in:
When the page template or widget is open: Enterprise, Performance,
and Unlimited Editions
1. Make sure the template or widget is selected in the Page Structure pane and click Edit Custom
Properties in the Properties pane. Available (with limitations)
in: Developer Edition
2. Click New Property.
Base is the default section, which you can rename. Sections control how properties are grouped
in the Properties pane of a widget instance or page. USER PERMISSIONS
3. Enter the property label, which appears in the Properties pane of a widget instance or page—for To build, edit, and manage
example, Video URL. Site.com sites:
4. Optionally, update the expression name that was added automatically. • Site.com
Publisher User
Expression names are case sensitive and can’t include spaces. field enabled on the user
5. Specify the property type and value. detail page
AND
6. Optionally, mark the property as required.
Site administrator or
7. Add additional properties or sections as needed. Reorder items by dragging them to a new designer role assigned
location. at the site level

1151
Extend Salesforce with Clicks, Not Code Site.com

8. To use a custom property, drag a Custom Code or a Content Block page element from the Page Element tab onto the page
template or widget.
9. Use the syntax {!expression_name} to reference the expression—for example, {!videoURL}.
When the page loads, the expression will be replaced by the property value.
10. Add any additional text you require and save your changes.
For example, Check out our video at {!videoURL}.

Tip: You can also create a custom property by first typing the name of the property in custom code or a content block using
expression language. For example, if you type {!videoHeight} in a content block, a new property called videoHeight
is automatically added to the Properties pane of the template or widget, where you can then add a property value.
If you update a widget’s properties, your changes won’t be reflected in any widget instances. Instead, you must replace existing widget
instances with the latest version.
If you delete a custom property that’s being used in custom code or a content block, make sure you remove any references to the
property.

SEE ALSO:
Custom Properties for Page Templates or Widgets Overview
Custom Property Types
About Displaying Dynamic Data Using Expressions
Creating Widgets

Custom Property Types

Property types are available when designers or site administrators create site branding properties,
EDITIONS
site custom properties, widget branding properties, and widget custom properties.
Available in: Salesforce
Property Type Description Classic (not available in all
Text Lets users enter a text value. orgs)

Available for purchase in:

Checkbox Lets users set a true (selected) or false (deselected) value.
Enterprise, Performance,
Color Lets users specify a color, either by selecting one from the color picker and Unlimited Editions
or by entering a hexadecimal value, such as #333333. Available (with limitations)
in: Developer Edition
Image Lets users specify an image, either by browsing to a site image,
uploading a new image, or entering the URL to an image.

HTML Lets users enter an HTML value.

Units Lets users enter a measurement, such as pixels, percentage, or em—for

example, 5px.

Picklist Lets users select a value from a list you define.

To add items to the picklist, create a comma-delimited list of options,
where each option has a label and a value—for example, Label
1:Value 1, Label 2:Value 2. If you don’t add a value for
an option, the label is used as the value by default.

1152
Extend Salesforce with Clicks, Not Code Site.com

Property Type Description

To define a default picklist selection, use the format label:value:default—for example,
Small:S:default, Large:L.

Font Lets users select a font.

SEE ALSO:
Adding Custom Properties to Page Templates or Widgets
Creating Custom Site Properties
Creating Branding Properties

Site.com Data Services Overview

Site.com data services combine many features that let you connect to standard and custom Salesforce
EDITIONS
objects. Retrieve data from your organization’s objects and dynamically display it on your site pages,
or alternatively, gather and submit data from your customers. And when you update data in your Available in: Salesforce
Salesforce object, the changes are reflected automatically on the live site—no site updates required! Classic (not available in all
Here are a few ways you can use Site.com data services: orgs)

• Publish a catalog of products—List your company's products and include information, such as Available for purchase in:
model numbers and prices, pulled dynamically from your organization. Enterprise, Performance,
• Post company press releases—Publish your company’s press releases and sort by publication and Unlimited Editions
date. Available (with limitations)
• Create a realtor website—Display current listings filtered by city or price. in: Developer Edition

• Create a recruiting website—Post job openings to a public site and allow visitors to submit
applications and resumes.
So how does it all work? Several data-bound page elements let you retrieve and display your data, or collect data from your site visitors.
Data tables connect to Salesforce objects, retrieve a data set based on the filter criteria that you specify, and display one or more record
as rows in the table.
Data Repeaters and data elements combine to let you connect to standard and custom objects, retrieve data, and dynamically display
it on your site’s pages. Together, the data repeater and data elements result in a "repeating template" that offers you the greatest flexibility
for displaying one or more records on the page.
Data functions let you perform calculations on data retrieved from objects and display the result on the page. For example, for a particular
field in an object, you can use a data function to calculate the total value or the average amount of all returned records.
Nested repeaters let you retrieve data from objects with a parent-to-child relationship.
Forms and form fields combine to let you collect data from your site visitors and submit the data to standard or custom Salesforce objects.
Create web-to-lead forms, capture customer details, or gather feedback on your products or services.

Data Services Considerations

• To allow guest users to view the data in or submit data to a Salesforce object, you must set the object’s data access permissions.
• When working with assets, the easiest way to take advantage of Site.com data services is to import the files into your website, and
store a relative URL to these assets in your standard or custom object. See Storing Assets to Use with Salesforce Objects.

1153
Extend Salesforce with Clicks, Not Code Site.com

• If you add a data-bound page element to your site and then subsequently change a field type in the Salesforce object it’s connected
to—for example, changing a text field to a picklist—the data-bound page element will no longer work. You must reconfigure the
data-bound page element to reference the updated field.
• If you update data in an object that’s connected to a data table, data repeater, or data function, the changes are reflected automatically
on the live site. To control this, you can add a picklist field to the object to specify when a record is approved to go live. Then you
can use the field to filter the records by approved status, so only approved records appear on the live site.

Setting Data Access Permissions for Salesforce Objects

Sites built with Site.com are publicly available, so visitors access the site via the Guest User license that’s associated with the site.
Storing Assets to Use with Salesforce Objects
Because websites built with Site.com are publicly available, site visitors don’t have the security privileges required to view images
and documents stored in your Salesforce objects, which are available to authenticated users only.
Dynamically Retrieving Data with Data Repeaters
Use a data repeater to connect to a standard or custom Salesforce object and retrieve a data set based on the filter criteria that you
specify.
Adding a Form to the Page
Use forms to collect data from your site visitors and submit the data to standard or custom Salesforce objects. Create web-to-lead
forms, capture customer details, or gather feedback on your products or services.
The Default, Error, and No Data Views
Repairing Data Connections

SEE ALSO:
Accessing Data in Related Objects Overview
Adding Pagination to Data Repeaters and Data Tables
The Default, Error, and No Data Views

1154
Extend Salesforce with Clicks, Not Code Site.com

Setting Data Access Permissions for Salesforce Objects

Sites built with Site.com are publicly available, so visitors access the site via the Guest User license
EDITIONS
that’s associated with the site.
By default, site visitors can access information made available in an active public site, such as the Available in: Salesforce
site’s pages and assets. However, to allow guest users to view or submit data to a Salesforce object, Classic (not available in all
you must modify the object’s permission in the site’s guest user profile. Each site has a separate orgs)
Guest User license, so you can control guest access to Salesforce objects on a per-site basis.
Available for purchase in:
To edit the site’s guest user profile: Enterprise, Performance,
and Unlimited Editions
1. On the Overview tab of Site.com Studio, click Site Configuration and click Site Name
Profile. Alternatively, if you’re adding a data repeater, data table, data function, or form to the Available (with limitations)
page, click go to the guest user profile in the item’s dialog box. in: Developer Edition

2. In the site’s guest user profile, enable the “Read” permission on the standard or custom objects
you want to retrieve data from using data repeaters, data tables, or data functions. Enable the USER PERMISSIONS
“Create” permission on the objects you want to submit data to using forms. All permissions
that aren't set by default must be set manually. To build, edit, and manage
Site.com sites:
3. If required, modify the field-level security of an object.
• Site.com
Publisher User
SEE ALSO: field enabled on the user
Storing Assets to Use with Salesforce Objects detail page
AND
Site.com Data Services Overview
Site administrator or
designer role assigned
at the site level

To edit the guest user profile:

• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level
AND
Manage Profiles and
Permission Sets
AND
Customize Application

1155
Extend Salesforce with Clicks, Not Code Site.com

Storing Assets to Use with Salesforce Objects

Because websites built with Site.com are publicly available, site visitors don’t have the security
EDITIONS
privileges required to view images and documents stored in your Salesforce objects, which are
available to authenticated users only. Available in: Salesforce
Therefore, the easiest way to take advantage of Site.com data services is to import the files into Classic (not available in all
Site.com, and instead store a relative URL to these assets in your standard or custom object. orgs)
Alternatively, if your images or files are hosted elsewhere and readily available on the Internet, you
Available for purchase in:
can use an absolute URL. Enterprise, Performance,
For example, let’s say you want to use a custom object called “Catalog” to build a Catalog site page and Unlimited Editions
that displays product details and images. Before you begin building the Catalog site page, you Available (with limitations)
would: in: Developer Edition
1. Import the product images into your Site.com site.
2. In the Catalog object, create a field to store the relative URL of the image, such as Image USER PERMISSIONS
URL.
3. For each product record, add the relative path of the image. This URL is relative to the site, so To build, edit, and manage
Site.com sites:
if you upload widget.png to your site, the relative path is /widget.png. URLs are case
• Site.com
sensitive.
Publisher User
Then, when you add a data table, or a data repeater and data elements to the Catalog site page to field enabled on the user
display the product data, you can reference the Image URL field to dynamically display each detail page
product’s image on the page. AND
Site administrator or
SEE ALSO: designer role assigned
at the site level
Setting Data Access Permissions for Salesforce Objects
Site.com Data Services Overview

1156
Extend Salesforce with Clicks, Not Code Site.com

Dynamically Retrieving Data with Data Repeaters

Use a data repeater to connect to a standard or custom Salesforce object and retrieve a data set
EDITIONS
based on the filter criteria that you specify.
When you combine a data repeater with data elements, custom code, or content blocks, you can Available in: Salesforce
create a “repeating template” that displays one or more records on the page. Classic (not available in all
orgs)
To add a data repeater to a page:
1. Drag a Data Repeater from the Page Elements pane onto the page. Available for purchase in:
Enterprise, Performance,
2. Select the object that you want to connect to. and Unlimited Editions
Note: Available (with limitations)
in: Developer Edition
• For Site.com users, the drop-down list only displays objects that are available to guest
users because site visitors access your public site via the Guest User license. To make
other objects available, go to the guest user profile, enable the relevant object's “Read”
USER PERMISSIONS
permission, and refresh the list.
• For Communities users, the drop-down list displays objects that may not be available To build, edit, and manage
to site visitors. For authenticated visitors, object access on public and private pages Site.com sites:
is controlled by their user profiles. For unauthenticated visitors, object access on • Site.com
public pages is controlled by the site’s guest user profile. Publisher User
field enabled on the user
detail page
3. Optionally, in Filters, select criteria to filter your data set. If you don’t select any criteria, all the
AND
data from the item is returned.
Site administrator or
a. Select the field to which the filter criteria apply. The Field drop-down list displays the object’s designer role assigned
fields, followed by the fields of all parent objects, which use the format at the site level
parent_object_name.field_name.
To edit the guest user profile:
b. Select the operator to control how results are filtered. For example, select Equals to
• Site.com
return an exact match.
Publisher User
c. Select the source of the filter value. For example, to specify an explicit value, select Fixed field enabled on the user
value, or to use the values passed to the page via a query string, select URL query detail page
string. AND
d. Set the value of the filter. If you’re using a query string, you can also specify what should Site administrator or
happen if the query string is missing. designer role assigned
at the site level
e. Add additional filter criteria as required to narrow your results further. Each filter item is
AND
combined with an AND operator.
Manage Profiles and
Note: If you’re using a fixed value to filter the results, you can view the returned records Permission Sets
in the Connection Preview section. To refresh the list of records, click Reload Preview. AND
4. In Sorting, you can specify whether to sort the results by one or more fields in ascending or Customize Application
descending order. For example, if you’re working with an object that contains user data, you
could sort your results by gender first and then by name.
5. In Limits, you can limit the number of returned results. For example, if you’re only interested in the top five results, enter 5 in the
Limit results to field.
6. If you’re adding pagination, specify the number of results to display per page in the Results per page field.
7. Click Save.
Next, you must add either data elements, custom code, or content blocks to the data repeater to display the data it retrieves.

1157
Extend Salesforce with Clicks, Not Code Site.com

Displaying Data Using Data Elements

You can use a data element to display the data retrieved by a page data connection or a data repeater. The data element binds to
a field in the object and acts as a placeholder that’s replaced with the field’s data when the page loads.
Displaying Data Using Custom Code
In addition to data elements and content blocks, you can also use custom code as an alternative way to display data in a data repeater
or in a page data connection. It’s particularly useful for displaying field data that’s inline with text.
Displaying Data Using Content Blocks
In addition to data elements and custom code, you can also use content blocks as an alternative way to display data in a data repeater
or in a page data connection. It’s particularly useful for displaying field data that’s inline with text.
Dynamically Retrieving Data with Data Tables
Use a data table to connect to a standard or custom Salesforce object, retrieve a data set based on the filter criteria that you specify,
and display one or more record as rows in the table.
Editing Columns in a Data Table
Adding Pagination to Data Repeaters and Data Tables
Using Data Functions
A data function lets you connect to a standard or custom Salesforce object, perform calculations on the returned results, and display
the calculation on the page. For example, for a particular field in an object, you can use a data function to calculate the total value
or the average amount of all returned records.
Page Data Connections Overview
Page data connections make it easy for site administrators and designers to create a detail page for a single record when working
with Salesforce objects.
Retrieving Data with Page Data Connections
Use a page data connection to create a detail page for a single record when working with Salesforce objects.
Accessing Data in Related Objects Overview
Displaying Data from Related Objects Using Nested Data Repeaters
You can retrieve data from any child object of a parent object using a data repeater that contains another data repeater, data table,
or data function.
Improving Performance Using Caching
Data Filters
About Displaying Dynamic Data Using Expressions
Site.com uses expression language to display data dynamically. Expressions serve as placeholders for data that will be replaced with
information when the page loads. When working with data-bound page elements or custom widget properties, you can use
expressions to customize how data is displayed on the page.
Data Filtering Examples

SEE ALSO:
The Default, Error, and No Data Views
Improving Performance Using Caching
Data Filtering Examples
Site.com Data Services Overview

1158
Extend Salesforce with Clicks, Not Code Site.com

Displaying Data Using Data Elements

You can use a data element to display the data retrieved by a page data connection or a data
EDITIONS
repeater. The data element binds to a field in the object and acts as a placeholder that’s replaced
with the field’s data when the page loads. Available in: Salesforce
When combined with a data repeater, data elements result in a “repeating template” that displays Classic (not available in all
one or more records on the page. When used with a page data connection, data elements display orgs)
data from a single record.
Available for purchase in:
You can use data elements to display plain text, formatted text (for dates and numbers), or images. Enterprise, Performance,
You can also add hyperlinks to data elements to allow site visitors to navigate to another page, and Unlimited Editions
such as a detailed description, or to refresh the data displayed on the page or the data repeater Available (with limitations)
based on their selection. See Data Filtering Examples. in: Developer Edition
When the page is open:
1. Drag a Data Element from the Page Elements pane onto the data repeater. Alternatively, if USER PERMISSIONS
the page has a page data connection, drag the Data Element page element directly onto the
page canvas. To build, edit, and manage
Site.com sites:
2. Select the field to display. To customize how the field’s data is displayed, click Customize.
• Site.com
Note: The object’s fields are listed first, followed by the fields of all parent objects, which Publisher User
use the format parent_object_name.field_name. field enabled on the user
detail page
3. Select the display type. AND
Site administrator or
Option Description designer role assigned
at the site level
Text Lets you display the field’s data as plain text.

Formatted text Lets you choose from several text display

formats if you’re working with dates, times, or
currency.

Image Lets you display the field’s data as an image

if the field contains an image URL. The URL
can be absolute or relative to the site.
You can also select a field to use for the
alternative text or enter custom text.

4. To create a hyperlink, select Add a hyperlink. Otherwise, go to step 8.

5. Select the link type.

Option Description
A URL Lets you link to a Web page by:
• Choosing a field that you want to reference, such as a field
that stores the relative URLs of PDFs you uploaded to your
site.

1159
Extend Salesforce with Clicks, Not Code Site.com

Option Description
• Choosing a field that you want to reference and clicking
Customize to add an absolute URL or to create a custom
link, such as a URL query string.

An item in your site Lets you link to a page, image, or file in the site by selecting the
item type and then selecting the item. (If you can’t see the list
of items, place your cursor in the URL field and press the DOWN
key on your keyboard.)
You can also customize the URL—for example, by creating a URL
query string.

An email Lets you link to an email message by entering the recipient's

address, and the message subject and body.
You can use merge fields to access the object’s fields. For
example, if an object has an Email field, enter the merge field,
such as {!email}, in the Email address text box.
When the link is clicked, it opens a new message window in the
user’s email client and adds the appropriate email address to the
To: field.

6. Optionally, enter a tooltip by selecting the required field or clicking Customize to add custom text.
The tooltip displays as a pop-up when the user hovers over the link.

7. If you’re linking to a URL or an item in your site, specify where the item should open.

Option Description
Popup window Loads the item into a popup window. When you select this
option, you can set the title for the popup and control its
appearance and size with the options that appear.

New window (_blank) Loads the item into a new, unnamed browser window.

Same window (_self) Loads the item into the same frame or window as the link. This
is the default setting.

Topmost window (_top) Loads the item into the topmost parent frameset or window of
the frame that contains the link.

Parent window (_parent) Loads the item into the parent frameset or window of the frame
that contains the link.

8. Click Save.

1160
Extend Salesforce with Clicks, Not Code Site.com

The data element is displayed on the page as a merge field. To test the output, preview the page.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Retrieving Data with Page Data Connections
Displaying Data Using Custom Code
Displaying Data Using Content Blocks

Displaying Data Using Custom Code

In addition to data elements and content blocks, you can also use custom code as an alternative
EDITIONS
way to display data in a data repeater or in a page data connection. It’s particularly useful for
displaying field data that’s inline with text. Available in: Salesforce
When the page is open: Classic (not available in all
orgs)
1. Drag a Custom Code page element from the Page Elements pane onto the data repeater.
Alternatively, if the page has a page data connection, drag the Custom Code page element Available for purchase in:
directly onto the page canvas. Enterprise, Performance,
and Unlimited Editions
2. To access the fields of the object that the data repeater or page is connected to, type {! and
double-click the expression that you want to display. Available (with limitations)
in: Developer Edition
Note: The object’s fields are listed first, followed by the fields of all parent objects, which
use the format parent_object_name.field_name.
USER PERMISSIONS
3. Add any additional expressions or text you require. For example:
To build, edit, and manage
Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

To contact {!Name}, call {!Phone}.

where {!Name} and {!Phone} are placeholders for the values of the Name and Phone fields of each record.

4. Click Save and Close.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Retrieving Data with Page Data Connections
Displaying Data Using Content Blocks
Data Filtering Examples

1161
Extend Salesforce with Clicks, Not Code Site.com

Displaying Data Using Content Blocks

In addition to data elements and custom code, you can also use content blocks as an alternative
EDITIONS
way to display data in a data repeater or in a page data connection. It’s particularly useful for
displaying field data that’s inline with text. Available in: Salesforce
When the page is open: Classic (not available in all
orgs)
1. Drag a Content Block page element from the Page Elements pane onto the data repeater.
Alternatively, if the page has a page data connection, drag the Content Block page element Available for purchase in:
directly onto the page canvas. Enterprise, Performance,
and Unlimited Editions
2. Enter the name of the field you want to display using an expression. For example, {!Name}.
Available (with limitations)
Note: The object’s fields are listed first, followed by the fields of all parent objects, which in: Developer Edition
use the format parent_object_name.field_name.

3. Add any additional expressions or text you require. For example: USER PERMISSIONS
To contact {!Name}, call {!Phone}.
To build, edit, and manage
where {!Name} and {!Phone} are placeholders for the values of the Name and Phone Site.com sites:
fields of each record. • Site.com
You can also use expressions if you’re adding a hyperlink to the content block. Publisher User
field enabled on the user
4. Click Save. detail page
AND
SEE ALSO: Site administrator or
designer role assigned
Dynamically Retrieving Data with Data Repeaters
at the site level
Retrieving Data with Page Data Connections
Displaying Data Using Custom Code
Displaying Data Using Data Elements
Data Filtering Examples

1162
Extend Salesforce with Clicks, Not Code Site.com

Dynamically Retrieving Data with Data Tables

Use a data table to connect to a standard or custom Salesforce object, retrieve a data set based on
EDITIONS
the filter criteria that you specify, and display one or more record as rows in the table.
A data table’s columns bind to the fields of the object it’s connected to. Each column cell acts as a Available in: Salesforce
placeholder that is replaced with the field’s data when the page loads. Classic (not available in all
orgs)
To add a data table to the page:
1. Drag a Data Table from the Page Elements pane onto the page. Available for purchase in:
Enterprise, Performance,
2. Select the object that you want to connect to. and Unlimited Editions
Note: Available (with limitations)
in: Developer Edition
• For Site.com users, the drop-down list only displays objects that are available to guest
users because site visitors access your public site via the Guest User license. To make
other objects available, go to the guest user profile, enable the relevant object's “Read”
USER PERMISSIONS
permission, and refresh the list.
• For Communities users, the drop-down list displays objects that may not be available To build, edit, and manage
to site visitors. For authenticated visitors, object access on public and private pages Site.com sites:
is controlled by their user profiles. For unauthenticated visitors, object access on • Site.com
public pages is controlled by the site’s guest user profile. Publisher User
field enabled on the user
detail page
3. Optionally, in Filters, select criteria to filter your data set. If you don’t select any criteria, all the
AND
data from the item is returned.
Site administrator or
a. Select the field to which the filter criteria apply. The Field drop-down list displays the object’s designer role assigned
fields, followed by the fields of all parent objects, which use the format at the site level
parent_object_name.field_name.
To edit the guest user profile:
b. Select the operator to control how results are filtered. For example, select Equals to
• Site.com
return an exact match.
Publisher User
c. Select the source of the filter value. For example, to specify an explicit value, select Fixed field enabled on the user
value, or to use the values passed to the page via a query string, select URL query detail page
string. AND
d. Set the value of the filter. If you’re using a query string, you can also specify what should Site administrator or
happen if the query string is missing. designer role assigned
at the site level
e. Add additional filter criteria as required to narrow your results further. Each filter item is
AND
combined with an AND operator.
Manage Profiles and
Note: If you’re using a fixed value to filter the results, you can view the returned records Permission Sets
in the Connection Preview section. To refresh the list of records, click Reload Preview. AND
4. In Sorting, you can specify whether to sort the results by one or more fields in ascending or Customize Application
descending order. For example, if you’re working with an object that contains user data, you
could sort your results by gender first and then by name.
5. In Limits, you can limit the number of returned results. For example, if you’re only interested in the top five results, enter 5 in the
Limit results to field.
6. If you’re adding pagination, specify the number of results to display per page in the Results per page field.
7. Click Next.

1163
Extend Salesforce with Clicks, Not Code Site.com

8.
Add available fields to the table by double-clicking a field, or selecting it and clicking .
9. Reorder the list of selected fields by clicking Move Up or Move Down.
10. Click Save.

Note: You can’t add page elements to a data table. However, you can add additional columns to a data table by selecting it and
clicking Edit. On the Select Fields screen, select the additional fields and save your changes.
After you’ve added the data table to the page, you can use the Properties pane to:
• Provide a short heading or summary of the table’s purpose in the Caption field. The caption appears above the table, and complies
with W3C accessibility standards for screen reader users.
• Hide the column headings by deselecting Show Column Headings in the Table section.
• Make the columns sortable by selecting the jQuery Flexigrid theme in the Theme section and selecting Enable Sorting. The
theme also changes the appearance of the table.
• Change the name of a column by selecting the column cell and updating its name in the Column Heading property in the
Data Table section.

SEE ALSO:
Editing Columns in a Data Table
The Default, Error, and No Data Views
Improving Performance Using Caching
Data Filtering Examples

1164
Extend Salesforce with Clicks, Not Code Site.com

Editing Columns in a Data Table

A data table’s columns bind to the fields of the object it’s connected to. Each column cell acts as a
EDITIONS
placeholder that is replaced with the field’s data when the page loads.
You can display plain text, formatted text (for dates and numbers), or images in the column cells. Available in: Salesforce
You can also add hyperlinks to column cells to allow site visitors to navigate to another page, such Classic (not available in all
as a detailed description, or to refresh the data displayed in the data table based on their selection. orgs)
See Data Filtering Examples on page 1179.
Available for purchase in:
To edit a column: Enterprise, Performance,
and Unlimited Editions
1. Double-click the column cell in the data table.
Available (with limitations)
2. Select the field to display. To customize how the field’s data is displayed, click Customize.
in: Developer Edition
Note: The object’s fields are listed first, followed by the fields of all parent objects, which
use the format parent_object_name.field_name.
USER PERMISSIONS
3. Select the display type.
To build, edit, and manage
Site.com sites:
Option Description
• Site.com
Text Lets you display the field’s data as plain text. Publisher User
field enabled on the user
Formatted text Lets you choose from several text display detail page
formats if you’re working with dates, times, or
AND
currency.
Site administrator or
Image Lets you display the field’s data as an image designer role assigned
if the field contains an image URL. The URL at the site level
can be absolute or relative to the site.
You can also select a field to use for the
alternative text or enter custom text.

4. To create a hyperlink, select Add a hyperlink. Otherwise, go to step 8.

5. Select the link type.

Option Description
A URL Lets you link to a Web page by:
• Choosing a field that you want to reference, such as a field
that stores the relative URLs of PDFs you uploaded to your
site.
• Choosing a field that you want to reference and clicking
Customize to add an absolute URL or to create a custom
link, such as a URL query string.

An item in your site Lets you link to a page, image, or file in the site by selecting the
item type and then selecting the item. (If you can’t see the list
of items, place your cursor in the URL field and press the DOWN
key on your keyboard.)

1165
Extend Salesforce with Clicks, Not Code Site.com

Option Description
You can also customize the URL—for example, by creating a URL
query string.

An email Lets you link to an email message by entering the recipient's

address, and the message subject and body.
You can use merge fields to access the object’s fields. For
example, if an object has an Email field, enter the merge field,
such as {!email}, in the Email address text box.
When the link is clicked, it opens a new message window in the
user’s email client and adds the appropriate email address to the
To: field.

6. Optionally, enter a tooltip by selecting the required field or clicking Customize to add custom text.
The tooltip displays as a pop-up when the user hovers over the link.

7. If you’re linking to a URL or an item in your site, specify where the item should open.

Option Description
Popup window Loads the item into a popup window. When you select this
option, you can set the title for the popup and control its
appearance and size with the options that appear.

New window (_blank) Loads the item into a new, unnamed browser window.

Same window (_self) Loads the item into the same frame or window as the link. This
is the default setting.

Topmost window (_top) Loads the item into the topmost parent frameset or window of
the frame that contains the link.

Parent window (_parent) Loads the item into the parent frameset or window of the frame
that contains the link.

8. Click Save.
The column is displayed on the page as an expression. To test the output, preview the page.
To change the name of a column, select the column cell and update the name in the Column Heading field of the Properties pane.

SEE ALSO:
Dynamically Retrieving Data with Data Tables
Site.com Data Services Overview

1166
Extend Salesforce with Clicks, Not Code Site.com

Adding Pagination to Data Repeaters and Data Tables

Events let you add interactive and animated effects to the pages and page elements of your website.
EDITIONS
When using data repeaters and data tables, you can add pagination events so users can easily page
through the displayed data. This is particularly useful when working with large amounts of data. Available in: Salesforce
For example, if you’ve added a data repeater that displays all the users in an organization, you can Classic (not available in all
add pagination to help users navigate through the data. You can add three pagination events: orgs)

• Previous Page Available for purchase in:

• Next Page Enterprise, Performance,
and Unlimited Editions
• Go To Page
Available (with limitations)
in: Developer Edition
Creating Previous and Next Pagination
You can create previous and next buttons so users can move through the data one page at a time.
The process for creating both buttons is the same. USER PERMISSIONS
1. Create your data repeater or data table. To build, edit, and manage
Site.com sites:
2. In the data repeater or data table, be sure to specify how many records to display per page in
• Site.com
the Limits section.
Publisher User
3. Drag a button to the page. field enabled on the user
detail page
4. In the Properties pane, change the Button Name to Previous Page or Next Page as appropriate.
AND
5. In the Events pane, select the click event.
Site administrator or
6. designer role assigned
When the Actions box appears, click and select the Previous Page or Next Page action.
at the site level
7. In the Target Element, select the data repeater or data table.
8. Click Save.

Creating GoTo Pagination

Creating GoTo navigation is similar to creating the previous and next buttons, but you must add an input field so users can specify what
page they what to go to.
1. Create your data repeater or data table.
2. In the data repeater or data table, be sure to specify how many records to display per page in the Limits section.
3. Drag a Number field onto the page.
4. In the Properties pane, change the field’s Label Name to something that makes sense. For example, Enter Page Number.
5. Drag a Button onto the page.
6. In the Properties pane, change the Button Name to GoTo Page.
7. In the Events pane, select the click event.
8.
When the Actions box appears, click and select the Go To Page action.
9. In the Target Element, select the data repeater or data table.
10. For Input Field ID, select the field you created in step 3.

1167
Extend Salesforce with Clicks, Not Code Site.com

11. Click Save.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables
Creating an Event
Available Events and Actions

1168
Extend Salesforce with Clicks, Not Code Site.com

Using Data Functions

A data function lets you connect to a standard or custom Salesforce object, perform calculations
EDITIONS
on the returned results, and display the calculation on the page. For example, for a particular field
in an object, you can use a data function to calculate the total value or the average amount of all Available in: Salesforce
returned records. Classic (not available in all
To add a data function to a page: orgs)

1. Drag a Data Function from the Page Elements pane onto the page. Available for purchase in:
2. Select the object that you want to connect to. Enterprise, Performance,
and Unlimited Editions
Note: Available (with limitations)
• For Site.com users, the drop-down list only displays objects that are available to guest in: Developer Edition
users because site visitors access your public site via the Guest User license. To make
other objects available, go to the guest user profile, enable the relevant object's “Read”
permission, and refresh the list. USER PERMISSIONS
• For Communities users, the drop-down list displays objects that may not be available To build, edit, and manage
to site visitors. For authenticated visitors, object access on public and private pages Site.com sites:
is controlled by their user profiles. For unauthenticated visitors, object access on • Site.com
public pages is controlled by the site’s guest user profile. Publisher User
field enabled on the user
3. Optionally, in Filters, select criteria to filter your data set. If you don’t select any criteria, all the detail page
data from the item is returned. AND
a. Select the field to which the filter criteria apply. The Field drop-down list displays the object’s Site administrator or
fields, followed by the fields of all parent objects, which use the format designer role assigned
at the site level
parent_object_name.field_name.
b. Select the operator to control how results are filtered. For example, select Equals to To edit the guest user profile:
return an exact match. • Site.com
Publisher User
c. Select the source of the filter value. For example, to specify an explicit value, select Fixed field enabled on the user
value, or to use the values passed to the page via a query string, select URL query detail page
string.
AND
d. Set the value of the filter. If you’re using a query string, you can also specify what should Site administrator or
happen if the query string is missing. designer role assigned
e. Add additional filter criteria as required to narrow your results further. Each filter item is at the site level
combined with an AND operator. AND
Manage Profiles and
Note: If you’re using a fixed value to filter the results, you can view the returned records
Permission Sets
in the Connection Preview section. To refresh the list of records, click Reload Preview.
AND
4. In Functions, select a function: Customize Application

Option Description
Count Counts the number of records that contain a
value for the selected field. For example, if an
object contains 30 records, but only 25 records
have a value in the field you specify, the result
is 25.

1169
Extend Salesforce with Clicks, Not Code Site.com

Option Description
Maximum Returns the highest value of all the values for the selected field.
Applies to numbers, strings, and dates.

Average Calculates the average value of all records for the selected field.
For example, if you have 20 records with a total value of $20,000
in the Price field, the average is $1,000. Only applicable to fields
that contain numbers.

Minimum Returns the lowest value of all the values for the selected field.
Applies to numbers, strings, and dates.

Sum Calculates the total value of all records for the selected field.

5. Select the field it applies to.

6. Click Save.

SEE ALSO:
The Default, Error, and No Data Views
Improving Performance Using Caching
Data Filtering Examples

Page Data Connections Overview

Page data connections make it easy for site administrators and designers to create a detail page for
EDITIONS
a single record when working with Salesforce objects.
When combined with repeater elements, custom code, or content blocks, page data connections Available in: Salesforce
let you connect to standard and custom objects, retrieve a specific record, and dynamically display Classic (not available in all
the record on a site page. orgs)

Example: For example, let’s say you want to list all of your company’s accounts on a site Available for purchase in:
page called Accounts. When a user clicks a View Details link, you want to open a site page Enterprise, Performance,
called Account Detail to display information for the selected account. and Unlimited Editions

In this case, you could add a data repeater to the Accounts site page to retrieve a list of records Available (with limitations)
in: Developer Edition
from the Account object (1). Using a data element, you could create a View Details link (2)
that, when clicked, uses a URL query string to pass the Account ID field as a unique
identifier to the Account Detail page. As the Account Details page loads, the page data
connection uses the unique identifier value to dynamically return only that record’s details
(3).

1170
Extend Salesforce with Clicks, Not Code Site.com

With page data connections, you can use expressions to access the returned data anywhere on the page, including the page’s
properties. For example, let’s say you want to use the account name as the title of the Account Detail page. In this case, you would
simply enter {!Name} in the Title field on the Properties pane. When the page loads, it retrieves the account name for that
particular record and displays it in the browser’s title bar.

SEE ALSO:
Retrieving Data with Page Data Connections
Site.com Data Services Overview

1171
Extend Salesforce with Clicks, Not Code Site.com

Retrieving Data with Page Data Connections

Use a page data connection to create a detail page for a single record when working with Salesforce
EDITIONS
objects.
When combined with data elements, custom code, or content blocks, page data connections let Available in: Salesforce
you connect to standard and custom objects, retrieve a specific record, and dynamically display Classic (not available in all
the returned data anywhere on the page. You can even use expressions to access the returned data orgs)
in the page’s properties.
Available for purchase in:
When the page is open: Enterprise, Performance,
and Unlimited Editions
1. Ensure that the page is selected in the Page Structure pane.
Available (with limitations)
2. Click Add Connection in the Page Data Connection section of the Properties pane.
in: Developer Edition
3. Select the object that you want to connect to.

Note:
USER PERMISSIONS
• For Site.com users, the drop-down list only displays objects that are available to guest
users because site visitors access your public site via the Guest User license. To make To build, edit, and manage
Site.com sites:
other objects available, go to the guest user profile, enable the relevant object's “Read”
• Site.com
permission, and refresh the list.
Publisher User
• For Communities users, the drop-down list displays objects that may not be available field enabled on the user
to site visitors. For authenticated visitors, object access on public and private pages detail page
is controlled by their user profiles. For unauthenticated visitors, object access on AND
public pages is controlled by the site’s guest user profile.
Site administrator or
designer role assigned
4. Optionally, in Filters, select criteria to filter which record is returned. If you don’t select any at the site level
criteria, the first record is returned by default.
To edit the guest user profile:
a. Select the field to which the filter criteria apply. The Field drop-down list displays the object’s
• Site.com
fields, followed by the fields of all parent objects, which use the format
Publisher User
parent_object_name.field_name. field enabled on the user
b. Select the operator to control how results are filtered. For example, select Equals to detail page
return an exact match. AND
c. Select the source of the filter value. For example, to specify an explicit value, select Fixed Site administrator or
value, or to use the values passed to the page via a query string, select URL query designer role assigned
string. at the site level
AND
d. Set the value of the filter. If you’re using a query string, you can also specify what should
happen if the query string is missing. Manage Profiles and
Permission Sets
e. Add additional filter criteria as required to narrow your results further. Each filter item is
AND
combined with an AND operator.
Customize Application
Note: If you’re using a fixed value to filter the results, you can view the returned records
in the Connection Preview section. To refresh the list of records, click Reload Preview.

5. In Sorting, you can specify whether to sort the results by one or more fields in ascending or descending order.
For example, say you want to create a page that displays the most popular movie. You could connect to a custom object that contains
movie data, and instead of using filter criteria, you could sort by user rating in descending order. Because a page data connection
returns a single record, only the highest rated movie is returned.
6. Click Save.

1172
Extend Salesforce with Clicks, Not Code Site.com

Next, you must add either data elements, custom code, or content blocks to the page to display the retrieved record data.
You can use expressions to access the returned data anywhere on the page, including the page’s properties. For example, let’s say you
want to use the account name as the title of the Account Detail page. In this case, you would simply enter {!Name} in the Title
field on the Properties pane. When the page loads, it retrieves the account name for that particular record and displays it in the browser’s
title bar.

SEE ALSO:
Page Data Connections Overview
Improving Performance Using Caching
About Displaying Dynamic Data Using Expressions
Data Filtering Examples

Accessing Data in Related Objects Overview

Important: Where possible, we changed noninclusive terms to align with our company EDITIONS
value of Equality. We maintained certain terms to avoid any effect on customer
implementations. Available in: Salesforce
Standard and custom objects have relationships that define how records in one object relate to Classic (not available in all
orgs)
records in another. For example, the Accounts object has a one-to-many relationship with the
Contacts object—that is, each account can have one or more contacts associated with it. This Available for purchase in:
relationship is also known as a parent-to-child or a master-detail relationship. Enterprise, Performance,
Data repeaters, data tables, and data functions take advantage of these relationships to let you and Unlimited Editions
display data from related objects on the page. Available (with limitations)
in: Developer Edition

About Accessing Data in Parent Objects

When you add a data repeater, data table, or data function to the page and connect it to a standard
or custom object, you can automatically access the fields of any parent object it’s related to.
If you add filter criteria to a data repeater, data table, or data function, the Field drop-down list in the Create Data Connection dialog box
displays the object’s fields, followed by the fields of all of its parent objects, which use the format
parent_object_name.field_name. This lets you filter results based on a field in the parent object. So for example, when
retrieving records from the Contacts object, you could decide to return only contacts where the account name (Account.Account
Name) is “ABC Labs.”
Similarly, when you add data elements to a data repeater, or columns to a data table, you can bind them to fields in a parent object. So
for example, if you add a data table that’s connected to the Contact object, you can add a column that binds to its Full Name field
and a column that binds to the Account object’s Account.Account Name field to display the contact’s name along with the
name of the account it’s associated with.

About Accessing Data in Child Objects

You can retrieve data from any child object of a parent object using a data repeater that contains another data repeater, data table, or
data function. The outer or parent data repeater connects to an object, such as Accounts. In turn, the inner data repeater, data table, or
data function automatically lets you connect to any child objects, such as Contacts. This is also known as a nested data repeater.
Let’s say you want to display a list of accounts along with the names of the associated contacts, similar to this example.

1173
Extend Salesforce with Clicks, Not Code Site.com

You can achieve this by creating a data repeater (1) that’s connected to Accounts, and adding a data element (2) to it that binds to the
Account Name field. Then add a nested data repeater (3) that’s connected to Contacts, which is a child of Accounts. Finally, add a
data element (4) to the nested data repeater that binds to the Contact object’s Full Name field.

SEE ALSO:
Displaying Data from Related Objects Using Nested Data Repeaters
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables

1174
Extend Salesforce with Clicks, Not Code Site.com

Displaying Data from Related Objects Using Nested Data Repeaters

You can retrieve data from any child object of a parent object using a data repeater that contains
EDITIONS
another data repeater, data table, or data function.
The outer or parent data repeater connects to an object, such as Accounts. In turn, the inner data Available in: Salesforce
repeater, data table, or data function automatically lets you connect to any child objects, such as Classic (not available in all
Contacts. This is also known as a nested data repeater. For example, if a data repeater is connected orgs)
to Accounts, you can add a nested data function to it that’s connected to Contacts to return the
Available for purchase in:
number of contacts associated with each account. Enterprise, Performance,
To create a nested data repeater: and Unlimited Editions
1. Add a data repeater to the page. Available (with limitations)
in: Developer Edition
2. Drag another Data Repeater, Data Table, or Data Function from the Page Elements pane
onto the data repeater.
3. Select the related Salesforce object that you want to connect to. USER PERMISSIONS
Note: You can also retrieve data from unrelated objects. However, as this can adversely To build, edit, and manage
affect the performance of your site, we recommend retrieving data from related objects Site.com sites:
only. • Site.com
Publisher User
4. Optionally, in Filters, select criteria to filter your data set. If you don’t select any criteria, all the field enabled on the user
data from the item is returned. detail page
a. Select the field to which the filter criteria apply. The Field drop-down list displays the object’s AND
fields, followed by the fields of all parent objects, which use the format Site administrator or
parent_object_name.field_name. designer role assigned
at the site level
b. Select the operator to control how results are filtered. For example, select Equals to
return an exact match. To edit the guest user profile:
c. Select the source of the filter value. For example, to specify an explicit value, select Fixed • Site.com
Publisher User
value, or to use the values passed to the page via a query string, select URL query
field enabled on the user
string.
detail page
d. Set the value of the filter. If you’re using a query string, you can also specify what should AND
happen if the query string is missing.
Site administrator or
e. Add additional filter criteria as required to narrow your results further. Each filter item is designer role assigned
combined with an AND operator. at the site level
AND
Note: If you’re using a fixed value to filter the results, you can view the returned records
in the Connection Preview section. To refresh the list of records, click Reload Preview. Manage Profiles and
Permission Sets
5. In Sorting, you can specify whether to sort the results by one or more fields in ascending or AND
descending order. For example, if you’re working with an object that contains user data, you
Customize Application
could sort your results by gender first and then by name.
6. In Limits, you can limit the number of returned results. For example, if you’re only interested in
the top five results, enter 5 in the Limit results to field.
7. If you’re adding pagination, specify the number of results to display per page in the Results per page field.
8.
If you’re working with a data table, click Next and add fields to the table by double-clicking a field, or selecting it and clicking .
9. Click Save.

1175
Extend Salesforce with Clicks, Not Code Site.com

You can either add data elements or custom code to the parent repeater to display its fields. Similarly, if you’ve nested a data repeater
inside the parent data repeater, add data elements or custom code to the nested data repeater to display the child object’s fields.

Note: You can’t nest data repeaters more than one level deep.

SEE ALSO:
Accessing Data in Related Objects Overview
Dynamically Retrieving Data with Data Tables
Using Data Functions

Improving Performance Using Caching

When working with data-bound page elements, such as data repeaters, data tables, and data
EDITIONS
functions, you can improve the performance and page rendering of your website using caching.
Caching controls how often a page containing a data connection requests data from Salesforce. Available in: Salesforce
Lets say 100 people visit the site page at the same time. Without caching, the page makes 100 Classic (not available in all
separate requests for the same data, slowing performance considerably. However, with caching orgs)
enabled, the data is requested and retrieved only once—the first time someone visits the page.
Available for purchase in:
Any subsequent requests for data during a set time period are returned from the cache. When the Enterprise, Performance,
specified time period expires, the cache is refreshed. and Unlimited Editions
The Cache Duration (Minutes) field in the Properties tab controls the length of time to Available (with limitations)
cache retrieved data for the selected data repeater, data table, or data function. in: Developer Edition
The default value is 30 minutes. However, the appropriate number of minutes depends on your
requirements. For example:
• If the data is updated frequently, such as in a commenting system or a stock ticker, you can disable caching by setting the value to
zero to ensure the freshest data displays on the page.
• If the data changes infrequently, say just once a week, you can set the value to a much greater number of minutes. A longer caching
period also helps ensure pages can display data even if the data source is momentarily unavailable.

Note: Whenever updates to a site are published, the cache is deleted for all data connections. Caching begins again the next
time a site visitor accesses the page.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables
Using Data Functions

1176
Extend Salesforce with Clicks, Not Code Site.com

Data Filters
When you add a data repeater, a data table, or a data function to a page, you don’t have to limit
EDITIONS
the records it retrieves. However, if you’re working with a Salesforce object that has thousands of
records, you can limit the returned results using filter criteria. Available in: Salesforce
When you add filter criteria, you need to specify: Classic (not available in all
orgs)
• The field to which the filter criteria apply
• The operator Available for purchase in:
Enterprise, Performance,
• The source of the filter value
and Unlimited Editions
• The filter value
Available (with limitations)
in: Developer Edition
Filter Operators

Operator Description
Equals Returns an exact match.

Not equal to Returns records that don’t have the value you specify.

Less than Returns records that are less than the value you specify.

Greater than Returns records that exceed the value you specify.

Less than or equal Returns records that match or are less than the value you specify.
to

Greater than or Returns records that match or exceed the value you specify.
equal to

Starts with Use when you know what your value starts with, but not the exact text. For
example, “california” would return California Travel, but not Surf California.

Ends with Use when you know what your value ends with, but not the exact text.

Contains Returns records that include your search string but might also include other
information. For example, “california” would return California Travel and Surf
California.

Includes Use for field types that support multiple values to return records that contain
one or more of the comma-separated values you specify.

Includes all Use for field types that support multiple values to return records that contain
all of the comma-separated values you specify.

Excludes Use for field types that support multiple values to return records that don’t
contain one or more of the comma-separated values you specify. For example,
for a Locations category field, “San Francisco,Vancouver” would exclude a
record containing “San Francisco,Dallas” and a record containing
“Vancouver,New York.”

Excludes all Use for a field types that support multiple values to return records that don’t
contain all of the comma-separated values you specify. For example, for a

1177
Extend Salesforce with Clicks, Not Code Site.com

Operator Description
Locations category field, “San Francisco,Vancouver” would exclude only records that contain both terms.

Filter Value Sources

Source Description
Fixed value Use when you want to specify the value.

URL query string Use when you want to pass variable content via a URL to the item when the page loads.

Global property Use when you want to use a fixed value from the site, such as the current date or current time.

Request header Use when you want to use a value from the browser, such as the host header or browser version.

Parent repeater Use when you want to create a query between unrelated objects. Available only when a data
repeater, data table, or data function is nested inside a parent repeater, but the parent repeater’s
object is unrelated to the nested item’s object.

Warning: Retrieving data from unrelated objects can adversely affect the performance
of your site. We recommend retrieving data from related objects only.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables
Using Data Functions
About Displaying Dynamic Data Using Expressions

About Displaying Dynamic Data Using Expressions

Site.com uses expression language to display data dynamically. Expressions serve as placeholders
EDITIONS
for data that will be replaced with information when the page loads. When working with data-bound
page elements or custom widget properties, you can use expressions to customize how data is Available in: Salesforce
displayed on the page. Classic (not available in all
In Site.com, expression syntax consists of an open curly brace and exclamation point, the field, orgs)
custom property name, or namespace name, and a closing curly brace.
Available for purchase in:
For example, if you added a custom property called URL to a widget, you can use the syntax Enterprise, Performance,
{!URL} to add the expression to custom code or content blocks. Similarly, to add an expression and Unlimited Editions
for the Billing City field, you can use the syntax {!BillingCity}. For related objects, the field Available (with limitations)
name is prefixed by the name of the master object: {!Account.BillingCity}. in: Developer Edition
If you’re editing a data element in a data repeater or a data table column, you can access the object’s
fields by name in a drop-down list without using expressions. However, if you want to customize
how the field is displayed on the page, you can see and edit the expression when you click Customize in the dialog box.
If you’re working with custom code or content blocks in a data repeater, you can only access the object’s fields using expressions.
Expressions let you customize the output by:

1178
Extend Salesforce with Clicks, Not Code Site.com

• Adding text around the expression. For example, lets say you’re displaying the phone number of each of your business locations.
You could enter the text Contact us at before the {!Phone} expression. When the data is displayed on the page,
{!Phone} is replaced with the field’s value for each record: Contact us at 100–200–3000.
• Formatting the output using HTML tags. For example, you could wrap H1 tags around the expression to alter how the output is
displayed on the page: <H1>{!Phone}</H1>.
• Creating a URL query string to pass variable information to a data repeater or data table on another page. The second page, in turn,
uses the received variable to retrieve and display the relevant records. For example, you could create a hyperlink, such as
/product_details?productID={!id}, where {!id} is replaced with the product ID for each record. When a particular
product link is clicked, the product ID is passed to the Product Details page, which uses the ID to retrieve the record’s information
and display it on the page.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables
Using Data Functions

Data Filtering Examples

When working with data repeaters, data tables, and data functions, you can filter the data you
EDITIONS
retrieve in many ways. In this topic, we explore two options—fixed values and URL query strings—to
illustrate some common filtering techniques. Available in: Salesforce
Classic (not available in all
Example 1: Using a Fixed Value to Filter Results orgs)

In our first example, we have a custom object called “News” that stores company news and events. Available for purchase in:
Each news item has a Status picklist that can be set to either In Progress or Approved. We only Enterprise, Performance,
want to display approved news items on our Company News page. In this case, we can use a fixed and Unlimited Editions
value to filter the data in the News object. Available (with limitations)
In this scenario you would: in: Developer Edition

1. Add a data repeater to the page and configure it as follows:

a. Select the News custom object.
b. In the Filters section, set the criteria to Status Equals Fixed value.
c. Enter Approved in the Value text box.
This tells the data repeater to return only records where the Status field contains the value Approved.
2. Add data elements to the data repeater to display the required fields, such as Title, Description, and Date, on the page.

Example 2: Using a URL Query String to Dynamically Filter and Display Results on Another Page
In our second example, we have a custom object called “Products” that stores product information. However, some products are only
available in certain locations, so we’d like to let customers view the products in their nearest city. In this case, we could create a Locations
site page that contains links to each available city.
We want each link to open the Products site page, but only display products based on the user’s selection. We can do this using URL
query strings, which allow us to pass variable content between HTML pages. The variable information in this case is the product location;
the data repeater won’t know which products to return until the user makes a selection.
For this scenario, you would:

1179
Extend Salesforce with Clicks, Not Code Site.com

1. Add a data repeater to the Products page and configure it as follows:

a. Select the Products custom object.
b. In the Filters section, set the criteria to City Equals URL query string.
c. In the Value text box, enter the variable name—in this case, location.
d. In the If query string is missing drop-down list, select Don’t apply this filter item. This option is used when a customer wants
to view all products without filtering.
e. Click Save.

2. Add data elements for the fields you want to display, such as Product Name, Description, and Price.
3. On the Locations page, add a data repeater and select the Products custom object.
4. Add a data element to the data repeater to represent the City field and configure it as follows:
a. Select the City field as the field to display, because we want to use the name of the city as the hyperlink.
b. Select Text as the display format.
c. Select Add a hyperlink to display a URL on the page.
d. In the Link to drop-down list, select An item in your site.
e. Select Page as the type and select the Products page. (If you can’t see the list of pages, place your cursor in the URL text box and
press the DOWN key on your keyboard.)
f. Change the URL value to /product?location={!City}. In this case, {!City} is a placeholder for the value of a
record’s City field. When the page first loads, {!City} is replaced with the correct value, such as Dallas, which creates the
following URL for that record:
/product?location=Dallas

When clicked, this opens the Products page and passes Dallas as the value of the location variable.

g. For the tooltip, select the City field and click Customize.
h. Change the value to Show me products available in {!City}.
Again, the {!City} placeholder is replaced by the value of the City field for each record when the page loads.

Now, when the Locations page loads, the data repeater displays the location of each product as a link. When a customer clicks a link,
such as Dallas, the Locations page passes location=Dallas to the Products page. As the Products page loads, the data repeater
uses this value to dynamically return only records where the City field contains the value Dallas.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Displaying Data Using Data Elements
Dynamically Retrieving Data with Data Tables
Accessing Data in Related Objects Overview

1180
Extend Salesforce with Clicks, Not Code Site.com

Adding a Form to the Page

Use forms to collect data from your site visitors and submit the data to standard or custom Salesforce
EDITIONS
objects. Create web-to-lead forms, capture customer details, or gather feedback on your products
or services. Available in: Salesforce
To add a form to a page: Classic (not available in all
orgs)
1. Drag a Form from the Page Elements pane onto the page.
2. Select the Salesforce object that you want to submit data to. Available for purchase in:
Enterprise, Performance,
Note: and Unlimited Editions
• For Site.com users, the drop-down list only displays objects that are available to guest Available (with limitations)
users because site visitors access your public site via the Guest User license. To make in: Developer Edition
other objects available, go to the guest user profile, enable the relevant object's
“Create” permission, and refresh the list.
USER PERMISSIONS
• For Communities users, the drop-down list displays objects that may not be available
to site visitors. For authenticated visitors, object access on public and private pages To add a form to the page:
is controlled by their user profiles. For unauthenticated visitors, object access on • Site.com
public pages is controlled by the site’s guest user profile. Publisher User
field enabled on the user
3. detail page
Add available fields to the form by double-clicking a field, or selecting it and clicking .
AND
All required fields are automatically added to the list of selected fields. However, you can hide
Site administrator or
required fields after you add the form to the page.
designer role assigned
4. Reorder the list of selected fields by clicking Move Up or Move Down. in Site.com Studio

5. Click Save. To edit the guest user profile:

• Site.com
Note: When adding forms to authenticated community pages in Site.com, set the current Publisher User
user for Salesforce objects that require the Owner ID field. Setting the current user (as opposed field enabled on the user
to the default guest user) lets you identify the authenticated user when the form is submitted. detail page
To set the current user for the Owner ID field, select the field in the form, and click Configure. AND
Under Field Properties in the Properties pane, select Global Property as the source,
Site administrator or
and select Current userID as the value.
designer role assigned
After you add a form to the page, you can’t change the object it’s connected to. If you need to in Site.com Studio
connect to a different object, you must replace the form. AND
You can use the form’s Properties pane to: Manage Users
• See which object the form is connected to. AND
• Add a title to the top of the form. Customize Application
• Specify what occurs when a user successfully submits the form.
• Change the appearance of the form by selecting a different theme.

Adding Input Fields to Forms or Pages

Editing Input Fields in a Form
After you’ve added a form to the page, you can edit and reorder its fields.
Input Field Types
Input Field Properties

1181
Extend Salesforce with Clicks, Not Code Site.com

Setting the Default Value of Input Fields

You can set the default value of an input field that you add to a form or page. This automatically populates the input field with the
value you specify when the page loads.
Setting a Form’s Submit Behavior
When your site visitors submit a form successfully, you can either redirect them to another page or display a message indicating
that they were successful.
Styling Forms
Forms are styled using CSS themes that you can customize to match the design of your website.

SEE ALSO:
Adding Input Fields to Forms or Pages
Input Field Types
Editing Input Fields in a Form

Adding Input Fields to Forms or Pages

EDITIONS
Adding Input Fields to a Form
You can add additional input fields to an existing form. Each input field binds to a field in the object Available in: Salesforce
the form is connected to. Classic (not available in all
orgs)
The quickest option is to:
Available for purchase in:
1. Select the form on the page.
Enterprise, Performance,
2. Select > Add Fields. and Unlimited Editions
3. In the Add Fields list, click the fields that you want to add. The Add Fields list displays the available Available (with limitations)
fields in the object that the form is connected to. When you click a field, the correct field type in: Developer Edition
is automatically added to the form, such as a checkbox or picklist field.
Alternatively:
USER PERMISSIONS
1. Select the form on the page.
To build, edit, and manage
2. Select > Add Page Elements. Site.com sites:
3. In the Add Page Elements list, click the input field type that you want to add, such as Checkbox. • Site.com
Publisher User
4. Choose a field in the Add a Field dialog box and click Save. If no fields of that type exist in the
field enabled on the user
object, you can’t add a field of that type to the form. detail page
Note: AND
• You can’t add fields to a form by clicking > Edit Form. Site administrator or
designer role assigned
• Formula, encrypted text, geolocation, and lookup field types aren’t supported. at the site level
• You can’t configure the default field-level error messages that appear when users enter
an incorrect value.

Adding Input Fields to a Page

You can add input fields directly to a page, panel, data repeater, or data table to build your own custom features using custom code.
For example, let’s say some of your products are only available in certain locations and you’d like to let customers view the products in

1182
Extend Salesforce with Clicks, Not Code Site.com

their nearest city. You could add a picklist input field to the page that lists the various locations. Using custom code, you could then pass
the user’s selection to a data table or data repeater via a query string to display a filtered product list.
To add an input field to the page, drag it from the Page Elements pane onto the page. Alternatively, select the page or container page
element in the Page Structure pane, select > Add Page Elements, and select the input field.

SEE ALSO:
Input Field Types
Input Field Properties
Editing Input Fields in a Form
Adding a Form to the Page

Editing Input Fields in a Form

After you’ve added a form to the page, you can edit and reorder its fields.
EDITIONS
To reorder fields, drag them to the correct position on the page or in the Page Structure pane.
Alternatively, select a field and click > Move Up or > Move Down. Available in: Salesforce
Classic (not available in all
To hide a field, such as required field that you don’t want your site visitors to see, select Hidden
orgs)
Field in the Properties pane. When you hide a field, you can access it from the Page Structure
pane. Available for purchase in:
Enterprise, Performance,
To make a field a required field, which means the user must complete the field before submitting
and Unlimited Editions
the form, select Required Field in the Properties pane. A red asterisk (*) is displayed beside
the field to indicate that it’s required. You can’t change the Required Field setting for any Available (with limitations)
fields that are required by the object the form is connected to. in: Developer Edition

To rename a field, replace the name in the Label Name field in the Properties pane.
To change the appearance of a field on the page, select a different theme in the Properties pane. USER PERMISSIONS
If the field is in a form, you can only change the form’s theme.
To build, edit, and manage
Note: Site.com sites:
• Site.com
• You can’t move fields from a form onto the page. However, you can delete non-required
Publisher User
fields, or hide both required and non-required fields. field enabled on the user
• You can’t drag fields from the page onto a form. detail page
AND

SEE ALSO: Site administrator or

designer role assigned
Adding Input Fields to Forms or Pages at the site level
Input Field Properties
Setting the Default Value of Input Fields
Adding a Form to the Page

1183
Extend Salesforce with Clicks, Not Code Site.com

Input Field Types

When adding input fields to a form or page, the following field types are available. However, if the
EDITIONS
object connected to a form doesn't contain a particular field type, you can’t add that input field
type to the form. Available in: Salesforce
Classic (not available in all
Page Element Description orgs)
Checkbox Lets users set a true (selected) or false (deselected) value on Available for purchase in:
a form or page. Enterprise, Performance,
and Unlimited Editions
Currency Lets users enter a currency amount on a form or page.
Available (with limitations)
Date Lets users enter a date on a form or page. If the field’s in: Developer Edition
Date/Time Selector property is set to Popup
Calendar, the user can pick the date from a popup calendar.

Date/Time Lets users enter a date and time on a form or page. If the
field’s Date/Time Selector property is set to Popup
Calendar, the user can pick the values from a popup
calendar.

Email Lets users enter a valid email address on a form or page.

Multi-Select Picklist Lets users select one or more values from a list on a form or
page.

Number Lets users enter a whole number on a form or page.

Percent Lets users enter a percent amount on a form or page.

Phone Lets users enter a phone number on a form or page.

Picklist Lets users select a value from a list on a form or page.

Rich Text Area Lets users enter up to 32,768 characters on a form or page.
Supports any combination of letters, numbers, or symbols.
Users can format the text, and add images and hyperlinks.

Note: A rich text area field can’t be used for image

uploads in Site.com sites or Salesforce Sites due to
security constraints.

Text Lets users enter up to 255 characters (depending on the

field limit in the Salesforce object) on a form or page.
Supports any combination of letters, numbers, or symbols.

Text Area Lets users enter up to 32,768 characters on a form or page,

which display on separate lines. Supports any combination
of letters, numbers, or symbols.

1184
Extend Salesforce with Clicks, Not Code Site.com

Page Element Description

URL Lets users enter a valid website address on a form or page.

SEE ALSO:
Adding Input Fields to Forms or Pages
Input Field Properties
Adding a Form to the Page

Input Field Properties

When adding or editing input fields on a form or page, use the options in the Field Properties section
EDITIONS
of the Properties pane to control how the selected input field functions.
Available in: Salesforce
Name Description Classic (not available in all
Label Name The external name of the field. This is displayed orgs)
as the field name on the form or page. Available for purchase in:
Enterprise, Performance,
Default Value Sets the field’s default value. This automatically
and Unlimited Editions
populates the field with the value you specify
when the page loads. Available (with limitations)
in: Developer Edition
Required Field When selected, makes the field mandatory, so
the user can’t submit a record without entering
a value. A red asterisk (*) is displayed beside the
field to indicate that it’s required.
You can’t change the Required Field
setting for any fields that are required by the
object the form is connected to.

Hidden Field When selected, hides the field from the form or
page. For example, you may want to hide a
required field from your site visitors, or set the
default value for a field that you don’t want users
to see or edit. When you hide a field on the page
canvas, you can still access it from the Page
Structure pane.

Date/Time Selector Applies to the Date/Time field only. Sets

whether users can select the date and time
using a popup calendar.

Picklist Values Applies to Picklist and Multi-select

Picklist fields only, and only when added
directly to the page. Sets the list of items to
display in the picklist. (You can’t modify the
picklist items if the field is connected to an
object.)

1185
Extend Salesforce with Clicks, Not Code Site.com

Name Description
Each picklist item consists of a Label and a Value field. The
Label field is displayed in the picklist, whereas the Value field
is an internal value. In most situations, you can use the same value
in both fields, unless you want to submit a different value than the
one displayed to the user.

Click to enter values for the Label and Value fields.

Rows Applies to Rich Text Area and Text Area fields only.
Sets the number of rows of text to display.

SEE ALSO:
Input Field Types
Adding Input Fields to Forms or Pages
Editing Input Fields in a Form

Setting the Default Value of Input Fields

You can set the default value of an input field that you add to a form or page. This automatically
EDITIONS
populates the input field with the value you specify when the page loads.
When used with a field’s Hidden Field property, which hides the field on the form or page, Available in: Salesforce
the default value is a useful tool for submitting data that you don’t want your users to see. For Classic (not available in all
example, you could add a hidden field that uses the Global Property option to track when a form orgs)
is submitted. Available for purchase in:
Note: Default field values that are already set on the object aren’t transferred to Site.com. Enterprise, Performance,
and Unlimited Editions
To set the default value of a field: Available (with limitations)
1. Select the field. in: Developer Edition
2. Click Configure in the Properties pane.
3. Select the source of the default value. USER PERMISSIONS

Option Description To build, edit, and manage

Site.com sites:
Fixed Value Use when you want to specify the value. For • Site.com
example, for a text field, you could add default Publisher User
text. Alternatively, if the field is a picklist, you field enabled on the user
can select a default value from the list. detail page
AND
URL Query String Use when you want to pass variable content
Site administrator or
via a URL to the item when the page loads.
designer role assigned
For example, if you’re working with a picklist
at the site level
field, you could pass variable information, such
as location, to filter the list and display only
items from that location. See Data Filtering

1186
Extend Salesforce with Clicks, Not Code Site.com

Option Description
Examples for similar scenarios using data repeaters.

Global Property Use when you want to use a fixed value from the site, such as
the current date or current time.

Request Header Use when you want to use a value from the browser, such as the
host header or browser version.

4. Set the default value.

5. Click Save.

SEE ALSO:
Adding Input Fields to Forms or Pages
Editing Input Fields in a Form
Adding a Form to the Page

Setting a Form’s Submit Behavior

When your site visitors submit a form successfully, you can either redirect them to another page or
EDITIONS
display a message indicating that they were successful.
When the page is open: Available in: Salesforce
Classic (not available in all
1. Select the form in the Page Structure pane.
orgs)
2. In the Properties pane, select an option in the When Successful drop-down list.
Available for purchase in:
Enterprise, Performance,
Option Description
and Unlimited Editions
Show another page Redirects the user to the page that you specify. Available (with limitations)
Display a message Displays a message below the form. in: Developer Edition

USER PERMISSIONS
3. As appropriate, specify either:
To build, edit, and manage
• The page to redirect to in the Page URL field. You can enter a relative URL, such as a site Site.com sites:
page, or an absolute URL. For relative URLs, ensure you include a forward slash (/). • Site.com
• The message text in the Message Text field. Publisher User
field enabled on the user
Tip: The form’s Submit button uses the submit action in the Events pane. detail page
AND
Site administrator or
SEE ALSO:
designer role assigned
Adding a Form to the Page at the site level
Input Field Properties
Site.com Data Services Overview

1187
Extend Salesforce with Clicks, Not Code Site.com

Styling Forms
Forms are styled using CSS themes that you can customize to match the design of your website.
EDITIONS
When you add a form to a page, the form uses a default theme to control its appearance. To change
the form’s theme, select an option in the Theme section in the Properties pane: Available in: Salesforce
Classic (not available in all
• Default places the field name above the text box. Required fields are denoted by a red
orgs)
asterisk (*) beside the field name.
• Salesforce places the field name to the left of the text box. Required fields are denoted Available for purchase in:
by a red vertical bar (|) in front of the text box. Enterprise, Performance,
and Unlimited Editions
Alternatively, to customize a theme to suit your needs:
Available (with limitations)
1. Select the form on the page. in: Developer Edition
2. Select a theme to use as a base in the Theme section of the Properties pane.
3. Open the Style pane and ensure Class is selected. USER PERMISSIONS
4. In the Style drop-down list, select the part of the form that you want to style. When you select
an item, it's highlighted for a few seconds so you can easily see which part you're styling. To build, edit, and manage
Site.com sites:
• Site.com
Option Description
Publisher User
Entire form Styles the whole form. field enabled on the user
detail page
Field rows Styles each field row.
AND
Field labels Styles the labels of each field. Site administrator or
designer role assigned
Fields Styles the fields (text boxes, drop-down lists, at the site level
and so on). Only available for the Salesforce
theme.

Required symbol Styles the asterisk symbol (*) for required

fields. Only available for the default theme.

Error message Styles the error message that’s displayed when

users try to submit an incorrectly completed
form. Only available for the default theme.

Tip: If you're familiar with CSS, you can also modify the style of the form in the site's style sheet.

5. To style the selected part of the form, update the Style pane properties. Your theme customizations are reflected immediately in the
form, and apply to the selected form only.
6. Repeat as required for each part of the form.

SEE ALSO:
Adding a Form to the Page

1188
Extend Salesforce with Clicks, Not Code Site.com

The Default, Error, and No Data Views

When working with data repeaters, data tables, data functions, and forms, you can customize what
EDITIONS
your site visitors see if an error occurs when connecting to the data source. Additionally, for data
tables, data repeaters, data functions, you can customize what’s displayed when no data exists for Available in: Salesforce
the current query. For example, if you set up a data repeater to dynamically filter and display results Classic (not available in all
based on the user’s selection, but there are no results for that selection, you can display an orgs)
appropriate message to explain what happened.
Available for purchase in:
Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

• The Default View (1) is what usually appears on the page. For example, when you add a form to the page, the Default View contains
the form’s fields.
• The Error View (2) is displayed if an error occurs when connecting to the data source. It contains a content block with a default
message that you can customize. You can also add other page elements to the view.
• The No Data View (3) is displayed when no data exists for the current query. It contains a content block with a default message that
you can customize. You can also add other page elements to the view.

SEE ALSO:
Dynamically Retrieving Data with Data Repeaters
Dynamically Retrieving Data with Data Tables
Using Data Functions

1189
Extend Salesforce with Clicks, Not Code Site.com

Repairing Data Connections

If you or another user modifies the object that an existing data repeater, data table, data function,
EDITIONS
or form is connected to, the data connection might break. For example, this can happen if a
connected object or field is renamed or deleted, or if its permissions are changed. Available in: Salesforce
When you open a site page containing broken data connections, a dialog box that lists the problems Classic (not available in all
appears. Hover over each item's icon to see the possible solutions. orgs)

Available for purchase in:

Problem Solution Enterprise, Performance,
A data repeater, data table, or data function is Open the guest user profile and ensure the and Unlimited Editions
connected to an object that doesn’t have the “Read” permission is enabled on the object. Available (with limitations)
correct access permission, or has been renamed If that’s unsuccessful, click Edit beside the listed in: Developer Edition
or deleted. item to open the Data Connection dialog box,
and ensure the correct object is selected. If the
object has been renamed, select the renamed
object. If the object has been deleted, you must
either choose a different object or delete the
page element.

A data repeater, data table, or data function is Open the guest user profile and ensure the
trying to filter results using fields that are longer object has the correct field-level security
visible, or have been renamed or deleted. enabled for each field.
If that’s unsuccessful, click Edit beside the item
to open the Data Connection dialog box, and
reset the filter criteria.

A data element is connected to a field that’s no Open the guest user profile and ensure the
longer visible, or has been deleted or renamed. object has the correct field-level security
enabled for the field.
If that’s unsuccessful, click Edit beside the item
to open the Edit Data Element dialog box, and
ensure the correct fields are referenced in all
relevant drop-down lists and in any custom text.

A form is connected to an object that doesn’t Open the guest user profile and ensure the
have the correct access permission, or has been “Create” permission is enabled on the object.
renamed or deleted. If that’s unsuccessful, you must replace the form,
as you can’t edit a form’s data connection.

A form is missing one or more required fields, Add the missing field to the form.
which were added to the object after the form
was created.

A form field is pointing to a field that’s no longer Open the guest user profile and ensure the
visible, or has been renamed or deleted. object has the correct field-level security
enabled for the field.
If that’s unsuccessful, remove the field from the
form.

1190
Extend Salesforce with Clicks, Not Code Site.com

Note: If you’re a Communities user working with authenticated pages, keep in mind that object access on public and private
pages is controlled by the user profile of the authenticated user. The guest user profile controls object access on public pages for
unauthenticated visitors only.

SEE ALSO:
Setting Data Access Permissions for Salesforce Objects
Dynamically Retrieving Data with Data Repeaters
Adding Input Fields to Forms or Pages

Widgets Overview
Widgets let you save time by building custom page elements that you and your team can reuse
EDITIONS
throughout the site.
Using the existing Site.com page elements, such as panels, content blocks, custom code, or data Available in: Salesforce
repeaters, you can create widgets to suit your unique requirements. You can add custom properties Classic (not available in all
to allow greater flexibility over how your widgets are reused. And you can even add a widget to orgs)
another widget!
Available for purchase in:
By using CSS to style the widget, you can ensure it always appears correctly whenever it’s added Enterprise, Performance,
to site pages or page templates. Additionally, you can let contributors add widgets to site pages and Unlimited Editions
and add branding properties that enable contributors to update the widget’s appearance. Available (with limitations)
With widgets, you can: in: Developer Edition

• Minimize duplication in your site. You just build once, then reuse.
• Reduce maintenance overheads for you and your team. Any updates you make to a widget are
automatically reflected in copies of the widget on the page.
• Improve the load time of your pages.

Example: For example, you could use the custom code page element to create reusable social plug-in widgets, such as Like or
Follow buttons from Facebook, or a Twitter feed.
Alternatively, to ensure a consistent look and feel across all of your pages, you could create a corporate header such as this sample
header widget. It consists of a panel (1) that contains a company logo (2) and a menu (3). The widget also contains another widget
(4) that’s composed of a panel containing custom code for Facebook, Twitter, and RSS plug-ins.

You could also use widgets to store commonly used pieces of text, such as company names, addresses, legal text, and so on.
Simply create a widget that contains a content block with the relevant text.

1191
Extend Salesforce with Clicks, Not Code Site.com

Best Practices for Using Widgets

• Wherever possible, use widgets to reduce duplication in your site design. This is particularly important when working with complex
designs or site elements, where maintenance can be time consuming.
• If you plan to use the same widgets across several sites, consider creating a basic site to contain all the required widgets. Then, for
each new site, just create a copy of that basic site. That way, each new site automatically includes all of the widgets you created.
• When using CSS to style widgets, add the CSS to the Site Style Sheet, which is the site’s global style sheet. Because every page
automatically references the style sheet, you can ensure that each widget will appear correctly on the page.

Creating Widgets
Widgets let you create custom, reusable page elements by combining existing Site.com page elements, custom code, and CSS.
Adding a Widget to a Page
Editing and Deleting Widgets

SEE ALSO:
Creating Widgets
Custom Properties for Page Templates or Widgets Overview
Site Branding Overview

Creating Widgets
Widgets let you create custom, reusable page elements by combining existing Site.com page
EDITIONS
elements, custom code, and CSS.
When you create a widget, it’s added to the Widgets view on the Overview tab, where you can Available in: Salesforce
access and manage all of the site’s widgets. If you make it available, the widget also appears in the Classic (not available in all
Widgets section of the Page Elements tab, where you and your team can easily drag it onto the orgs)
page. You can also let contributors add widgets to site pages.
Available for purchase in:
1. Hover over Widgets on the Overview tab and click New, or click New Widget when the Enterprise, Performance,
Widgets view is open. and Unlimited Editions
2. Enter the widget name. This is name that appears in the Page Elements pane. Available (with limitations)
in: Developer Edition
3. Optionally, add a description.
The description appears as a tooltip in the Page Elements pane.
USER PERMISSIONS
4. To add a display icon for the widget, select an image from your imported assets. Use an icon
that’s 16 x 16 pixels in size. To build, edit, and manage
5. Optionally, deselect Available in the Page Elements Pane if you don’t want Site.com sites:
the widget to appear in the Page Elements pane. • Site.com
Publisher User
For example, you may not want the widget to appear until you’ve finished building it. field enabled on the user
6. Click Apply. Now you’re ready to add page elements to the widget. detail page
AND
7. Click the widget’s name to open it in a new tab.
Site administrator or
8. Add the page elements and CSS styles you need. designer role assigned
9. Optionally, add custom properties or branding properties to the widget. at the site level

1192
Extend Salesforce with Clicks, Not Code Site.com

After you finish building the widget, ensure it’s available in the Page Elements tab by selecting Available in Page Elements
Pane on the Properties pane.
To let contributor’s add a widget to a site page, select Available to Contributors on the Properties pane. This setting
controls whether the widget appears in the contributor’s Page Elements pane. You must also ensure that the site includes a template-based
site page with at least one editable panel.

SEE ALSO:
Widgets Overview
Custom Properties for Page Templates or Widgets Overview
Site Branding Overview
Adding a Widget to a Page

Adding a Widget to a Page

Before you can add a widget to a page, you must make sure it’s available for use. Either:
EDITIONS
• Select Available in Page Elements pane in the Properties pane when the widget
is open. Available in: Salesforce
• Hover over the widget in the Widgets view on the Overview tab, select > Edit Properties, Classic (not available in all
orgs)
and select Available in Page Elements pane.
When the page is open: Available for purchase in:
Enterprise, Performance,
1. Drag the widget from the Widgets section of the Page Elements pane onto the page. and Unlimited Editions
When you add a widget to a page, it creates a copy or instance of the widget. You can’t edit
Available (with limitations)
this widget instance.
in: Developer Edition
2. If available, update the properties in the widget instance’s Properties pane.

SEE ALSO: USER PERMISSIONS

Widgets Overview To build, edit, and manage
Custom Properties for Page Templates or Widgets Overview Site.com sites:
• Site.com
Editing and Deleting Widgets
Publisher User
Creating Widgets field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1193
Extend Salesforce with Clicks, Not Code Site.com

Editing and Deleting Widgets

Access the site’s widgets in the Widgets view under All Site Content (on the Overview tab).
EDITIONS
To update a widget, hover over it and click . From the menu, you can:
Available in: Salesforce
• Edit the widget. When you edit a widget, it opens in a new tab. Any updates you make are
Classic (not available in all
reflected immediately in the site pages or page templates that reference it.
orgs)
• Update the widget’s properties, including the name, description, display icon, and availability.
In the Widgets view, you can also edit the name, description, or availability inline by Available for purchase in:
double-clicking the item. Enterprise, Performance,
and Unlimited Editions
• Duplicate, preview, or delete the widget. You can’t delete a widget if it’s being used on a site
page, page template, or another widget. Available (with limitations)
in: Developer Edition

SEE ALSO:
Widgets Overview USER PERMISSIONS
Creating Widgets To build, edit, and manage
Adding a Widget to a Page Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

Multilingual Sites Overview

Site.com Studio lets you to create different language versions of your site. And because all languages
EDITIONS
are maintained within the site, you don’t need to create and manage a separate site for each
language. Available in: Salesforce
As a site administrator or designer, you can add and manage the languages that you want your site Classic (not available in all
to support. After you add a language to the site, you’ll notice the Site.com Studio language selector orgs)
on the toolbar, which lets you and your team switch between languages when editing the content
Available for purchase in:
of a page. This makes content editing quick and easy because you never have to leave the page to Enterprise, Performance,
change to another language. and Unlimited Editions
Available (with limitations)
in: Developer Edition

Contributors, designers, and site administrators can each add language-specific content to a page using the language selector.
As a site administrator or designer, you can also export site content as an .xml file and send it to your translation service. After you receive
the edited file, simply import it back into your site to populate each page with the translated content.

1194
Extend Salesforce with Clicks, Not Code Site.com

In turn, to let your site visitors choose their preferred language from those available when viewing the site, you can add a Language
Selector page element to your pages. And in case any part of the site content isn’t available in their chosen language, you can specify a
fallback language to display instead.

Example: For example, if a site visitor chooses French (CA) from the language selector, but there is no content for that page in
French (CA), content in the fallback language—say, French (FR)—is displayed instead.

Create a Multilingual Site

Creating a multilingual site is a multistep process. It involves defining the languages you want your site to support, adding translated
content for each language, and letting your site visitors choose their preferred language.
Setting the Default Language
The default language is the language in which your site initially displays. By default, it’s set to English (US), and it serves as the starting
point when you add new languages.
Adding Languages
Add the languages you want your site to support.
Setting Language Options
After you add site languages in the Languages view, you can define separate settings for each one.
About Editing Language Content
The default language is the language in which your site initially displays. By default, it’s set to English (US), and it serves as the starting
point when you add new languages. So for example, if you build your site and then add French as a site language, the French version
initially contains English (US) content until you replace it with French-specific content.
Editing Language Content on the Page
The Site.com Studio language selector lets you switch between languages as you edit content on each page. Contributors, designers,
and site administrators can each add language-specific content to a page using the language selector.
Language-Aware Properties
Several properties in the Properties pane are language aware, meaning they can store different values for each language.
Exporting Language Content
Export one or more site languages as an .xml file that you can send to your translation service.
Importing Translated Content
You can import a translated .xml file back into your site after your translation service has completed the translations.
Adding a Language Selector Page Element
The language selector lets your site visitors choose their preferred language when viewing a site.
Deleting Languages
When you delete a language, the translated content is not actually deleted—it’s just no longer available to your or your team. As
soon as you add the language back to the site, you can access the translated content again.

SEE ALSO:
Create a Multilingual Site
About Editing Language Content

1195
Extend Salesforce with Clicks, Not Code Site.com

Create a Multilingual Site

Creating a multilingual site is a multistep process. It involves defining the languages you want your
EDITIONS
site to support, adding translated content for each language, and letting your site visitors choose
their preferred language. Available in: Salesforce
1. Set the default site language. It’s important that you do this before you begin adding translated Classic (not available in all
content to your site. orgs)

2. Add languages to the site. Available for purchase in:

3. Set options for each language, such as the display language and fallback language. Enterprise, Performance,
and Unlimited Editions
4. Add content for each site language one of two ways:
Available (with limitations)
• Edit the page content for each language directly. in: Developer Edition
• Export the content for translation and then import the translated content.

5. Add a Language Selector page element to your site pages, so authenticated site users can USER PERMISSIONS
choose their preferred language.
To add and manage
6. If you have a self-service community built on the Customer Service template, add the Language language options:
Selector component to your community pages. This allows guest users (users who aren't logged • Site.com
in) to choose their preferred language. Publisher User
field enabled on the user
Tip: After you add language-specific content to your site, you can share a separate preview
detail page
URL for each language. Just switch to the desired language in the Site.com Studio language
AND
selector and click View Anonymous Preview. Then copy the link to send it to your reviewers.
Site administrator or
designer role assigned
SEE ALSO: at the site level
Multilingual Sites Overview
To edit language content:
About Editing Language Content • Site.com
Publisher User or
Contributor User
field enabled on the user
detail page and any role
assigned at the site level

1196
Extend Salesforce with Clicks, Not Code Site.com

Setting the Default Language

The default language is the language in which your site initially displays. By default, it’s set to English
EDITIONS
(US), and it serves as the starting point when you add new languages.
It’s important to set the default language before you add any language content to your site. This Available in: Salesforce
setting is not associated with the default language setting in your Salesforce organization. Classic (not available in all
orgs)
1. Click Site Configuration > Languages on the Overview tab.
2. Select a language in the Default Site Language drop-down list. Available for purchase in:
Enterprise, Performance,
Note: If you decide to change the default language after you add translated content, you and Unlimited Editions
must first export the translated content, then change the default language, and finally, import Available (with limitations)
the content back into your site. Otherwise the translated content won’t appear for the newly in: Developer Edition
selected default language.
For example, let’s say you make English the default site language and add French as a site
language. After you add content in both English and French, you decide to change the default USER PERMISSIONS
site language to French. To preserve the French content, you must first export it. Then, select
To add and manage
French as the default site language before importing the French content back into the site. language options:
• Site.com
Publisher User
SEE ALSO:
field enabled on the user
Adding Languages detail page
Setting Language Options AND
Site administrator or
designer role assigned
at the site level

1197
Extend Salesforce with Clicks, Not Code Site.com

Adding Languages
Add the languages you want your site to support.
EDITIONS
1. Click Site Configuration > Languages on the Overview tab.
Available in: Salesforce
2. Click Add Languages.
Classic (not available in all
3. Select the languages you want to add to your site. orgs)
4. If necessary, reorder the list as you want it to appear in any language selector. Available for purchase in:
5. Save your changes. Enterprise, Performance,
and Unlimited Editions

SEE ALSO: Available (with limitations)

in: Developer Edition
Setting the Default Language
Setting Language Options
Deleting Languages USER PERMISSIONS

To add and manage

language options:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1198
Extend Salesforce with Clicks, Not Code Site.com

Setting Language Options

After you add site languages in the Languages view, you can define separate settings for each one.
EDITIONS
1. Click Site Configuration > Languages on the Overview tab.
Available in: Salesforce
2. Select a language in Site Languages.
Classic (not available in all
3. Update the options in Language Settings: orgs)

Option Description Available for purchase in:

Enterprise, Performance,
Active on Live Site If you add a language selector element on and Unlimited Editions
your active site, this checkbox controls Available (with limitations)
whether the language shows in the in: Developer Edition
drop-down list. Use the property to hide a
language until you’re ready to release the
associated content to your site visitors. USER PERMISSIONS
Fallback Language The fallback language displays when there’s To add and manage
no content available for the currently selected language options:
language. For example, if a site visitor chooses • Site.com
Japanese from the language selector, but Publisher User
there is no content for that page in Japanese, field enabled on the user
content in the fallback language is displayed detail page
instead. AND

Display Label You can define the display label for each Site administrator or
designer role assigned
language. It appears in any language selectors
at the site level
you add to your site, and in the Site.com
Studio language selector.

SEE ALSO:
Adding Languages
Setting the Default Language

About Editing Language Content

The default language is the language in which your site initially displays. By default, it’s set to English
EDITIONS
(US), and it serves as the starting point when you add new languages. So for example, if you build
your site and then add French as a site language, the French version initially contains English (US) Available in: Salesforce
content until you replace it with French-specific content. Classic (not available in all
After you add a language to your site, the Site.com Studio language selector appears on the toolbar. orgs)
It lets you switch between languages as you edit content on each page. For example, if you add
Available for purchase in:
French and Spanish to your site, the language selector displays French, Spanish, and English (US). Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

1199
Extend Salesforce with Clicks, Not Code Site.com

Content blocks display icons to let you know whether content for the selected language has been replaced.
• A warning icon ( ) indicates that the text that has not yet been replaced.
• A globe icon ( ) indicates that the content has been replaced.
In addition, several page elements have language aware properties, meaning they can store different values for each language. These
properties are indicated in the Properties pane by a globe icon ( ).
You can add content for each site language one of two ways:
• Edit the page content for each language directly using the Site.com Studio language selector.
• Export the content for translation and then import the translated content back into the site.

Language Display Order

After you add language-specific content to your site, content on the page is displayed in the following order, depending on which
language content is available:
1. Selected language
2. Fallback language
3. Default language
For example, if you delete the French contents of a content block, and Spanish is the fallback language, the Spanish content is displayed
rather than the default language content. In turn, if you delete the Spanish content, then the default language content is displayed.

Language–Aware Page Elements

The following page elements support translated content:
• Content Block
• Custom Code
• Data Element
• Form
• Input Fields
• Image
• Language Selector

SEE ALSO:
Language-Aware Properties

1200
Extend Salesforce with Clicks, Not Code Site.com

Editing Language Content on the Page

The Site.com Studio language selector lets you switch between languages as you edit content on
EDITIONS
each page. Contributors, designers, and site administrators can each add language-specific content
to a page using the language selector. Available in: Salesforce
When the page is open: Classic (not available in all
orgs)
1. Select a language in the Sie.com Studop language selector (the Change Site Language
drop-down list on the toolbar). Available for purchase in:
2. Edit the page content. Enterprise, Performance,
and Unlimited Editions
If you’re viewing a content block in a specific language:
Available (with limitations)
• A warning icon ( ) indicates that the text that has not yet been replaced. in: Developer Edition
• A globe icon ( ) indicates that the content has been replaced.

3. Optionally, update the language-aware properties as required. USER PERMISSIONS

Note: Site.com Studio does not validate languages as you enter content. Take care to add To add and manage
the correct content for the selected language. language options:
• Site.com
To revert translated content, right-click the content block and select Revert Translation. Text
Publisher User
reverts to the fallback language, if specified, or else to the default site language. field enabled on the user
detail page
SEE ALSO: AND
About Editing Language Content Site administrator or
designer role assigned
at the site level

To edit language content:

• Site.com
Publisher User or
Contributor User
field enabled on the user
detail page and any role
assigned at the site level

Language-Aware Properties
Several properties in the Properties pane are language aware, meaning they can store different
EDITIONS
values for each language.
If you don’t specify language-specific properties for a page or page element, the property values Available in: Salesforce
of the default languages are used instead. Classic (not available in all
orgs)
Property Applies To Description Available for purchase in:
Alternative Image Used by screen reader users or as a substitute if the browser Enterprise, Performance,
Text can’t display the image. It can also help with search engine and Unlimited Editions
optimization (SEO). Available (with limitations)
in: Developer Edition

1201
Extend Salesforce with Clicks, Not Code Site.com

Property Applies To Description

Do Not • Content Block Prevents the item’s content from being translated. When selected, the globe icon ( )
Translate is removed from language-aware properties, indicating that they no longer support
• Custom Code
language-specific content.
• Data Element
If you add language-specific content and subsequently enable this property, your
• Form
language-specific content is simply hidden. If you disable the property again, the
• Input Fields content reappears.
• Image
• Language Selector
• Page

Home Page Language Selector Redirects site visitors to a different page when they choose a language. The URL is the
URL same for all languages.

Image Image Lets you specify the image to display for the selected language.
Asset For example, with English (US) selected in the Site.com Studio language selector, select
the English version of an imported image. Then, to enter a French version of the same
image, select French in the language selector and select the French image.

Label Language Selector The label that appears beside the Language Selector page element when it’s added
to a page. “Change Site Language” is the default text.
The text is translatable, so you can either choose a language in the Site.com Studio
language selector and update the text for each language, or export all site content for
translation.

Navigation Page The page name that appears in a navigation menu.

Name

Title Page The title that appears in the title bar of browser windows.

Visible in Page If you add a menu to your site, controls whether the page appears in the menu for the
Live Site selected language. Additionally, the page is no longer accessible via its language-specific
URL.
If Do Not Translate is also enabled, the status of Visible in Live
Site applies to all languages.

SEE ALSO:
Editing Language Content on the Page
About Editing Language Content

1202
Extend Salesforce with Clicks, Not Code Site.com

Exporting Language Content

Export one or more site languages as an .xml file that you can send to your translation service.
EDITIONS
1. In the Languages view on the Overview tab, click > Export Content for Translation.
Available in: Salesforce
2. Select the language content that you want to export for translation. (Use CTRL+click to select
Classic (not available in all
multiple items.)
orgs)
3. Optionally, enter a different filename. The default name is languages.xml.
Available for purchase in:
4. Click OK. Enterprise, Performance,
5. If required by your browser, choose where to save the file. and Unlimited Editions

After you export the .xml file, you can send it for translation. Available (with limitations)
in: Developer Edition
Example: The .xml file contains a time stamp attribute that records the time of the export,
and encloses all translatable content in CDATA sections, as shown in this example.
USER PERMISSIONS

To add and manage

language options:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
When you receive the translated .xml file, import it back into the site. at the site level

SEE ALSO:
Importing Translated Content
About Editing Language Content

1203
Extend Salesforce with Clicks, Not Code Site.com

Importing Translated Content

You can import a translated .xml file back into your site after your translation service has completed
EDITIONS
the translations.
1. In the Languages view on the Overview tab, click > Import Translated Content. Available in: Salesforce
Classic (not available in all
2. Browse to the location of the translated .xml file.
orgs)
3. Select the file and click Open.
Available for purchase in:
4. Decide whether to overwrite the current site content. Enterprise, Performance,
5. Click Import. and Unlimited Editions
A message appears to indicate whether the content was imported successfully, unless the file Available (with limitations)
is over 1 MB. In that case, you’ll receive an email when the import process finishes. in: Developer Edition
After you import the translated content, test your pages to make sure the content displays correctly.
For each page, use the Site.com Studio language selector to view the page in each supported
USER PERMISSIONS
language.
To add and manage
SEE ALSO: language options:
• Site.com
Exporting Language Content
Publisher User
About Editing Language Content field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

1204
Extend Salesforce with Clicks, Not Code Site.com

Adding a Language Selector Page Element

The language selector lets your site visitors choose their preferred language when viewing a site.
EDITIONS
After you add languages to your site, you need to let site visitors select their preferred language
from the list of languages you defined in the Languages view. Available in: Salesforce
Classic (not available in all
Tip: To save time, add the language selector to your site’s page templates. orgs)
When the page is open: Available for purchase in:
1. Drag a Language Selector from the Page Elements pane onto the page. Enterprise, Performance,
Site visitors will see a Change Site Language drop-down list when they visit the page. and Unlimited Editions
Available (with limitations)
2. Set properties for the language selector:
in: Developer Edition

Property Description
Do Not Translate Select this checkbox if you want the text in USER PERMISSIONS
the Label field to remain the same for all
To add and manage
languages.
language options:
Label The label that appears beside the Language • Site.com
Selector page element when it’s added to a Publisher User
page. “Change Site Language” is the default field enabled on the user
detail page
text.
AND
The text is translatable, so you can either
choose a language in the Site.com Studio Site administrator or
designer role assigned
language selector and update the text for each
at the site level
language, or export all site content for
translation.

Home Page URL Redirects site visitors to a different page when

they choose a language. The URL is the same
for all languages.

SEE ALSO:
Language-Aware Properties

1205
Extend Salesforce with Clicks, Not Code Site.com

Deleting Languages
When you delete a language, the translated content is not actually deleted—it’s just no longer
EDITIONS
available to your or your team. As soon as you add the language back to the site, you can access
the translated content again. Available in: Salesforce
1. Click Site Configuration > Languages of the Overview tab. Classic (not available in all
orgs)
2. Click beside the language you want to delete.
Available for purchase in:
Enterprise, Performance,
SEE ALSO: and Unlimited Editions
Adding Languages Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To add and manage

language options:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator or
designer role assigned
at the site level

Events Overview
Events enable you to add interactive and animated effects to the pages and page elements of your
EDITIONS
website.
When an event occurs—say, when a user clicks an element on the page or when the page Available in: Salesforce
loads—you can specify what action (or series of actions) it should trigger. For example, when your Classic (not available in all
home page loads, you could display a news bulletin popup that fades away after several seconds. orgs)
Or when the user clicks a panel, you could expand the panel to reveal additional information or
Available for purchase in:
alter its style. Enterprise, Performance,
The Events pane lists many common actions that you can trigger when an event occurs. Using the and Unlimited Editions
options here, you can specify that: Available (with limitations)
When [this event] occurs, trigger [this action]. in: Developer Edition

Creating an Event

1206
Extend Salesforce with Clicks, Not Code Site.com

Available Events and Actions

SEE ALSO:
Creating an Event
Available Events and Actions
Using Site.com Studio as a Site Administrator or Designer

Creating an Event
Use events to add interactive and animated effects to the pages and page elements of your website.
EDITIONS
1. Select the relevant page or page element.
Available in: Salesforce
2.
Select an event in the Events pane ( ). See Available Events and Actions. Classic (not available in all
3. orgs)
Click and select an action in the Choose an Action list that appears.
Available for purchase in:
4. Set the other available properties for the action, such as: Enterprise, Performance,
• Target Element—specifies the page element that the action affects and Unlimited Editions
• Effect—specifies how the action is animated, such as fade or slide. Available (with limitations)
• Speed—sets the speed of the animation to fast, normal, slow, or very slow in: Developer Edition

• Chained—allows you to chain actions so they occur sequentially. For example, to create a
Delay action that delays the action that follows it, select the Delay action's Chained checkbox. USER PERMISSIONS
This indents the subsequent action underneath the Delay action, indicating that it's tied to
the Delay action. Applies to the Animate, Delay, Hide Element, Repeat, Show Element, and To build, edit, and manage
Toggle Element actions. Site.com sites:
• Site.com
5. Click Save. Publisher User
6. Add more actions if required. field enabled on the user
detail page
Tip: AND
• When you add an event to a page or page element, an asterisk (*) appears beside the Site administrator or
event in the Events pane. designer role assigned
at the site level
• If you hover over on a selected page element, a tooltip appears indicating which
events are associated with the element. You can also click the icon to quickly open the
Events tab.

To delete an action, select it and click .

To change the order in which an action occurs, select it and click or .

SEE ALSO:
Adding Pagination to Data Repeaters and Data Tables
Events Overview

1207
Extend Salesforce with Clicks, Not Code Site.com

Available Events and Actions

Choose from several event triggers and actions when you create an event.
EDITIONS

When This Event Occurs... Available in: Salesforce

Classic (not available in all
Event Occurs When... orgs)

Double click The user double-clicks the page element. Available for purchase in:
Enterprise, Performance,
Click The user clicks the page element. and Unlimited Editions

Focus The focus moves to the page element. Available (with limitations)
in: Developer Edition
Load The page or page element is loaded in a browser window.

Blur The focus moves from the page element.

Mouse in The user moves the mouse pointer over the page element.

Mouse out The user moves the mouse pointer out of the page element.

Trigger This Action...

Action Description
Add CSS Class Dynamically adds a CSS class to style the targeted item. For example, to alter the appearance of a page
element, you could add a new CSS class to it.

Alert Displays a popup browser alert message.

Animate Animates CSS properties, such as Top, Left, Width, and Height, which you specify by entering appropriate
values in the CSS field.
For example, if targeting an image, you can enter values such as opacity: "0.4", width:
"70%", which changes the image's appearance according to the speed and effect you set.

Delay Adds a delay (measured in milliseconds) before the action that follows. (Ensure you select the Chained
checkbox to tie it to the subsequent action.)

Execute JavaScript Runs custom JavaScript code, which you enter by clicking Edit Script to open the Custom Code Editor.

Go To Page Goes to the designated page number in data repeaters and data tables. See Adding Pagination to Data
Repeaters and Data Tables on page 1167.

Hide Element Hides the targeted item according to the speed and effect you set.

Next Page Goes to the next page in data repeaters and data tables. See Adding Pagination to Data Repeaters and
Data Tables on page 1167.

Previous Page Goes to the previous page in data repeaters and data tables. See Adding Pagination to Data Repeaters
and Data Tables on page 1167.

Remove CSS Class Removes a CSS class from the targeted item to dynamically remove its style. For example, to alter the
appearance of a page element, you could remove the CSS class associated with it and replace it with
another.

1208
Extend Salesforce with Clicks, Not Code Site.com

Action Description
Repeat Repeats the action that follows by the specified number of times, with the specified delay between each
occurrence. (Ensure you select the Chained checkbox in the Properties pane to tie it to the following
action.)

Set Element Attribute Dynamically sets the specified attribute value of the targeted item. For example, if targeting an image,
you could change the image source by entering src in the Attribute Name field and entering
the image URL in the Attribute Value field. You can also add custom name/value pairs for advanced
coding purposes.

Show Element Reveals the targeted item according to the speed and effect you set.

Submit Submits the selected form's data.

Toggle Element Switches the visibility of the targeted element according to the speed and effect you set.

SEE ALSO:
Adding Pagination to Data Repeaters and Data Tables
Events Overview

Understanding the Contributor’s Page Editing View

Open a site page on the Overview tab by double-clicking the page or hovering over it and clicking
EDITIONS
> Edit. The page opens as a new tab.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To edit only content in

Site.com sites:
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1209
Extend Salesforce with Clicks, Not Code Site.com

• Using the toolbar (1), you can:

– Undo and redo your actions.
– Import assets, such as images and files.
– Preview the page in a browser window.
– Update the appearance of the page using the Branding Editor.

• Using the Page Elements pane (2), you can drag content blocks and widgets (if available) to editable areas of the page.
• On the page canvas (3), you can edit page text and add images. If editable areas are available, you can drag page elements to the
page.
• Using the live mode options (4), you can see how the page appears on various devices when the page is live.

Creating Site Pages as a Site.com Contributor

Editing Content Blocks as a Contributor
Content blocks contain the text of your website pages, and can also house images and hyperlinks. As a contributor, you can edit the
text in editable content blocks using an inline editor. Because you’re editing the text inline, you always know exactly how the finished
page will look when it’s live.
Understanding the Inline Editing Toolbar
Adding Images to Text as a Contributor
As a contributor, you can quickly add images to any editable text areas on the page using an inline editor.
Attaching Hyperlinks to Text and Images as a Contributor
As a contributor, you can use the inline editor to quickly add hyperlinks to text or images in any editable text areas on the page.
Adding Page Elements to Pages as a Contributor
As a contributor, you can add page elements to any editable areas of a page.

SEE ALSO:
Creating Site Pages as a Site.com Contributor
Using Site.com Studio as a Contributor
Understanding the Inline Editing Toolbar

1210
Extend Salesforce with Clicks, Not Code Site.com

Creating Site Pages as a Site.com Contributor

If your site administrator or designer has enabled page creation, you can add pages to your site.
EDITIONS
To add a new page:
Available in: Salesforce
1. In the Site Pages view on the Overview tab, click New Site Page.
Classic (not available in all
2. Enter the page name. orgs)
3. Select a template for the page. Available for purchase in:
4. Click Create. The site page opens. Enterprise, Performance,
and Unlimited Editions

SEE ALSO: Available (with limitations)

in: Developer Edition
Using Site.com Studio as a Contributor

USER PERMISSIONS

To edit only content in

Site.com sites:
• Site.com
Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

1211
Extend Salesforce with Clicks, Not Code Site.com

Editing Content Blocks as a Contributor

Content blocks contain the text of your website pages, and can also house images and hyperlinks.
EDITIONS
As a contributor, you can edit the text in editable content blocks using an inline editor. Because
you’re editing the text inline, you always know exactly how the finished page will look when it’s Available in: Salesforce
live. Classic (not available in all
Editable content blocks display a gray border when you hover over the text. You can edit the text orgs)
in these areas only.
Available for purchase in:
When the page is open: Enterprise, Performance,
and Unlimited Editions
1. Double-click the text area you want to edit.
The inline editor appears. Available (with limitations)
in: Developer Edition
2. Add or edit text, and format it using the inline editor.
Avoid applying formatting, such as different fonts or highlighting, directly to text whenever
possible. Instead, it’s best practice to use the paragraph and heading styles to quickly apply USER PERMISSIONS
consistent formatting throughout the site. This also ensures that all page text is updated
automatically if a site administrator or designer modifies the site's paragraph and heading styles. To edit only content in
Site.com sites:
3. Add images or hyperlinks as required. • Site.com
Your changes are saved automatically when you click anywhere outside the text area. Contributor User
field enabled on the user
detail page
SEE ALSO: AND
Previewing How Pages Appear on Mobile Devices Contributor role
Understanding the Contributor’s Page Editing View assigned at the site level

Understanding the Inline Editing Toolbar

As a contributor, you can use the inline editor to edit any editable text areas on the page. Editable
EDITIONS
areas display a gray border when you hover over the text.
Available in: Salesforce
Classic (not available in all
orgs)

Available for purchase in:

Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

The inline editor lets you:

• Control the text style and layout (1) by:
– Applying bold or italic formatting
– Inserting numbered or bulleted lists

• Add images and hyperlinks, and remove unwanted formatting (2).

• Expand the toolbar (3) to access additional options (4–8).

1212
Extend Salesforce with Clicks, Not Code Site.com

• Undo and redo your edits (4).

• Control the text style and layout (5) by:
– Applying underline formatting
– Setting text alignment
– Applying blockquote formatting

• Set paragraph indentation (6).

• Apply paragraph and heading styles (7).
• Apply additional styles, such as highlighting (8).

Tip: Avoid applying formatting, such as different fonts or highlighting, directly to text whenever possible. Instead, it’s best practice
to use the paragraph and heading styles to quickly apply consistent formatting throughout the site. This also ensures that all page
text is updated automatically if a site administrator or designer modifies the site's paragraph and heading styles.

SEE ALSO:
Editing Content Blocks as a Contributor
Previewing How Pages Appear on Mobile Devices
Understanding the Contributor’s Page Editing View

Adding Images to Text as a Contributor

As a contributor, you can quickly add images to any editable text areas on the page using an inline
EDITIONS
editor.
Editable text areas display a grey border when you hover over the text. You can add images to these Available in: Salesforce
areas only. Classic (not available in all
orgs)
When the page is open:
1. Double-click the text area you want to edit. Available for purchase in:
The inline editor appears. Enterprise, Performance,
and Unlimited Editions
2. Position your cursor where you want to insert the image and click .
Available (with limitations)
3. In the Image Properties dialog box, enter a URL to an image in the URL field. in: Developer Edition
For example, to add an image that you uploaded to the site, type / followed by the image
filename, such as /myimage.png.
USER PERMISSIONS
4. Enter a brief description of the image in the Alternative text field. The description is
used by screen reader users or as a substitute if the browser can’t display the image. It can also To edit only content in
help with search engine optimization (SEO). Site.com sites:
5. Optionally, preview how the image appears in relation to the text on the page and set: • Site.com
Contributor User
• The width and height of the image field enabled on the user
• The image border (for example, to set a border that's 10 pixels wide, enter 10 in the detail page
Border field) AND
• How much space surrounds the image (which is controlled by the HSpace and VSpace Contributor role
properties) assigned at the site level
• How the image aligns with the text on the page

6. Click OK.

1213
Extend Salesforce with Clicks, Not Code Site.com

Your changes are saved automatically when you click anywhere outside the text area.

SEE ALSO:
Editing Content Blocks as a Contributor
Understanding the Inline Editing Toolbar
Previewing How Pages Appear on Mobile Devices
Understanding the Contributor’s Page Editing View

Attaching Hyperlinks to Text and Images as a Contributor

As a contributor, you can use the inline editor to quickly add hyperlinks to text or images in any
EDITIONS
editable text areas on the page.
Editable text areas display a gray border when you hover over the text. You can add hyperlinks in Available in: Salesforce
these areas only. Classic (not available in all
orgs)
When the page is open:
1. Double-click the text area you want to edit. Editable text areas display a gray border when you Available for purchase in:
hover over the text. Enterprise, Performance,
and Unlimited Editions
The inline editor appears.
Available (with limitations)
2. Select the text or image that you want to attach a hyperlink to and click .
in: Developer Edition
3. Select the link type.
• To link to a page or item in your site, or to an external page:
USER PERMISSIONS
a. Select URL.
b. Select the protocol. To build, edit, and manage
Site.com sites:
c. In the URL field, select an item in your site, or type the address to an external page—for • Site.com
example, http://www.externalsite.com. (If you can’t see the list of site Publisher User
items, place your cursor in the URL field and press the DOWN key on your keyboard.) field enabled on the user
detail page
• To link to an anchor that was previously added to the page, select Link to anchor in the
AND
text and select the anchor in the drop-down list.
Site administrator or
• To link to an email message, select An email, and enter the recipient's email address and designer role assigned
the message information. at the site level

4. Click OK. To edit only content in

Your changes are saved automatically when you click anywhere outside the text area. Site.com sites:
• Site.com
Contributor User
SEE ALSO:
AND
Editing Content Blocks as a Contributor
Contributor role
Understanding the Inline Editing Toolbar assigned at the site level
Previewing How Pages Appear on Mobile Devices
Understanding the Contributor’s Page Editing View

1214
Extend Salesforce with Clicks, Not Code Site.com

Adding Page Elements to Pages as a Contributor

As a contributor, you can add page elements to any editable areas of a page.
EDITIONS
Page elements are the building blocks of site pages. Content blocks contain the text of your website
pages and can house images and hyperlinks. Widgets are custom page elements that are created Available in: Salesforce
by your designer or site administrator. If you can’t see widgets, they’re not available to you. Classic (not available in all
orgs)
• To add a page element to an open page, drag the element from the Page Elements pane to an
editable area. When you drag a page element to an editable page area, the area is highlighted Available for purchase in:
with a blue border. If you can’t see a blue border, the page doesn’t have any editable areas. Enterprise, Performance,
and Unlimited Editions
Available (with limitations)
in: Developer Edition

USER PERMISSIONS

To edit only content in

Site.com sites:
• Site.com
• To move a page element on the page, drag the page element to another editable area. Contributor User
field enabled on the user
detail page
AND
Contributor role
assigned at the site level

•
To delete a page element, click .
After you add a content block to a page, double-click the content block to edit it.
When you add a widget to the page, you might need to specify properties for the widget in a dialog box, which automatically saves
your changes. To dismiss the dialog box, click another area of the screen. For more information about the properties, contact your
designer or site administrator.

SEE ALSO:
Editing Content Blocks as a Contributor
Understanding the Contributor’s Page Editing View
Previewing How Pages Appear on Mobile Devices

1215
Extend Salesforce with Clicks, Not Code Site.com

Previewing How Pages Appear on Mobile Devices

With live mode, site administrators, designers, and contributors can preview how pages and
EDITIONS
templates appear on devices such as cell phones and tablets.
Site.com contributors are automatically placed in live mode for all content editing. They can edit Available in: Salesforce
the content blocks they've been given access to by the site administrators. Classic (not available in all
orgs)
Site administrators and designers can switch between live and design modes by clicking Live or
Design on the Site.com Studio toolbar. Design mode is the default view for site administrators and Available for purchase in:
designers. Enterprise, Performance,
and Unlimited Editions
• To preview how the page looks:
Available (with limitations)
– On smartphones, click . in: Developer Edition
– On tablets, click .
– USER PERMISSIONS
On computer screens, click .
– At 100% width and height, click . To build, edit, and manage
Site.com sites:
• To manually adjust the width of the screen, move the slider . • Site.com
• To resize the width and height of the screen, drag the resizing handles at the edge of the frame Publisher User
field enabled on the user
to the required size.
detail page
• To store frequently used custom screen sizes, click and enter the custom measurements.
AND
• To rotate the screen orientation from portrait to landscape, click . Site administrator or
designer role assigned
SEE ALSO: at the site level

Editing Content Blocks as a Contributor

Understanding the Contributor’s Page Editing View
Editing Site.com Pages as a Designer or Site Administrator

1216
Extend Salesforce with Clicks, Not Code Site.com

Previewing Site.com Sites

Contributors, designers, and site administrators can preview site pages to see how they look when
EDITIONS
rendered in a browser window. It's always a good idea to make sure your changes are displayed
correctly, as this is how the pages appear on the live site. Available in: Salesforce
If you're a site administrator or designer, you can also create an anonymous preview URL that allows Classic (not available in all
other users to review the site before it goes live. The URL is always valid (unless you disable it) and orgs)
shows the latest work in progress. It’s only available to the people you send it to, and can’t be found
Available for purchase in:
by search engines. Enterprise, Performance,
• Click Preview Page on the toolbar when editing a page. and Unlimited Editions
• Hover over a page in the Site Pages view of the Overview tab and click > Preview to view Available (with limitations)
a single page. in: Developer Edition
• Click Preview on the toolbar of the Overview tab to view the entire site. From the Preview
menu, you can also:
USER PERMISSIONS
– Click Preview Site in a New Tab to view the site in a new tab in the existing browser
window. To build, edit, and manage
Site.com sites:
– Click Preview Site at 1024 x 768 to view the site as it appears to laptop users.
• Site.com
– Click Enable Anonymous Preview, if you're a site administrator or designer, to create a Publisher User
URL that allows other users to preview the site before it goes live. Click the View field enabled on the user
Anonymous Preview option that appears in the Preview menu to access the preview detail page
URL, which you can copy and send to other users to review and test your changes. Enable AND
Anonymous Preview is also available in the Site Configuration view.
Site administrator or
• Click Preview beside a site on the Site.com home page to view the entire site. designer role assigned
at the site level
When you preview pages, all browser-related functions should work.
To edit only content in
Note: During preview only, style sheets are rendered as inline styles. Site.com sites:
• Site.com
Contributor User
SEE ALSO:
AND
Using Site.com Studio as a Site Administrator or Designer
Contributor role
Using Site.com Studio as a Contributor assigned at the site level

Site.comIP Restrictions Overview

Every computer has a unique IP address that it uses to identify itself. Using IP restrictions, you can
EDITIONS
define a range of permitted IP addresses for the pages, folders, and assets in your site to control
visitors’ access. Available in: Salesforce
For example, let’s say you have a site page that lists all employees by department. You don’t want Classic (not available in all
people outside your organization to view this sensitive information. By restricting the permitted IP orgs)
addresses to your organization’s IP range—say, 112.122.0.1 to 112.122.0.123—you ensure that no
Available for purchase in:
other site visitors can view the page. Enterprise, Performance,
When you define IP restrictions for: and Unlimited Editions
• A parent page template, all child page templates and template-based pages inherit the Available (with limitations)
restrictions. in: Developer Edition
• A folder, all subfolders and assets within the folder inherit the restrictions.

1217
Extend Salesforce with Clicks, Not Code Site.com

• The entire site, all site items inherit the restrictions.

For any item that inherits IP restrictions, you can add additional IP restrictions to further narrow the permitted IP range.
And if a user is denied access to a page, you can redirect them to another page, such as a user-friendly error page.

Adding IP Restrictions in Site.com

Control site visitors’ access to the pages, page templates, folders, and assets in your site by setting the range of permitted IP addresses.
Editing, Disabling, and Deleting IP Restrictions in Site.com

SEE ALSO:
Adding IP Restrictions in Site.com
Editing, Disabling, and Deleting IP Restrictions in Site.com

Adding IP Restrictions in Site.com

Control site visitors’ access to the pages, page templates, folders, and assets in your site by setting
EDITIONS
the range of permitted IP addresses.
1. On the Overview tab, either: Available in: Salesforce
Classic (not available in all
• Hover over the page, page template, folder, or asset in the All Site Content view and click
orgs)
> Add IP Restrictions.
• Click Site Configuration > IP Restrictions and click Add IP Restrictions. Available for purchase in:
Enterprise, Performance,
2. If not already selected, choose the item you want to restrict access to. and Unlimited Editions
3. Enter the first and last IP addresses of the permitted IP range—for example, 112.122.0.1 to Available (with limitations)
112.122.0.123. To enter a single IP address, just complete the Start Address field. in: Developer Edition
Both IP addresses in a range must be either IPv4 or IPv6. In ranges, IPv4 addresses exist in the
IPv4-mapped IPv6 address space ::ffff:0:0 to ::ffff:ffff:ffff, where ::ffff:0:0 is 0.0.0.0 and ::ffff:ffff:ffff
USER PERMISSIONS
is 255.255.255.255. A range can’t include IP addresses inside of the IPv4-mapped IPv6 address
space if it also includes IP addresses outside of the IPv4-mapped IPv6 address space. Ranges To add and edit IP
such as 255.255.255.255 to ::1:0:0:0 or :: to ::1:0:0:0 are not allowed. restrictions in Site.com:
• Site.com
4. Click Add IP Range to add additional ranges. Publisher User
5. To redirect users with an invalid IP address to an alternative page, such as a user-friendly error field enabled on the user
page, specify the page in Access Denied Page. If you set this in the IP Restrictions view, the page detail page
is the default for all IP restrictions unless you override it at the item level. AND
You can redirect users to a page in your site or to an external site. Always use a prefix such as Site administrator role
http:// when entering an external URL. If you don’t set an access denied page, users see assigned at the site level
a blank page that displays a default “Access to this resource is denied” message.

6. Click Save.
To test the IP restrictions of a page template or site page, click Preview when the page is open. When you’re happy with your updates,
publish the site to enable the restrictions.

Note:
• If an item inherits IP restrictions—for example, an asset in an IP-restricted folder—you can add additional restrictions to further
narrow the range. Although the item doesn’t display the inherited values anywhere, the inherited IP range values do apply to
the child item and only site visitors with valid IP addresses can access it.

1218
Extend Salesforce with Clicks, Not Code Site.com

• If you select a site page in the Access Denied Page drop-down list, users with an invalid IP address can view that page even if
the entire site is restricted.
• Caching is disabled for any item that has IP restrictions. Additionally, if you update the IP restrictions of an asset, folder, or page,
the system updates its URL in case proxy servers such as Akamai already cached the item.

SEE ALSO:
Site.comIP Restrictions Overview
Editing, Disabling, and Deleting IP Restrictions in Site.com

Editing, Disabling, and Deleting IP Restrictions in Site.com

After you create an IP restriction for a Site.com site, you can edit the address range, briefly disable
EDITIONS
the IP restriction (say, to allow temporary access to a page), or delete the restriction entirely.
To view all the IP restrictions on a site, open the IP Restrictions view under Site Configuration (on Available in: Salesforce
the Overview tab). Alternatively, to view the IP restriction on a single item, hover over it in the All Classic (not available in all
Site Content view and click > Edit IP Restrictions. orgs)

When either the IP Restrictions section or the IP restrictions dialog box is open, you can: Available for purchase in:
Enterprise, Performance,
• Edit the range of IP addresses. In the IP Restrictions view, double-click the IP address to edit the
and Unlimited Editions
values inline.
Available (with limitations)
• Disable an IP restriction by deactivating it. You can reactivate the restriction at any time. If you
in: Developer Edition
deactivate an IP restriction on an item that has several restrictions, the item’s other restrictions
are also deactivated.
• Delete an IP restriction. This removes the restriction entirely and allows all site visitors to access USER PERMISSIONS
the item.
To add and edit IP
After you update the site’s IP restrictions, publish the site to enable your changes.
restrictions in Site.com:
• Site.com
SEE ALSO: Publisher User
field enabled on the user
Site.comIP Restrictions Overview
detail page
Adding IP Restrictions in Site.com
AND
Site administrator role
assigned at the site level

1219
Extend Salesforce with Clicks, Not Code Site.com

Managing Domains in Site.com

Before you can publish your site to the Internet, you must set the site's domain information.
EDITIONS
To add a domain to the site’s domains list, Salesforce must verify that you own the domain name.
The verification method you choose depends on whether the domain name is currently in use. Available in: Salesforce
Classic (not available in all
• Add domain names using CNAME records if you’re creating a new domain name or using a
orgs)
domain name that’s not currently in use.
• Add domain names using TXT records if the domain name is already in use on another website Available for purchase in:
and you want to reuse it. The existing website must also use domain name system (DNS) A Enterprise, Performance,
records. and Unlimited Editions
Available (with limitations)
in: Developer Edition
Adding Domains Using CNAME Records in Site.com
Adding Domains Using TXT Records in Site.com
To publish a site to the Internet, you must first set its domain information. Add a domain name USER PERMISSIONS
using a TXT record if you’re reusing a domain name that’s currently in use. For example, if you’re
migrating from an existing site to a new Site.com site, you can transition seamlessly to the new To manage domains and
publish Site.com sites:
site when you’re ready to go live. This method is suitable only for existing sites that use DNS A
• Site.com
records.
Publisher User
Publishing and Managing Live Sites field enabled on the user
detail page
Publishing Site Changes
When you publish a site in Site.com, you make its pages and assets live on the Internet so site AND
visitors can access them. Site administrator role
assigned at the site level
Taking a Site Offline

SEE ALSO:
Publishing Site Changes
Taking a Site Offline

1220
Extend Salesforce with Clicks, Not Code Site.com

Adding Domains Using CNAME Records in Site.com

To publish a site to the Internet, you must first set its domain information. Add a domain name
EDITIONS
using a CNAME record if you’re creating a new domain name, or if you’re adding a domain name
that’s currently not in use. Available in: Salesforce
If you don’t already have a branded, custom Web address, such as www.mycompany.com, Classic (not available in all
create one by registering through a domain name registrar. orgs)

Each domain name in Site.com must be unique. Salesforce verifies your domain name when you Available for purchase in:
add it to the site’s list of domains, and again when you publish the site. Enterprise, Performance,
and Unlimited Editions
Tip: It can take up to 48 hours for domain changes to become available on the Internet.
However, you can reduce this time by lowering the time to live (TTL) value in the account Available (with limitations)
in: Developer Edition
management settings of your DNS provider. Because the current remaining time must expire
before your new setting takes effect, you should update this value a few days prior to going
live.
USER PERMISSIONS
You can also add a custom path to your domain name to create a custom URL. A custom URL
consists of the domain and a custom path. The same path name may be used on more than one To manage domains and
domain, but it can't be used more than once within the same domain. When adding a domain, the publish Site.com sites:
/ is required for the path. It indicates the root. You can add an additional custom name after the /, • Site.com
Publisher User
but you must at least use the / to indicate the root. For example, if the domain name is
field enabled on the user
https://oursite.com and the path is /products, the site URL is detail page
https://oursite.com/products. If you added the custom URL to the root, the URL
AND
would be https://oursite.com.
Site administrator role
Note: You can also manage domains and paths in Setup using Domain Management. assigned at the site level

1. In the account management settings of your DNS provider, create a CNAME record. CNAME
records must include your domain name, your 18–character organization ID, and the suffix
live.siteforce.com. For example, if your domain name is www.mycompany.com and your organization ID is 00dx00000000001aaa,
then the CNAME must be www.mycompany.com.00dx00000000001aaa.live.siteforce.com. You can find the
organization ID on the new domain page in Domain Management within Setup.
2. When your CNAME record is available on the Internet, open Site.com Studio and click Site Configuration > Domains on the
Overview tab.
3. Enter the domain name in the text box provided—for example, www.mycompany.com.
4. Add an optional path name.
5. click Add.
6. Repeat for any additional domain names. For example, you might want to include common misspellings of the domain name in
case users make typing mistakes. You must create a corresponding unique CNAME record for each domain name. You can add up
to ten domain names.
7. When you’re ready to go live, publish the site.

Note:
• If you have an MX record set up for your domain’s mail service, the domain assigned to the MX record can’t be the same as
the domain you assign to your CNAME record. If you create a CNAME record using the same domain as your MX record, your
mail service will be disabled.

1221
Extend Salesforce with Clicks, Not Code Site.com

For example, if you have mydomain.com assigned to your MX record, and you want to use it for your CNAME record, we
recommend assigning www.mydomain.com to your CNAME record instead, and then working with your DNS provider to
redirect mydomain.com to www.mydomain.com.

• When you update existing domain information, you must publish your changes for them to take effect. If you see a message
that there are no changes to publish, first update a page in your site and then publish your changes.
• A records aren’t supported.

SEE ALSO:
Adding Domains Using TXT Records in Site.com
Managing Domains in Site.com

Adding Domains Using TXT Records in Site.com

To publish a site to the Internet, you must first set its domain information. Add a domain name
EDITIONS
using a TXT record if you’re reusing a domain name that’s currently in use. For example, if you’re
migrating from an existing site to a new Site.com site, you can transition seamlessly to the new site Available in: Salesforce
when you’re ready to go live. This method is suitable only for existing sites that use DNS A records. Classic (not available in all
Each domain name in Site.com must be unique. Salesforce verifies your domain name when you orgs)
add it to the site’s list of domains, and again when you publish the site.
Available for purchase in:
Tip: It can take up to 48 hours for domain changes to become available on the Internet. Enterprise, Performance,
However, you can reduce this time by lowering the time to live (TTL) value in the account and Unlimited Editions
management settings of your DNS provider. Because the current remaining time must expire Available (with limitations)
before your new setting takes effect, you should update this value a few days prior to going in: Developer Edition
live.
1. In the account management settings of your DNS provider, create a TXT record that contains
USER PERMISSIONS
your organization’s ID. To find the ID, open Site.com Studio, click Site Configuration > Domains
on the Overview tab, and copy the organization ID displayed there. To manage domains and
Contact your DNS provider if you’re unsure how to create a TXT record. publish Site.com sites:
• Site.com
2. When your TXT record is available on the Internet, enter the domain name in the text box Publisher User
provided in the Domains view—for example, www.mycompany.com—and click Add. field enabled on the user
detail page
3. Repeat for any additional domain names. For example, you might want to include common
misspellings of the domain name in case users make typing mistakes. AND

You can add up to ten domain names. Site administrator role

assigned at the site level
4. Publish your Site.com site when it’s ready. It won’t yet be live on the Internet.
5. To go live, in your DNS account management settings:
a. Create a CNAME that meets the following criteria. CNAME records must include your domain name, your 18–character organization
ID, and the suffix live.siteforce.com. For example, if your domain name is www.mycompany.com and your organization
ID is 00dx00000000001aaa, then the CNAME must be
www.mycompany.com.00dx00000000001aaa.live.siteforce.com. You can find the organization ID on the
new domain page in Domain Management within Setup.

1222
Extend Salesforce with Clicks, Not Code Site.com

b. Delete the old A record, and also the TXT record that you created in step 1.

SEE ALSO:
Adding Domains Using CNAME Records in Site.com
Managing Domains in Site.com

Publishing and Managing Live Sites

When you publish a site in Site.com, you make its pages and assets live on the Internet so site visitors
EDITIONS
can access them.
Before you publish your site for the first time, you must set the site's domain information. If you Available in: Salesforce
don't set up your domain, you’ll be prompted to do so during the publishing process. After your Classic (not available in all
domain is set up, you can publish your entire site or just parts of it. orgs)

When working with a site, you can: Available for purchase in:
• Publish site changes. Enterprise, Performance,
and Unlimited Editions
• Review the change history by clicking > View Details on the Overview tab.
Available (with limitations)
• Take the site offline to remove it from public view. in: Developer Edition
Note: You can’t publish your site from sandbox.

USER PERMISSIONS
SEE ALSO:
To manage domains and
Using Site.com Studio as a Site Administrator or Designer publish Site.com sites:
• Site.com
Publisher User
field enabled on the user
detail page
AND
Site administrator role
assigned at the site level

1223
Extend Salesforce with Clicks, Not Code Site.com

Publishing Site Changes

When you publish a site in Site.com, you make its pages and assets live on the Internet so site visitors
EDITIONS
can access them.
Before you publish your site for the first time, you must set the site's domain information. If you Available in: Salesforce
don't set up your domain, you’ll be prompted to do so during the publishing process. Classic (not available in all
orgs)
You can publish your entire site or just specific items.
1. Click Publish Changes.... Available for purchase in:
Enterprise, Performance,
2. To publish: and Unlimited Editions
• All recent changes, ensure Site-wide changes is selected. Available (with limitations)
• Specific items, select Only selected items and select the relevant items. in: Developer Edition

Note: If you select an item that has dependencies, the dependent items are also selected.
For example, if you select a page, but you changed the page and the style sheet that it USER PERMISSIONS
relies on, the style sheet is also selected. Click View to see the list of dependencies. You
can’t deselect an item if it’s a critical dependency for another selected item. To manage domains and
publish Site.com sites:
3. Click Next and then review the list of items to be published. • Site.com
Publisher User
4. Click Next and then add a publishing note, if required. The note appears in the Description
field enabled on the user
column of the Change History view.
detail page
5. Click Publish. AND
You’ll receive an email notification when your site changes go live. Site administrator role
assigned at the site level
Note: You can’t publish your site from sandbox.

SEE ALSO:
Publishing and Managing Live Sites
Taking a Site Offline

1224
Extend Salesforce with Clicks, Not Code Salesforce Sites

Taking a Site Offline

1. On the Overview tab, click Site Configuration > Domains.
EDITIONS
2. Delete all listed domains.
When you remove the last domain, the site goes offline immediately. Site visitors see a “Server Available in: Salesforce
not found” message or similar in their browser when they attempt to view the site. Classic (not available in all
orgs)
3. In the popup window that appears:
• Click OK to unpublish the site. Unpublishing the site releases the Site.com Published Site Available for purchase in:
license associated with it, so you can use it to publish another site. Enterprise, Performance,
and Unlimited Editions
• Click Cancel if you don’t want to release the Site.com Published Site license—for example,
if you plan to make the site publicly available again at a later date. Available (with limitations)
in: Developer Edition
If you change your mind after clicking Cancel, you can release the license by clicking
Unpublish on the Overview tab. After a site is unpublished, the Unpublish button is
replaced with the Publish button. USER PERMISSIONS

4. If you don’t plan to reuse the domain with Site.com, remove any CNAME records that point to To manage domains and
your_domain_name.orgID.live.siteforce.com in the account management publish Site.com sites:
• Site.com
settings of your DNS provider.
Publisher User
After you unpublish a site, you can delete it from the list of sites on the Site.com tab. field enabled on the user
detail page
SEE ALSO: AND
Managing Domains in Site.com Site administrator role
assigned at the site level
Publishing Site Changes

Salesforce Sites
Salesforce Sites enables you to create public websites and applications that are directly integrated
EDITIONS
with your Salesforce organization—without requiring users to log in with a username and password.
You can publicly expose any information stored in your organization through a branded URL of Available in: both Salesforce
your choice. And you can make the site's pages match the look and feel of your company’s brand. Classic (not available in all
Salesforce organizations contain valuable information about partners, solutions, products, users, orgs) and Lightning
ideas, and other business data. Some of this information would be useful to people outside your Experience
organization, but only users with the right access and permissions can view and use it. In the past, Available in: Developer,
to make this data available to the general public, you had to set up a web server, create custom Enterprise, Performance,
web pages (JSP, PHP, or other), and perform API integration between your site and your organization. and Unlimited Editions
Also, if you wanted to collect information using a web form, you had to program your pages to
perform data validation.
With Salesforce Sites, you no longer have to do any of those things. Salesforce Sites enables you to create public websites and applications
that are directly integrated with your Salesforce organization—without requiring users to log in with a username and password. You
can publicly expose any information stored in your organization through a branded URL of your choice. You can also make the site's
pages match the look and feel of your company's brand. Because sites are hosted on Lightning Platform servers, there are no data
integration issues. And because sites are built on native Visualforce pages, data validation on collected information is performed
automatically. You can also enable users to register for or log in to an associated portal seamlessly from your public site.

1225
Extend Salesforce with Clicks, Not Code Salesforce Sites

Note: Salesforce Sites is subject to these additional Terms of Use.

For information on Site.com, which is a web content management system (CMS) that makes it easy to build dynamic, data-driven
web pages and edit content in real time, see Site.com on page 1045.

The following examples illustrate a few ways that you can use sites:
• Create an ideas site—Use sites to host a public community forum for sharing and voting on ideas about your company, services, or
products. Ideas websites can be made public using sites.
• Publish a support FAQ—Provide helpful information on a public website where customers can search for solutions to their issues.
• Create a store locator tool—Add a public tool to your portal that helps customers find stores in their area.
• Publish an employee directory—Add an employee directory to your company's intranet by creating a site restricted by IP range.
• Create a recruiting website—Post job openings to a public site and allow visitors to submit applications and resumes online.
• Publish a catalog of products—List all of your company's products on a public website, with model numbers, current prices, and
product images pulled dynamically from your organization.
Because Salesforce Sites are served directly from the Salesforce organization, a site's availability is directly related to the organization's
availability. During your organization's maintenance window for major releases, your sites are unavailable; users who try to access a site
see a Lightning Platform-branded maintenance page or your custom Service Not Available Page. It's a good idea to inform your site
users of the release maintenance windows and related sites unavailability in advance. You can view specific maintenance windows,
listed by instance, at trust.salesforce.com/trust/status/#maint.

The Salesforce Sites Domain

For each of your sites, you determine the URL of the site by establishing the site's domain name. You can choose one of the following
domain options.
• Use your Salesforce Sites domain. With this option, your Salesforce Sites domain name is used for all the sites that you create. For
example, your company could create one public site for partners, another for developers, and a third for support. If your company's
Salesforce Sites domain is https://MyDomainName.my.salesforce-sites.com, those three sites can have the
following URLs:
– https://MyDomainName.my.salesforce-sites.com/partners
– https://MyDomainName.my.salesforce-sites.com/developers
– https://MyDomainName.my.salesforce-sites.com/support

Note: The format of the secure URLs for your Salesforce Sites depends on whether enhanced domains are enabled in your
org and on the org type or edition. The subdomain in Developer edition orgs ends in -dev-ed, and sandbox URLs contain
the sandbox name and the word “sandbox”. Your org’s secure URL is displayed on the Login Settings page. The URL is
case-sensitive.

Organization Type Secure URL

Developer Edition MyDomainName-dev-ed.my.salesforce-sites.com

Sandbox MyDomainName--SandboxName.sandbox.my.salesforce-sites.com

Production MyDomainName.my.salesforce-sites.com

1226
Extend Salesforce with Clicks, Not Code Salesforce Sites

When enhanced domains aren’t enabled in your org, you specify a separate Salesforce Sites subdomain and the domain suffix
is force.com. The subdomain in Developer edition orgs ends in -developer-edition, and sandbox URLs contain
the sandbox name. Your Salesforce instance name is included in the URLs for Developer Edition and sandbox orgs.

Organization Type Secure URL

Developer Edition https://SitesSubdomainName-developer-edition.InstanceName.force.com

Sandbox https://SandboxName-SitesSubdomainName.InstanceName.force.com

Production https://SitesSubdomainName.secure.force.com

• Create a branded, custom web address, such as https://www.mycompanyideas.com, by registering through a domain
name registrar. Create CNAME records to redirect your custom domain and subdomains to your Salesforce Sites domain without
exposing the secure.force.com or salesforce-sites.com name in the URL. It can take up to 48 hours for your
Salesforce Sites domain to become available on the Internet. Custom domains aren't supported for Developer Edition organizations.

Note: CNAME records must include your domain name, your 18–character organization ID, and the suffix
live.siteforce.com. For example, if your domain name is www.mycompany.com and your organization ID is
00dx00000000001aaa, then the CNAME must be
www.mycompany.com.00dx00000000001aaa.live.siteforce.com. You can find the organization ID on
the new domain page in Domain Management within Setup.

Managing Salesforce Sites

Register a Salesforce Sites Domain
To use Salesforce Sites with or without a custom domain, you must first register a Salesforce Sites domain. Your company's Salesforce
Sites domain is used for all the sites that you create.
Setting Up Salesforce Sites
Enable Salesforce Sites and create public websites and applications that are directly integrated with your Salesforce
organization—without requiring users to log in with a username and password.
Configure Site Caching
Caching your Salesforce Site pages, attachments, and static resources can improve page load times and site performance. It can also
help you avoid reaching bandwidth and service request time limits.
Using Workflow for Salesforce Sites
Track Your Salesforce Sites with Google Analytics
Viewing Salesforce Sites History
Viewing 24-Hour Salesforce Sites Usage History
Reporting on Salesforce Sites
Salesforce Sites Security
Review how the Sites and Domains settings related to secure connections affect what your users see when accessing your org.
Salesforce Sites-Related Apex Methods and Expressions
Salesforce Sites Considerations

1227
Extend Salesforce with Clicks, Not Code Salesforce Sites

Salesforce Sites Usage and Billing

Salesforce Sites usage is governed by monthly and daily allocations. Understanding these allocations is important to the success of
your sites.
Can I use the same domain name for my Salesforce Sites and my Experience Cloud Sites?
With enhanced domains, your Salesforce org’s My Domain name is the subdomain for Salesforce Sites and Experience Cloud sites.
If enhanced domains aren’t enabled in your org, you can’t use the same domain name for Salesforce Sites and Experience Cloud
sites.

SEE ALSO:
Setting Up Salesforce Sites
Managing Salesforce Sites
Salesforce Sites Usage and Billing

Managing Salesforce Sites

To get started using Salesforce Sites, from Setup, enter Sites in the Quick Find box, then
EDITIONS
select Sites. From this page, you can:
• Register your Salesforce Sites domain, if you have not yet done so. Available in: both Salesforce
• View all sites hosted on your Salesforce Sites domain. Classic (not available in all
orgs) and Lightning
• To create a site, click New. Experience
• To change an existing site, click Edit.
Available in: Developer,
• To change the active status of your site, click Activate or Deactivate. Enterprise, Performance,
Warning: Be careful not to expose any information that you do not want to make public. and Unlimited Editions

• To view the site’s details, click the site's label. USER PERMISSIONS
• To set a default owner of records created by guest users, select Assign new records created by
Salesforce Sites guest users to a default owner. To create and edit Salesforce
Sites:
• To open a site in a browser, click the site's URL. • Customize Application
OR
SEE ALSO: Create and Set Up
Setting Up Salesforce Sites Experiences
Create and Edit Salesforce Sites
Configure Salesforce Sites

1228
Extend Salesforce with Clicks, Not Code Salesforce Sites

Register a Salesforce Sites Domain

To use Salesforce Sites with or without a custom domain, you must first register a Salesforce Sites
EDITIONS
domain. Your company's Salesforce Sites domain is used for all the sites that you create.
Even if you register a custom domain such as https://www.example.com for your site, you must Available in: both Salesforce
choose a Salesforce Sites domain. The Salesforce Sites domain is used as a fallback to a custom Classic (not available in all
domain in some situations, including when none of the custom domains support https and the orgs) and Lightning
site requires https. Experience

To register your Salesforce Sites domain: Available in: Developer,

Enterprise, Performance,
1. From Setup, enter Sites in the Quick Find box, then select Sites.
and Unlimited Editions
2. If enhanced domains are enabled in your org, your Sites domain includes your org’s My Domain
in the format MyDomainName.my.salesforce-sites.com.
USER PERMISSIONS
3. If enhanced domains aren’t enabled in your org, select your Salesforce Sites subdomain.
To create and edit Salesforce
• Enter a unique name for your Salesforce Sites domain.
Sites:
A Salesforce Sites domain name can contain up to 40 alphanumeric characters and hyphens, • Customize Application
and must be unique. It must begin with a letter, not include spaces, not end in a hyphen,
OR
and not contain underscores or periods. In Developer Edition orgs, the Salesforce Sites
Create and Set Up
domain name can contain up to 22 characters. Salesforce recommends using your company's
Experiences
name or a variation, such as mycompany. Your production org’s Salesforce Sites domain
is in the format SalesforceSitesSubdomainName.force.com

Warning: You can't modify your Salesforce Sites domain name after you have registered it.

• Click Check Availability to confirm that the domain name you entered is unique. If it isn't unique, you are prompted to change
it.

4. Read and accept the Sites Terms of Use by selecting the checkbox.
5. Click Register My Salesforce Site Domain. After you accept the Terms of Use and register your Salesforce Sites domain, the changes
related to site creation are tracked in your organization's Setup Audit Trail and the Site History related list. It may take up to 48 hours
for your registration to take effect.

SEE ALSO:
Setting Up Salesforce Sites
Salesforce Sites Considerations
Enhanced Domains

1229
Extend Salesforce with Clicks, Not Code Salesforce Sites

Setting Up Salesforce Sites

Enable Salesforce Sites and create public websites and applications that are directly integrated with
EDITIONS
your Salesforce organization—without requiring users to log in with a username and password.
1. From Setup, enter Sites in the Quick Find box, then select Sites. Available in: both Salesforce
Classic (not available in all
2. Register the Salesforce Sites domain for your organization.
orgs) and Lightning
3. Create and configure your site. Experience
4. Develop and use Visualforce pages for your site, use or hide standard pages, and customize or Available in: Developer,
replace out-of-box error pages. Associate these pages with your site. Enterprise, Performance,
5. Choose a site template. Use the lookup field to find a template that you’ve developed, or use and Unlimited Editions
the provided template. The site template provides the page layout and stylesheet for your site
and overrides any formatting inherited from the associated portal. USER PERMISSIONS
6. Enable a portal for login or self-registration, then associate it with your site.
To create and edit Salesforce
7. Optionally, modify public access settings. Sites:
8. When you are ready to make your site public, click Activate on the Site Details page. You can • Customize Application
also activate your site from the Site Edit and Sites pages. To edit public access
After you have set up a site, you can: settings for Salesforce Sites:
• Manage Users
• Run reports and dashboards on your site.
• Create workflow rules that trigger email alerts when site-related criteria are met.

Create and Edit Salesforce Sites

Configure Salesforce Sites
Troubleshooting Salesforce Sites Using Administrator Preview Mode

SEE ALSO:
Managing Salesforce Sites
Configure Salesforce Sites

1230
Extend Salesforce with Clicks, Not Code Salesforce Sites

Create and Edit Salesforce Sites

After registering your Salesforce Sites domain, create a Salesforce Site.
EDITIONS
1. From Setup, enter Sites in the Quick Find box, and select Sites.
Available in: both Salesforce
2. Click New, or click Edit to modify an existing site.
Classic (not available in all
3. On the Site Edit page, configure the following settings. orgs) and Lightning
Experience
Field Description
Available in: Developer,
Site Label The name of the site as it appears in the user interface. Enterprise, Performance,
and Unlimited Editions
Site Name The name used when referencing the site in the SOAP API.
This name can contain only underscores and alphanumeric
characters, and must be unique in your org. It must begin with USER PERMISSIONS
a letter, not include spaces, not end with an underscore, and
To create and edit Salesforce
not contain two consecutive underscores.
Sites:
Site Description An optional description of the site. • Customize Application
OR
Site Contact The user who receives site-related communications from the
site’s visitors and Salesforce. Create and Set Up
Experiences
Default Record Owner The user who owns all new records that unauthenticated
guest users create. For considerations, especially when
updating sites created before Summer ’20, see Best Practices
and Considerations for Using the Guest Record Default Owner
in Salesforce Help.

Default Web Address The unique Salesforce Site URL for this site. Salesforce Sites
provide the first part of the URL based on the domain name
that you registered. You must add a unique site name to the
end. Unless you configure a custom address through a domain
name registrar, this URL is the one that the public uses to
access your site.

Active Select when you’re ready to make your site available to the
public. You can also activate your site from the Sites and Site
Details pages. When the site is inactive, users see the page
specified in the Inactive Site Home Page field.

Active Site Home Page The landing page that users are directed to when this site is
active. Use the lookup field to find and select the Visualforce
page that you developed for your site’s home page. Choose
the UnderConstruction page if you want to test your site.
For ideas sites, you must use the IdeasHome page. For answers
sites, use the AnswersHome page. If you don’t use a site
template, your site inherits its look and feel from its associated
portal.
If you deployed a site before the Summer ’10 release, you can
set AnswersHome as your default landing page if you create

1231
Extend Salesforce with Clicks, Not Code Salesforce Sites

Field Description
a Visualforce page using <apex:page
action="{!URLFOR('/answers/answersHome.apexp')}"/>.

Inactive Site Home Page The landing page that users are directed to when this site is inactive. Use the lookup
field to find the page that you want to use. You can, for example, select a page to
indicate that the site is under construction or down for maintenance.

Site Template The template that provides the page layout and style sheet for your site. The site
template overrides the formatting inherited from the associated portal. Use the lookup
field to find a template that you’ve developed, or use the provided template.

Note: The site template specified here is used only for Visualforce pages using
the $Site.Template expression.

Site Robots.txt A file that determines which parts of your public site that web spiders and other web
robots can access. Search engines often use web robots to categorize and archive
websites. HTML tags are not allowed because they are not compatible with
robots.txt spiders. For Visualforce pages, add
contentType="text/plain" to the <apex:page> tag.
This example disallows all robots from indexing all pages.
<apex:page contentType="text/plain">
User-agent: * # Applies to all robots
Disallow: / # Disallow indexing of all pages
</apex:page>

This example allows all robots to index all pages.

<apex:page contentType="text/plain">
User-agent: * # Applies to all robots
Disallow: # Allow indexing of all pages

</apex:page>

Site Favorite Icon The icon that appears in the browser’s address field when visiting the site. Use this field
to set the favorite icon for your entire site instead of for each page. Due to caching,
changes are reflected on your site one day after you make them.

Analytics Tracking Code The tracking code associated with your site. Services such as Google Analytics can use
this code to track page request data for your site.

URL Rewriter Class An Apex class to use for rewriting URLs for your site, from Salesforce URLs to user-friendly
URLs. With this class, you can make rules to rewrite site URL requests typed into the
address bar, launched from bookmarks, or linked from external websites. You can also
create rules to rewrite the URLs for links within site pages.

Enable Feeds The option that displays the Syndication Feeds related list, where you can create and
manage syndication feeds for users on your public sites. This field is visible only if you
have the feature enabled for your organization.

1232
Extend Salesforce with Clicks, Not Code Salesforce Sites

Field Description
Clickjack Protection Level You can set the clickjack protection for a site to one of these levels:
• Allow framing by any page (no protection): The least secure level.
• Allow framing of site pages on external domains (good protection): Allows
framing of your site pages by pages on external domains that are added to the
Trusted Domains for Inline Frames list.
• Allow framing by the same origin only (recommended): The default level for
sites. Allows framing of site pages by pages with the same domain name and
protocol security.
• Don’t allow framing by any page (most protection): The most secure level,
but it can cause certain pages to appear as blank pages. To avoid this issue, use
the default setting instead.
If you select Allow framing of site or community pages on external domains
(good protection), select Add Domain in the Trusted Domains for Inline Frames
section, enter the domain you want to allow iframes on, and select Save.

Lightning Features for Guest Users Determines whether unauthenticated guest users can view features available only in
Lightning. If disabled, Lightning features don’t load.

Warning: If you apply this setting in a Lightning site, unauthenticated users

can’t access any Lightning pages, including Login and Error pages. Replace
these pages with custom Visualforce pages before disabling Lightning features.

Enable Content Sniffing Protection Prevents the browser from inferring the MIME type from the document content. It also
prevents malicious files from being executed as dynamic content (JavaScript, style
sheet).

Enable Browser Cross-Site Scripting Protects against reflected cross-site scripting attacks. When a reflected cross-site
Protection scripting attack is detected, the browser renders a blank page with no content.

Referrer URL Protection When loading pages, the referrer header shows only Salesforce.com rather than the
entire URL. 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 feature is
supported only for Chrome and Firefox.

Allow only required cookies for this site The option to only allow required Salesforce-supplied cookies within a Salesforce Site.
When this setting is turned off, we allow all cookie types: required, functional, and
advertising.

Redirect to custom domain If an HTTPS custom domain, such as https://www.example.com, serves this
site, redirects requests from the site’s system-managed URLs to that custom domain.
System-managed site URLs end in *.force.com,
*.my.salesforce-sites.com, or *.my.site.com.
If multiple custom domains serve this site, 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.

1233
Extend Salesforce with Clicks, Not Code Salesforce Sites

Field Description
Cache public Visualforce pages When this option is enabled, proxy servers cache the sites’ publicly available pages
only for unauthenticated guest users. When this setting is disabled, all of this site’s
Visualforce pages can be cached in the web browser for both authenticated and
unauthenticated users, and each Visualforce page’s cache attribute controls whether
the page is cached in the end user's web browser. For more information, see Configure
Site Caching on page 1251.

Guest Access to the Support API When this option is enabled for a Salesforce site or Experience Cloud site,
unauthenticated users are allowed to access the Support API.

4. Click Save.

Note: You define custom URLs from Domain Management in Setup.

SEE ALSO:
Setting Up Salesforce Sites
Configure Salesforce Sites

Configure Salesforce Sites

Once you have created your site, you can configure it on the Site Details page. To access this page,
EDITIONS
from Setup, enter Sites in the Quick Find box, then select Sites, and then in the Sites list,
click the site name. You can do the following: Available in: both Salesforce
• Click Edit to make changes to the site. Classic (not available in all
orgs) and Lightning
• Click Public Access Settings to view or edit the security settings, including permissions, page
Experience
layouts, and more.
• Click Login Settings to configure the login and registration settings for your site. Built-in login Available in: Developer,
and registration logic allows users to quickly register for, and seamlessly log in to, your portal Enterprise, Performance,
from your public site. and Unlimited Editions

Note: For Experience Cloud sites, this link opens the Experience Cloud site’s Login Page.
USER PERMISSIONS
• Click URL Redirects to see any page redirects you've set up for your site.
To create and edit Salesforce
• Click Activate or Deactivate to change the active status for your site. Sites:
• Customize Application
Warning: Be careful not to expose any information that you do not want to make public.
To edit public access
• Click Preview as Admin to view your site in administrator preview mode. Administrator preview settings for Salesforce Sites:
mode shows the errors on each site page in context and in greater detail, so you can more • Manage Users
easily troubleshoot site issues.

Note: This feature does not appear for community organizations.

• Click Edit in the Site Visualforce Pages or Site Standard Pages related lists to select the pages available for your site. All pages associated
with the site must be enabled.

1234
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Click Page Assignment to assign error pages for standard errors, such as “Authorization Required (401)” and “Page Not Found (404).”
You can override or edit the default pages that are provided.
• Click New in the Feeds related list to create a new syndication feed. You must click Enable Feeds in the Site Detail list to display
this related list.
• View the 24-Hour Usage History related list to see current bandwidth and service request time usage, the daily limits, and the
percentage used.
• View the Site History related list to see the configuration changes that have been tracked for your site.

Defining Syndication Feeds

Managing Salesforce Sites Login and Registration Settings
Public Access Settings for Salesforce Sites
Control what public users can do on each Salesforce Sites site.
Salesforce Sites URL Redirects
Associate a Portal with Salesforce Sites
Managing Salesforce Site Visualforce Pages
Manage Salesforce Sites Standard Pages
Assigning Salesforce Site Error Pages
Salesforce sites use Visualforce pages for site and error pages. Sample error pages use the SiteSamples static resource for their style
sheet and images.

SEE ALSO:
Managing Salesforce Sites Login and Registration Settings

Defining Syndication Feeds

Syndication feeds give users the ability to subscribe to changes within Salesforce Sites and receive
EDITIONS
updates in external news readers. Simply by defining a SOQL query and mapping, you can syndicate
changes to public data to your end users. You can create one or more syndication feeds for your Available in: both Salesforce
organization's public sites or any Visualforce page. The syndication feed displays the records specified Classic (not available in all
by a SOQL query. Users can subscribe to the feed and view the feed when they visit the site or page. orgs) and Lightning
Define a syndication feed, including what records are returned, and which data from the records Experience
is displayed: Available in: Developer,
Name Enterprise, Performance,
A descriptive name for this feed, which distinguishes it from other feeds you may create. Use and Unlimited Editions
only letters, numbers, or the underscore character “_”. Do not use more than one underscore
character in a row.
USER PERMISSIONS
Description
Describe the feed. For example, “Account first name, last name, and region for the last ten Create, edit, or delete a feed
definition:
accounts created or edited.”
• Modify All Data
Query
Subscribe to a feed
The SOQL query that defines which records are returned to the syndication feed. To ensure fast
• No special user
performance, some limitations on the SOQL query are imposed: permission required
• If the SOQL query does not specify a limit, then no more than 20 records are returned.

1235
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Query limits can't exceed 200 results. If you make a query with a limit beyond this number, only the first 200 records are returned.
• If the SOQL query does not have an ORDER BY value specified, records are ordered by the LastModifiedDate value if
there is one, or by SystemModstamp value if not
• COUNT is not supported.
• Aggregate queries are not supported. For example, this query cannot be used in a syndication feeds SOQL query:
SELECT Name, (SELECT CreatedBy.Name FROM Notes) FROM Account

• You can use bind variables, a variable whose value is supplied in the URL.

Note: The guest user must have appropriate sharing and field-level security access or you cannot save your query, because
the Lightning platform verifies access and sharing before saving.
Mapping
Because syndication feeds use the ATOM web publishing protocol, you must provide a mapping value that matches objects and
fields on the returned records with ATOM constructs. Note that all values must be string literals.
You can use bind variables, a variable whose value is supplied in the URL. For more information, see .
Max Cache Age Seconds
Because many users may access a feed at the same time, Salesforce caches the feed data, for 3600 seconds by default. You can
modify this to a minimum of 300 seconds, or for as long as you wish. Query results that are older than the time specified here are
dropped, and a new query is run on the next request for that information, that is, the next time a user opens a page containing a
feed that they have subscribed to.
Active
Select this checkbox to make the feed available for subscription. Once a feed is active, users have the option of subscribing to it.

ATOM-Object Mapping
You must specify a mapping in the syndication feed definition. The mapping relates ATOM constructs such as entry title to the
corresponding value in a record, for example, “Account Name.” A full set of mappings represents a news feed, and the query represents
the content of each news item in a feed. For example, Lead records created today or Contacts with updated Account information.
A feed element is the envelope for each part of a news item, and an entry element is the contents of the envelope.
Mapping also allows you to apply short labels to various fields for display purposes.
The following table lists each ATOM and object element and explains what values should be provided:

Feed Element Entry Element Description

fa Required only if ea (entry author) is not specified. Feed author. For example, fa:"Acme
Feed Author Admin Mary" shows the feed author as Admin Mary.

fid Optional (because default value is supplied). Id of the feed. By default, this value is the public
site URL. If you specify a value, it must be a valid internationalized resource identifier (IRI). An IRI
is a URL generalized to allow the use of Unicode.

fl Optional (because default value is supplied). Feed link. For example,

fl:"https://www.salesforce.com". News readers usually interpret this element
by linking the feed title to this URL.

fst Optional. Feed subtitle. For example, &map=ft:"Newest

Opportunities",fst:"Western Division" shows the feed title Newest
Opportunities and subtitle Western Division.

1236
Extend Salesforce with Clicks, Not Code Salesforce Sites

Feed Element Entry Element Description

ft Required. Feed title. For example, ft:"Newest Opportunities".

ea Required only if fa (feed author) is not specified. Entry author. For example, ea:"Account
created by: " + Account.CreatedBy .

ec Required. Entry content. For example,ec:"description for " Name "<br>"

Description shows the value of the Name field with additional text. The output of a feed
for this example resembles the following:
description for Ajax Industries Description

ect Optional. Entry content of type text, html, or xhtml. For example, ect: html for HTML
content. Default is text.

el Optional. Entry link. Must be a valid URI. This value is usually a link to another representation of
the content for the entry. For example, the link could be to a record in the Salesforce user
interface. News readers usually interpret this element by linking the entry title to this URL For
example, el:"Account.URl".

es Optional. Entry summary. An optional summary of the entry content. For example, et:
Account.Name, es: Account.Name + "’s account number, website,
and description", ec: Account.AccountNumber + " " +
Account.Website + “ “ + Account.Description
If not specified, news readers display the content defined using the ec element.

est Optional. Entry summary of type text, html, or xhtml. For example, est: html for
HTML content. Default is text. Do not specify a value unless es has been specified.

et Required. Entry title, a field name. For example, et:Name.

eu Optional. By default, the required ATOM element <updated> value is automatically provided
by the LastModifedDate of the main entity being queried; usually the object in the main
FROM clause of the SOQL query. This value indicates the last time an entry or feed was modified.
If you wish to change this default behavior, you can specify a different object or field's
LastModifedDate be used. For example:
• Query: SELECT Id, Name, MyDate__c FROM AccountMapping Parameter:
eu: MyDate__c
• Query: SELECT Id, Lastname, Account.LastMOdifiedDate FROM
ContactMapping Parameter: eu: Account.LastModifiedDate

The following example shows a valid mapping values for a syndication feed:
ft: "Harry Potter", et: Name, ec: "description for " Name "<br>" Description, el: "/" Id,
ect: html

Feeds are displayed in the guest user context of the public site where they are displayed. Therefore, if you have used custom labels to
manage internationalization, and specified labels in your mapping, users see those labels displayed in the language of the guest user.
You can only use string literals in feed mapping. You cannot use, for example, date literals such as TODAY or LAST_WEEK.

1237
Extend Salesforce with Clicks, Not Code Salesforce Sites

After you have defined a feed, you should test it, and then make the feed active by selecting the Active checkbox as described above.
For more information about testing, see Testing Syndication Feeds on page 1241.

Using Bind Variables for Queries and Mapping

You can use bind variables in the WHERE clause of the SOQL query. Bind variables must be in the following form:

{!var_name}

The following query uses a bind variable named accountID.

SELECT Name, Description
FROM Account
WHERE Id = {!accountID}

Note that this is not the literal name of the field, but an arbitrary name. At run time, the value for accountID is passed to the query
from the URL. This feed is accessed from the following URL and passes in the account ID as part of the query string parameter:

site_URL/services/xml/My'Account'Feed?accountId=0013000000BmP4x

You can also use bind variables for mapping values.

The following implementation details apply to the use of bind variables for queries:
• You cannot use more than 20 bind variables in a feed definition, queries and mapping combined.
• The bind variable name cannot be more than 100 characters.
• You can use a bind variable only on the right side of a filter operation to represent part of a string. Because it represents part of a
string, it must be in quotes. For example, the following is a valid query:
SELECT Id, Name FROM Account WHERE Name = '{!myBindVariable}'

The following queries are not valid, because the bind variable is not in a valid position, and is not functioning as the variable for a
literal string:
SELECT Id, Name FROM Account WHERE {!myFieldName} = 'Joe'
SELECT Id, {!myFieldName} FROM Account WHERE IsDeleted = false

• You cannot use a bind variable to represent a field name. This means a bind variable cannot be use on the left side of a filter operation.
• You cannot use a bind variable to change the meaning or structure of a query for security reasons. Any special characters you specify
in the bind replacement value are interpreted as literal characters when the query is evaluated.

Custom Labels and Feeds

For feeds that need to be localized into different languages, you can use custom labels to define the string in multiple languages. Then
in the mapping definition, you simply refer to the custom label. When a request comes in, the custom label inspects the guest user
language and returns the translated text, which is used in the mapping.
Custom labels can be specified in a field with the following syntax:

map_element_name: "{!$LABEL.custom_label_name}"

Use the following procedure to specify a custom label in a feed:

1. From Setup, enter Custom Labels in the Quick Find box, then select Custom Labels. You may wish to name the custom
label after the mapping element that takes its value, for example feedTitle for the ft element.
2. Enter the values for all supported languages.

1238
Extend Salesforce with Clicks, Not Code Salesforce Sites

3. Specify the custom label in the feed mapping.

For example, assume that you create a feed containing information on all the houses your company is trying to sell. For English users,
the title of the feed should be “The Houses,” but for Spanish users, the title of the feed should be “Las Casas.” You would create a custom
label, for example, feedTitle. In English, its value is “The Houses,” and the Spanish value is “Las Casas.” Then, in the feed mapping
definition, specify the following for the feed title fc::
ft: "{!$LABEL.feedTitle}"

Visualforce and Feeds

To add a feed to a Visualforce page, use the Visualforce standard HTML features. For example, assuming the Visualforce page is located
in the base directory of the site, it can contain a tag like the following:
<A HREF=""/services/xml/theFeedName">My feed</A>

The text My feed links to the feed.

If you want to link the feed from an image, include an inline image tag similar to the following:
<A HREF="/services/xml/theFeedName"><img src="feed.gif"></A>

You must upload your own image.

To add the icon to the address bar, add the link tag to the <head> tag of the Visualforce page:
<link href='URI of feed'
type='application/x.atom+xml'
rel='feed'
title='A nice descriptive title'/>

About Syndication Feeds

Viewing Syndication Feeds
Testing Syndication Feeds

1239
Extend Salesforce with Clicks, Not Code Salesforce Sites

About Syndication Feeds

Syndication feeds give users the ability to subscribe to changes within Salesforce Sites and receive
EDITIONS
updates in external news readers. Simply by defining a SOQL query and mapping, you can syndicate
changes to public data to your end users. You can create one or more syndication feeds for your Available in: both Salesforce
organization's public sites or any Visualforce page. The syndication feed displays the records specified Classic (not available in all
by a SOQL query. Users can subscribe to the feed and view the feed when they visit the site or page. orgs) and Lightning
Experience
Validating Feeds Security Available in: Developer,
When a user subscribes to a feed, the information is run in a guest user context. This means that Enterprise, Performance,
you must ensure the guest user has access to all and only the records appropriate for a guest use and Unlimited Editions
before defining any queries.
To validate feeds security: USER PERMISSIONS
• Edit the public access setting for the site to make sure the guest user has the correct object Create, edit, or delete a feed
permissions and field-level security settings. definition:
• Create sharing rules to control which records the guest user has access to. • Modify All Data

After adjusting public access and field-level security settings to ensure the objects you wish to Subscribe to a feed
include in a feed are available to the guest user, perform any of the following feeds-related tasks: • No special user
permission required
• To create a new feed, click New.
• To view the definition of an existing feed, click the feed name.
• To edit an existing feed, click Edit.
• To delete an existing feed, click Delete.
• To test the validity of a feed, click Run Test. If any errors exist in the query definition or mapping, error messages are displayed.

Viewing Syndication Feeds

View the syndication feed definition, including what records are returned, and which data from the
EDITIONS
records is displayed:
Name Available in: both Salesforce
A descriptive name for this feed, which distinguishes it from other feeds you may create. Classic (not available in all
orgs) and Lightning
Description
Experience
Describes the feed. For example, “Account first name, last name, and region for the last ten
accounts created or edited.” Available in: Developer,
Enterprise, Performance,
Query
and Unlimited Editions
The SOQL query that defines which records are returned to the syndication feed. To ensure fast
performance, some limitations on the SOQL query are imposed. For more information, see
Defining Syndication Feeds on page 1235. USER PERMISSIONS
Mapping
Create, edit, or delete a feed
Because syndication feeds use the ATOM web publishing protocol, you must provide a mapping definition:
value that matches objects and fields on the returned records with ATOM constructs. Note that • Modify All Data
all values must be string literals. For more information about mapping elements, see Defining
Subscribe to a feed
Syndication Feeds on page 1235.
• No special user
Max Cache Age Seconds permission required
Because many users may access a feed at the same time, Salesforce caches the feed data, for
3600 seconds by default. This value can be a minimum of 300 seconds, or for as long as you

1240
Extend Salesforce with Clicks, Not Code Salesforce Sites

wish. Query results that are older than the time specified here are dropped, and a new query is run on the next request for that
information, that is, the next time a user opens a page containing a feed that they have subscribed to.
Active
This checkbox indicates whether the feed is available for subscription. Once a feed is active, users have the option of subscribing to
it.

Testing Syndication Feeds

Test the feed definition you have created before enabling it for customers.
EDITIONS
To test a feed:
Available in: both Salesforce
1. After creating a feed, from Setup, enter Sites in the Quick Find box, then select Sites
Classic (not available in all
and click the site for which you've defined the feed. Alternatively, you can navigate to the feed
orgs) and Lightning
detail page any number of ways, including clicking the feed name from the site detail page.
Experience
2. Click Preview for the feed you wish to test.
Available in: Developer,
3. If one or more bind variables have been used in the feed, a dialog appears. Enter a test value Enterprise, Performance,
for each bind variable. and Unlimited Editions
4. A dialog appears allowing you to create a bookmark for the feed with the bind variable values
you specified. You can save the bookmark, or cancel the dialog. USER PERMISSIONS
5. The values returned by your feed are displayed. Verify that the results are what you expected.
Create, edit, or delete a feed
definition:
• Modify All Data
Subscribe to a feed
• No special user
permission required

Managing Salesforce Sites Login and Registration Settings

Use login settings if you want to let users register for and log in to your portal from your public
EDITIONS
Salesforce Site. For example, users browsing through an ideas site can register and login directly
from that site, and as authenticated users, they can then vote, add comments, and participate in Available in: both Salesforce
the ideas community. When users successfully log in, they leave the public site and enter the Classic (not available in all
associated portal seamlessly. orgs) and Lightning
Experience
Note: Only Customer Portals can be used for self-registration. Partner portals do not support
self-registration. Available in: Developer,
The Authenticated Website high-volume portal user license is specifically designed to be Enterprise, Performance,
used with Salesforce sites. Because it's designed for high volumes, it should be a cost-effective and Unlimited Editions
option to use with Salesforce sites.
USER PERMISSIONS
Salesforce Sites provides built-in registration and login logic. Default Lightning Platform-branded
Visualforce pages are associated with registration, login, forgot password, and password changes. To create and edit Salesforce
You can modify these pages or replace them with your own. Sites:
The following login, and registration pages are provided by default: • Customize Application
OR
Create and Set Up
Experiences

1241
Extend Salesforce with Clicks, Not Code Salesforce Sites

Page Name Description

SiteLogin Default login page. Used to log users in to the associated portal
from your Salesforce Site.

SiteRegister Default registration page. Used to register new users for the
associated Customer Portal from your Salesforce Site.

SiteRegisterConfirm Default registration confirmation page. The page that users see on
successful registration to the associated Customer Portal.

The built-in login process:

• Checks to see whether the site is enabled for logins
• Checks to see whether the user is a valid user for the site
• Allows users to reset expired passwords
The built-in registration process:
• Checks new user information against existing users for the Customer Portal associated with the site
• Checks to see if a contact already exists for the new user
• Creates a new contact, if one doesn't already exist, and associates it with the account for the site.

Important: You must update the SiteRegisterController with the Account ID using the following steps:
1. From Setup, enter Apex Classes in the Quick Find box, then select Apex Classes.
2. Click Edit next to SiteRegisterController.
3. Find the private static Id PORTAL_ACCOUNT_ID = '<Account_ID>'; line and insert the ID for the
account that you want to associate with new users. The line should look similar to this:
private static Id PORTAL_ACCOUNT_ID = '001DoooooolQpyk';

4. Click Save.

• Enables the Customer Portal for the new user and sends an email confirmation message
• Optionally, allows users to create passwords on the registration page, avoiding the standard email confirmation process

Note: You can create and enable a person account as a Customer Portal user using the createPersonAccountPortalUser
Apex method. Use createPersonAccountPortalUser to create a person account using either the default record type
defined on the guest user's profile or a specified record type, then enable it for the site's portal. Person Accounts can only be
enabled as high-volume portal users.
To enable public login and registration for your portal:
1. From Setup, enter Sites in the Quick Find box, then select Sites.
2. Click the name of the site you want to control.
3. Click Login Settings.
4. Click Edit.
5. From the Enable Login For list, select a portal to associate with your site. The portal you choose must have the Login Enabled
option selected. For Customer Portals, you must also select the Self-Registration Enabled option. Salesforce Sites
leverages the following portal settings:

1242
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Logout URL is used if you want to take users to a specific page on logout. If this value is left blank, users are taken to the
page specified in the Active Site Home Page field for your site.
• Lost Password Template is used for the forgot password process.
• Header, Footer, Logo, and Login Message are used for the look and feel on IdeasHome and AnswersHome pages.
• For Customer Portals:
– New User Template is used on self-registration if a password is not provided.
– Default New User License, Default New User Role, and Default New User Profile are
used for self-registration.

6. Select a Change Password Page. A default page is provided, but you can select your own page instead, using the lookup field.
7. Select Allow Access to Standard Salesforce Pages to let authenticated users access standard Salesforce pages
as allowed by their access controls. This setting is enabled by default. If this setting is disabled, authenticated users can’t access
standard Salesforce pages, even if their access controls allow it.
8. The Secure Web Address field shows the unique Salesforce Sites URL for this site when using SSL.
9. Click Save.
You can also enable Sites to use your identity provider for single sign-on.

SEE ALSO:
Configure Salesforce Sites

Public Access Settings for Salesforce Sites

Control what public users can do on each Salesforce Sites site.
EDITIONS
To set the public access settings for your site:
Available in: both Salesforce
1. From Setup, enter Sites in the Quick Find box, then select Sites.
Classic (not available in all
2. Click the name of the site you want to control. orgs) and Lightning
3. Click Public Access Settings to open the Profile page for your site profile. Experience

This page includes all the functionality for viewing and editing profile permissions and settings, but Available in: Developer,
you can't clone or delete the profile. Enterprise, Performance,
and Unlimited Editions
In the site profile, you can:
• Set the object permissions for your site. You can grant “Read” and “Create” permissions on all
standard objects except products, price books, and ideas; and “Read,” “Create,” “Edit,” and USER PERMISSIONS
“Delete” on all custom objects. All permissions that aren't set by default must be set manually. To create and edit Salesforce
Sites:
Warning: We recommend setting the default external access to Private for the objects
• Customize Application
on which you grant “Read” access for your site on the Sharing Settings Setup page. This
ensures that users accessing your site can view and edit only the data related to your site. To edit public access
settings for Salesforce Sites:
We also recommend securing the visibility of all list views. Set the visibility of your list
• Manage Users
views to Visible to certain groups of users, and specify the groups
to share to. List views whose visibility is set to Visible to all users may be
visible to public users of your site. To share a list view with public users, create a new
public group for those users and give them visibility. If the object's sharing is set to private,
public users won't be able to see those records, regardless of list view visibility.

1243
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Control the visibility of custom apps. If you want to expose a custom app and its associated tabs to public users, make only that app
visible and make it the default to avoid exposing other pages. If any of your site pages use standard Salesforce headers, other visible
applications may be seen by public users.
• Set the login hours during which users can access the site.
• Restrict the IP address ranges from which you can access the site.

Note: To set restrictions based on IP or login hours, HTTPS is required.

All authenticated access requires HTTPS. Users logging into a site with a non-secure (HTTP) site URL are redirected to a secure
(HTTPS) URL.
The IP addresses in a range must be either IPv4 or IPv6. In ranges, IPv4 addresses exist in the IPv4-mapped IPv6 address space
::ffff:0:0 to ::ffff:ffff:ffff, where ::ffff:0:0 is 0.0.0.0 and ::ffff:ffff:ffff is
255.255.255.255. A range can’t include IP addresses both inside and outside of the IPv4-mapped IPv6 address space.
Ranges like 255.255.255.255 to ::1:0:0:0 or :: to ::1:0:0:0 aren’t allowed.

• Enable Apex controllers and methods for your site. Controllers and methods that are already associated with your site's Visualforce
pages are enabled by default.
• Enable Visualforce pages for your site. Changes made here are reflected on the Site Visualforce Pages related list on the Site Details
page, and vice versa.

Salesforce Sites URL Redirects

If you move or reorganize pages on your Salesforce Site, search engines may have trouble finding
EDITIONS
the new page locations. To avoid this, set up site URL redirects to inform users and search engines
that site content has moved. Available in: both Salesforce
Consider the following while implementing site URL redirects: Classic (not available in all
orgs) and Lightning
• You can't redirect error pages or CSS files (files with a .css extension).
Experience
• You can have a maximum of 6,000 redirect rules across all sites.
Available in: Developer,
• Query parameters in site URL redirects are matched exactly. However, you can't redirect any
Enterprise, Performance,
URLs that include the lastMod parameter.
and Unlimited Editions
• If you have URL rewriting enabled on your site, it runs after any site page redirects.
• You can redirect an Experience Cloud site home page to its companion Site.com home page.
USER PERMISSIONS
To do this, set the Source URL to /, which represents the home page for the Experience Cloud
site, and set the Target URL to s, which represents the home page for the Site.com site. To create and edit site URL
redirects:
To assign a redirect to a site page:
• Customize Application
1. From Setup, enter Sites in the Quick Find box, then select Sites.
To view site URL redirects:
2. Click a site label. • View Setup and
3. Click URL Redirects on the site detail page. Configuration

4. Specify the former page location in the Source URL field. The page location must:
• Be a relative URL. It can have any valid extension type, such as .html or .php.
• Not contain anchors, such as /siteprefix/page.html#target.

Note: Organizations that use sites with prefixes must manually add the prefix to the Source URL and Target URL fields. Also,
if your organization has a root level site and one with a prefix, and you want to redirect a page in your prefixed site but don't
include the prefix in the redirect rule, Salesforce will default to looking for the rule in your root site instead, resulting in a 404
error.

1244
Extend Salesforce with Clicks, Not Code Salesforce Sites

5. Specify the Redirect Type:

• Permanent (301)—Select this option if you want users and search engines to update the URL in their systems when visiting the
page. Users visiting a page redirected with this type are sent seamlessly to the new page. Using a permanent redirect ensures
that your URLs retain their search engine popularity ratings, and that search engines index the new page and remove the obsolete
source URL from their indexes.
• Temporary (302)—Select this option if you want users and search engines to keep using the original URL for the page. Search
engines interpret a 302 redirect as one that could change again at any time, and though they index and serve up the content
on the new target page, they also keep the source URL in their indexes.

6. Specify the new page location in the Target URL field. This can be a relative URL or a fully-qualified URL with an http:// or
https:// prefix. Unlike source URLs, target URLs can contain anchors.
7. Click Save.
The Redirect Rules section displays all URL redirect rules you've created for your site. In this section you can:
• Edit an assigned redirect rule.
• Activate or deactivate a redirect rule.
• Delete a redirect rule.
• Click the Source URL or Target URL column heading to sort the list in ascending or descending order.

SEE ALSO:
Salesforce Sites

Associate a Portal with Salesforce Sites

You can enable users to register for or log into an associated portal seamlessly from your site.
EDITIONS
Note: Only Customer Portals can be used for self-registration. Partner portals do not support
self-registration. Available in: both Salesforce
Classic (not available in all
The Authenticated Website high-volume portal user license is specifically designed to be orgs) and Lightning
used with Salesforce sites. Because it's designed for high volumes, it should be a cost-effective Experience
option to use with Salesforce sites.
Available in: Developer,
1. Enable the portal for login using the following steps: Enterprise, Performance,
and Unlimited Editions
a. From Setup, enter Customer Portal Settings in the Quick Find box, then
select Customer Portal Settings, or from Setup, enter Partners in the Quick Find
box, then select Settings. USER PERMISSIONS
b. If you have not enabled your portal, select Enable Customer Portal or Enable
To create and edit Salesforce
Partner Relationship Management and click Save. Sites:
c. Click Edit for the portal you want to modify. • Customize Application
d. Configure the portal as follows: OR

i. Select the Login Enabled checkbox. Create and Set Up

Experiences
ii. Select a user for the Administrator field.
iii. Optionally, set the Logout URL. If this is not set, users are taken to the site home
page on logout.
iv. Click Save.

1245
Extend Salesforce with Clicks, Not Code Salesforce Sites

2. If you are using a Customer Portal and want to allow self-registration, follow these steps:
a. From Setup, enter Customer Portal Settings in the Quick Find box, then select Customer Portal Settings.
b. Click Edit for the portal you want to associate with your Salesforce Site.
c. Configure the Customer Portal as follows:
i. Select Self-Registration Enabled.
ii. Select Customer Portal User for both the Default New User License and Default New User Profile
fields. Depending on your portal license, you may want to select a different profile for the Default New User
Profile field.
iii. Select User for the Default New User Role field.
iv. Click Save.

Note: Consider the following when allowing self-registration:

• Sites does not support the use of Person Accounts for self registration.
• On self-registration through a site:
– Validation rules are enforced on user creation.
– Validation rules are ignored on contact creation.

3. Associate the site pages with the default portal users:

a. From Setup, enter Customer Portal Settings in the Quick Find box, then select Customer Portal Settings,
or from Setup, enter Partners in the Quick Find box, then select Settings.
b. Click the name of the portal that you want to associate with your site.
c. Click the name of each profile associated with your portal users and do the following:
i. Scroll down to the Enabled Visualforce Page Access section and click Edit.
ii. Add the appropriate public site pages to the Enabled Visualforce Pages list. This allows portal users with that
profile to view these pages.

Note: By default, portal users can see all pages enabled for the associated public site, so you only have to enable the
pages that require authentication.

iii. Click Save.

4. Associate your site with the login-enabled portal:

a. From Setup, enter Sites in the Quick Find box, then select Sites.
b. Click the site label of the site you want to configure.
c. Click Login Settings.
d. Click Edit.
e. From the Enable Login For drop-down list, select the name of the portal where you want to allow login.
f. Select the Change Password Page.
g. Click Save.

For sites with Ideas, Answers, Chatter Answers, you must make the zone visible in the portal and enable the IdeasHome or AnswersHome
page for the site. To associate the zone with one or more portals:

1246
Extend Salesforce with Clicks, Not Code Salesforce Sites

1. From Setup, search for one of the following in the Quick Find box.
• Ideas Zones
• Chatter Answers Zones
• Answers Zones

2. Click Edit next to the zone you want to make public.

3. From the Portal drop-down list, select the portal to use for this zone. You can choose to show the zone in all portals.

Note: For ideas to work with sites, the organization must have an active portal associated with that zone. Otherwise, users will
encounter errors.

Managing Salesforce Site Visualforce Pages

Salesforce sites use Visualforce pages for all site and error pages. Sample error pages use the
EDITIONS
SiteSamples static resource for their style sheet and images.

Warning: To avoid errors, don't rename or delete SiteSamples. Available in: both Salesforce
Classic (not available in all
All pages that you want to expose on a site must be associated with that site. If a page is not listed orgs) and Lightning
under Site Visualforce Pages, an authentication or page-not-found error is displayed based on the Experience
existence of the page.
Available in: Developer,
To enable Visualforce pages for your site: Enterprise, Performance,
and Unlimited Editions
1. From Setup, enter Sites in the Quick Find box, then select Sites.
2. Click the name of the site you want to modify.
USER PERMISSIONS
3. Click Edit on the Site Visualforce Pages related list.
4. Use the Add and Remove buttons to enable or disable Visualforce pages for your site. To create and edit Salesforce
Sites:
5. Click Save. • Customize Application
Note: If you select a Visualforce page for any of the lookup fields on the Site Detail page, OR
any of the error pages, or the Change Password Page under login settings, that page Create and Set Up
is automatically enabled for your site. If you remove a page from this list, but it is still selected Experiences
in one of these places, public users can access that page. To completely remove pages from
your site, disable them here and make sure they are not selected in any lookup fields for your
site.
If you don't want to enable a Visualforce page for your entire site, you can also enable pages for specific profiles.

Note: When naming Visualforce pages hosted on force.com sites or Classic Experience Cloud sites, be sure to choose a name
that is different from standard platform urls.

The My Profile Page

The My Profile page is a Visualforce page associated with a Customer Portal or site user's profile. The My Profile page enables users logged
into either your Salesforce site, or your Customer Portal from Salesforce sites, to update their own contact information. When they make
changes to this page, the corresponding portal user and contact records are updated.
The My Profile page can be enabled either for your entire site or in a more restricted way by assigning it to the site guest user profile.
The My Profile page is also delivered as part of the Customer Portal Welcome component on your home page layout.

1247
Extend Salesforce with Clicks, Not Code Salesforce Sites

Manage Salesforce Sites Standard Pages

Salesforce Sites uses Visualforce pages for all site and error pages. Lightning Platform also provides
EDITIONS
some standard pages that you can use.
All pages that you want to expose on a site must be enabled for that site. If a page is not listed Available in: both Salesforce
under Site Standard Pages, Salesforce displays an authorization required error. Classic (not available in all
orgs) and Lightning
To control which standard pages users see for your site:
Experience
1. From Setup, enter Sites in the Quick Find box, then select Sites.
Available in: Developer,
2. Click the name of the site you want to view. Enterprise, Performance,
3. Click Edit on the Site Standard Pages related list. and Unlimited Editions

4. Use the Add and Remove buttons to enable or disable the following standard pages for your
site: USER PERMISSIONS
• Home Page—The standard page associated with the Home tab (/home/home.jsp). To create and edit Salesforce
• Ideas Pages—The standard pages associated with ideas. If you want to use default ideas Sites:
pages (for example, IdeasHome), enable these pages. • Customize Application
• Answers Pages—The standard pages associated with answers. If you want to use default OR
answers pages (for example, AnswersHome), enable these pages. Create and Set Up
• Search Pages—The standard Salesforce search pages. To allow public users to perform Experiences
standard searches, enable these pages.
• Lookup Pages—The standard Salesforce lookup pages. These are the popup windows
associated with lookup fields on Visualforce pages.

5. Click Save.

Note: Make sure to disable any pages that you are not actively using in your site. Otherwise, they may be accessible to public
users. Also, make sure to set up private sharing to restrict search and lookup access for public users.

1248
Extend Salesforce with Clicks, Not Code Salesforce Sites

Assigning Salesforce Site Error Pages

Salesforce sites use Visualforce pages for site and error pages. Sample error pages use the SiteSamples
EDITIONS
static resource for their style sheet and images.

Warning: To avoid errors, don't rename or delete SiteSamples. Available in: both Salesforce
Classic (not available in all
To set the error pages for your site: orgs) and Lightning
Experience
1. From Setup, enter Sites in the Quick Find box, then select Sites.
2. Click the name of the site you want to modify. Available in: Developer,
Enterprise, Performance,
3. Click Page Assignment on the Error Pages related list. and Unlimited Editions
4. Using the lookup fields, assign a Visualforce page or static resource for each of the standard
error conditions listed:
USER PERMISSIONS
• Authorization Required Page—The page users see when trying to access
pages for which they don’t have authorization. To create and edit Salesforce
Sites:
• Limit Exceeded Page—The page users see when your site has exceeded its • Customize Application
bandwidth limits.
OR
• Maintenance Page—The page users see when your site is down for maintenance.
Create and Set Up
• Service Not Available—No longer applicable. This custom page was previously Experiences
used when Salesforce servers were unavailable for HTTP-only requests, which are no longer
supported. When Salesforce servers are unavailable for a Salesforce Site, the Maintenance
page is displayed.

Tip: To display a custom page when Salesforce servers are unavailable, use Experience Cloud sites.

• Page Not Found Page—The page users see when trying to access a page that can’t be found. You can use the action
attribute on an <apex:page> component to redirect the Page Not Found error page. Using this kind of redirect on any other
error pages will redirect users to the Maintenance page.
• Generic Error Page—The page users see when encountering generic exceptions.

Note: When using static resources in a custom error page—such as a large image file or a large CSS file contained in a static
resource .zip file—each individual resource must be no larger than 50 KB. Otherwise, a 404 not found error is returned for that
resource.

5. Click Save.
6. On the Site Details page, click Preview to view the associated page as it would appear in a browser.

Tip: Add the <site:previewAsAdmin /> component right before the closing </apex:page> tag in your custom
Visualforce error pages to view detailed site error messages in administrator preview mode.
For inactive sites, the default error page is the Under Construction page, and can’t be overridden using page assignments. You can
override the default error page by assigning a simple HTML custom Visualforce page in the Inactive Site Home Page field.

What Happened to My Custom Error Page?

In certain circumstances, when you configure your site to display a custom error page, your site displays the standard Service Not Available
page instead. This change happens by design when you switch to using the Salesforce content delivery network (CDN). This change
also happens for sites that switch to using enhanced domains, because the Salesforce CDN is enabled by default for enhanced domains.
If you want to use a custom-branded error page, you have two options.

1249
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Use Experience Builder to customize the standard Service Not Available page to fit your brand (recommended).
• Use your custom Visualforce error page by uploading it as a static resource. Make sure that the static resource contains all the resources
your custom error page requires, and then select it under Workspaces > Administration > Pages > Service Not Available.
Interested in the technical details? When you enable the Salesforce CDN, your site traffic goes through our CDN partner. When our CDN
partner receives 500, 502, 503, or 504 response codes from Salesforce, it responds with a 503 error code and displays the default Service
Not Available page.

Troubleshooting Salesforce Sites Using Administrator Preview Mode

If you see errors on site pages and can't figure out the cause, use administrator preview mode to
EDITIONS
look at them in context and in greater detail.

Note: Administrator preview mode is available for all active sites, including those with a Available in: both Salesforce
branded custom Web address. Classic (not available in all
orgs) and Lightning
To access administrator preview mode: Experience
1. From Setup, enter Sites in the Quick Find box, then select Sites.
Available in: Developer,
2. Click the name of the site you want to preview. Enterprise, Performance,
and Unlimited Editions
3. In the Site Detail section, click the Preview as Admin link. A new browser window opens with
a preview of your site, and the enhanced error message appears at the bottom of the page.
4. Click Logout of Administrator Preview Mode to clear the administrator cookie and be USER PERMISSIONS
redirected to the site's home page.
To create and edit Salesforce
The detailed error messages in administrator preview mode are driven by the Sites:
<site:previewAsAdmin /> component in your Visualforce error pages. Starting with • Customize Application
Summer '10, new organizations include the <site:previewAsAdmin /> component by
default in standard error pages. You must add the component manually to all custom error pages
and pages from older organizations. We recommend that you add it right before the closing </apex:page> tag, like this:
<site:previewAsAdmin />
</apex:page>

Note: The <site:previewAsAdmin /> component contains the <apex:messages /> tag, so if you have that tag
elsewhere on your error pages, you will see the detailed error message twice.

SEE ALSO:
Create and Edit Salesforce Sites

1250
Extend Salesforce with Clicks, Not Code Salesforce Sites

Configure Site Caching

Caching your Salesforce Site pages, attachments, and static resources can improve page load times
EDITIONS
and site performance. It can also help you avoid reaching bandwidth and service request time limits.
You can choose whether to cache pages on proxy servers or your end users’ web browsers. To Available in: both Salesforce
optimize content delivery to your end users, you can enable or disable caching and set the cache Classic (not available in all
duration for each of your site’s pages, attachments, and static resources. orgs) and Lightning
Experience

Site-Level Caching Option Available in: Developer,

Enterprise, Performance,
The Cache public Visualforce pages Sites setting controls where pages are cached and for which and Unlimited Editions
users. The setting is enabled by default for new sites.
• If the setting is enabled, proxy servers only cache publicly available pages visited by
unauthenticated guest users. If the site isn’t served by Salesforce Edge Network or a custom domain using the CDN HTTPS option,
then while a page is cached for guest users, an authenticated version of that page can be served to authenticated users. To disable
caching of an individual publicly available Visualforce page when this setting is enabled, set the page’s boolean cache attribute
to false.
• If the setting is disabled, the proxy server doesn’t cache any of the site’s Visualforce pages. Instead, the site’s cache-enabled Visualforce
pages are cached in the web browser for both authenticated and unauthenticated users. This caching behavior matches caching
for Visualforce pages served by Salesforce outside of a site.

Page-Level Caching Options

Control the caching behavior for your site by setting the boolean cache attribute and integer expires attribute on each Visualforce page.
For example, a page whose cache is set to expire in 15 minutes looks like this:
<apex:page cache="true" expires="900">

Caching Behavior for Static Site Resources

Static site resources such as images, style sheets, and scripts are cached based on the Cache Control attribute on the resource.
For more information, see Define Static Resources in Salesforce Help.

Caching Behavior for Attachments

For attachments stored in Experience Cloud sites and Salesforce Sites, the caching behavior varies based on the type of attachment.

ATTACHMENT TYPE CACHING BEHAVIOR CACHING LOCATION

Documents and Cache expires according to maxage parameter, in End user’s web browser
attachments seconds. For example:
/servlet/servlet.FileDownload?file=<FileID>&maxage=600

Images in a rich text area Cache expires in 45 days. Unauthenticated guest users without IP restrictions:
Proxy server
Guest users with IP restrictions and authenticated
users: end user’s web browser

1251
Extend Salesforce with Clicks, Not Code Salesforce Sites

Caching Behavior for Visualforce Pages

The location and duration for caching a site page varies based on the site-level setting, Cache public Visualforce pages.
• When the Setting Is Enabled—When caching for public Visualforce pages is enabled, caching behavior varies based on the type of
user accessing the page and whether logins are enabled on the site.
An unauthenticated user visits a login-enabled Salesforce Site:

PAGE’S CACHE ATTRIBUTE CACHING BEHAVIOR CACHING LOCATION

Set to true Cache expires according to the page’s expires Proxy server
attribute. If the page’s expires attribute isn’t set,
cache expires in 600 seconds (10 minutes).

Set to false Not cached. None

Not set Cache expires according to the page’s expires Proxy server
attribute. If the page’s expires attribute isn’t set,
cache expires in 600 seconds (10 minutes).

An authenticated user visits a login-enabled Salesforce Site:

PAGE’S CACHE ATTRIBUTE CACHING BEHAVIOR CACHING LOCATION

Set to true Not cached. None

Set to false Not cached. None

Not set Not cached. None

A user visits a Salesforce Site that isn’t login-enabled:

PAGE’S CACHE ATTRIBUTE CACHING BEHAVIOR CACHING LOCATION

Set to true Cache expires according to the page’s expires Proxy server and end user’s web
attribute. If the page’s expires attribute isn’t set, browser
cache expires in 600 seconds (10 minutes).

Set to false Not cached. None

Not set Cache expires according to the page’s expires Proxy server and end user’s web
attribute. If the page’s expires attribute isn’t set, browser
cache expires in 600 seconds (10 minutes).

• When the Setting is Disabled—When caching for public Visualforce pages is turned off, the behavior is the same for authenticated
users and unauthenticated guest users to the site. This caching behavior matches caching for Visualforce pages served by Salesforce
outside of a site.

1252
Extend Salesforce with Clicks, Not Code Salesforce Sites

PAGE’S CACHE ATTRIBUTE CACHING BEHAVIOR CACHING LOCATION

Set to true Cache expires according to the page’s expires End user’s web browser
attribute. If the page’s expires attribute isn’t set,
cache expires in 0 seconds.

Set to false Not cached. None

Not set Not cached. None

SEE ALSO:
Salesforce Sites Usage and Billing
Define Static Resources

Using Workflow for Salesforce Sites

With workflow for sites, you can create workflow rules that trigger email alerts when certain
EDITIONS
site-related criteria are met. For example, create a rule that sends your site administrator an email
alert when bandwidth usage reaches 80% of the daily bandwidth limit or when a site's status Available in: Lightning
changes from the active state. Experience and Salesforce
Setting up the right site usage workflow rules can help you keep your sites from exceeding rolling Classic
24-hour limits for bandwidth and service request time, and monthly limits for page views and logins.
Available in: Enterprise,
Workflow rules that are created on the Site object are evaluated every hour for all sites within the Performance, Unlimited,
organization, unless your criteria is limited to certain sites. Workflow rules that are created on the and Developer Editions
Organization and User License objects are evaluated every three hours.
Only email alert actions are supported for site usage workflow rules. Other workflow actions, such
USER PERMISSIONS
as field updates, tasks, and outbound messages, are not available.
To create a site usage workflow rule, create a workflow rule with the following settings: To create or change
workflow rules:
Select Object • Customize Application
When selecting an object, choose one of the following:
To create and edit Salesforce
• Organization (for monthly page views allowed and monthly page views used fields) Sites:
• Site (for site detail, daily bandwidth and request time, monthly page views allowed, and • Customize Application
other fields)
• User License (for the monthly logins allowed and monthly logins used fields)
The Organization and Site objects are only available if Salesforce Sites is enabled for your organization. The User License object isn't
dependent on sites, and is only available if you have Customer Portals or partner portals enabled for your organization.
Rule Criteria
Enter your rule criteria by doing one of the following:
• Choose criteria are met and select the filter criteria that a site must meet to trigger the rule. For example, to trigger
the rule every time the active status changes for a site within your organization, set the filter to Site Status not equal
to Active. To add more rows or to set up Boolean conditions, click Add Filter Logic.
• Choose formula evaluates to true and enter a formula. The rule is triggered if the formula returns “True.”

1253
Extend Salesforce with Clicks, Not Code Salesforce Sites

For example, the following formula triggers the rule when bandwidth usage reaches 80% of the daily bandwidth limit:
DailyBandwidthUsed >= 0.8 * DailyBandwidthLimit

In the next example, the formula triggers the rule when time usage reaches 80% of the daily time limit:
DailyRequestTimeUsed >= 0.8* DailyRequestTimeLimit

Workflow actions
When adding workflow actions, click Add Workflow Action and choose New Email Alert or Select Existing
Action.

Tip: To create custom email templates using Site merge fields, from Setup, enter Email Templates in the Quick
Find box, then select Email Templates, then New Template. When configuring the template, use Site merge fields by
selecting Site Fields in the Select Field Type drop-down list of the Available Merge Fields section.

SEE ALSO:
Salesforce Sites

Track Your Salesforce Sites with Google Analytics

Salesforce Sites provides out-of-the-box integration with Google Analytics. Use Google Analytics
EDITIONS
to track the usage of your sites and site pages, including number of visits, number of page views,
average time spent on site, and more. Available in: both Salesforce
Note: The <site:googleAnalyticsTracking/> component only works on Classic (not available in all
orgs) and Lightning
pages used in a Salesforce Site. Sites must be enabled for your organization and the
Experience
Analytics Tracking Code field must be populated. To get a tracking code, go to
the Google Analytics website. Available in: Developer,
To track a site using Google Analytics: Enterprise, Performance,
and Unlimited Editions
1. Sign up for an account at Google Analytics.
2. Add a new profile in Google Analytics and enter the domain or full URL for the site you want
USER PERMISSIONS
to track.
3. Copy the Web Property ID from Google's tracking status information and paste it into To create and edit Salesforce
the Analytics Tracking Code field on the Site Edit page for the site you want to Sites:
• Customize Application
track. The Web property ID starts with the letters UA followed by your account and profile
numbers. For example, UA-9049246-2. OR

4. Click Save. Create and Set Up

Experiences
5. To track the Visualforce pages associated with your site, enter the following tag in the site
template for those pages, or in the individual pages themselves:

<site:googleAnalyticsTracking/>

Pages that don't contain the tag and aren't associated with a site template that contains the tag won't be tracked. The default site
template already contains the tag, so all pages using that template will be tracked—including certain default pages.

Note: Google recommends adding the component at the bottom of the page to avoid increasing page load time.

6. Go to the Google Analytics site and follow their instructions for completing the process. After signing up, it may take up to 24 hours
to see initial tracking results in Google Analytics.

1254
Extend Salesforce with Clicks, Not Code Salesforce Sites

Tip: To track multiple sites separately, create separate profiles using the full site URLs and enter a different Web property ID in the
Analytics Tracking Code field for each site.

SEE ALSO:
Managing Salesforce Sites
Create and Edit Salesforce Sites
Reporting on Salesforce Sites

Viewing Salesforce Sites History

To view the site history:
EDITIONS
1. From Setup, enter Sites in the Quick Find box, then select Sites.
Available in: both Salesforce
2. Click the name of the site you want to view.
Classic (not available in all
3. View the Site History related list. orgs) and Lightning
The Site History related list tracks and displays the changes made to your site. All of the following Experience
events are tracked in the site history, along with the user who made the change and the time it Available in: Developer,
occurred: Enterprise, Performance,
and Unlimited Editions
Event Description
Site Creation Logs when each site was created. USER PERMISSIONS
Site Detail Changes Changes to the following site values are logged: To create and edit Salesforce
• Site Label Sites:
• Customize Application
• Site Name
OR
• Site Description
Create and Set Up
• Site Contact Experiences
• Default Web Address
• Custom Web Address
• Active Status
• Active Site Home Page
• Inactive Site Home Page
• Site Template
• Site Robots.txt
• Site Favorite Icon
• Analytics Tracking Code
• Enable Feeds

Site Standard Pages Logs when any standard page is enabled or

disabled.

Site Error Pages Logs when any error page assignment is

changed.

1255
Extend Salesforce with Clicks, Not Code Salesforce Sites

Event Description
Login Settings Changes Changes to the following login settings are logged:
• Portal
• Change Password Page
• Require Non-Secure Connections (HTTP)

Note: The Require Non-Secure Connections (HTTP) setting

is removed in Winter ’21 and later.

URL Redirect Changes Logs when any URL redirect is created, deleted, enabled, disabled,
or changed.

SEE ALSO:
Salesforce Sites

Viewing 24-Hour Salesforce Sites Usage History

Monitor the bandwidth and request time usage for each of your sites by viewing the usage data
EDITIONS
tracked on this related list. By closely monitoring your sites, you can avoid exceeding your limits.
To view the 24-hour usage history for your site: Available in: both Salesforce
Classic (not available in all
1. From Setup, enter Sites in the Quick Find box, then select Sites.
orgs) and Lightning
2. Click the name of the site you want to view. Experience
3. View the 24-Hour Usage History related list. Usage information may be delayed by up to several Available in: Developer,
minutes due to processing time. Enterprise, Performance,
The 24-Hour Usage History related list tracks and displays the following usage metrics for your site: and Unlimited Editions

Metric How It's Calculated USER PERMISSIONS

Origin Bandwidth Bandwidth is calculated as the number of megabytes served and received
To create and edit Salesforce
from the site's origin server. The Daily Limit applies to a rolling 24-hour Sites:
period. • Customize Application
Request Time “Service request time” is calculated as the total server time in minutes required OR
to generate pages for the site. The Daily Limit applies to a rolling Create and Set Up
24-hour period. Experiences

“Origin server” refers to the web server that hosts your site. “Rolling 24-hour period” refers to the 24 hours immediately preceding the
current time.
For each metric, the related list displays Current Usage, Daily Limit, and the Percent Used.

1256
Extend Salesforce with Clicks, Not Code Salesforce Sites

Reporting on Salesforce Sites

To keep track of your site activity and usage, take advantage of the Sites Usage Reporting managed
EDITIONS
package to analyze your monthly page views, daily bandwidth, and daily service request time so
you can avoid reaching monthly and daily limits for individual sites, as well as for your organization. Available in: both Salesforce
To get started using Salesforce Reports and Dashboards for sites: Classic (not available in all
orgs) and Lightning
1. Install the Sites Usage Reporting managed package.
Experience
2. Use packaged reports to analyze site usage.
Available in: Developer,
3. Optionally, create custom reports to analyze site usage. Enterprise, Performance,
4. Use the Site Usage Dashboard to monitor sites. and Unlimited Editions

Install the Sites Usage Reporting Managed Package USER PERMISSIONS

The Sites Usage Reporting managed package, available on AppExchange, contains out-of-the-box To install packages:
reports and a dashboard for monitoring sites usage. • Download AppExchange
Packages
To find the Sites Usage Reporting managed package, go to AppExchange and search on “sites
reporting,” or go to To run reports:
• Run Reports
AND
Read on the records
included in reports

To create, edit, save, and

delete reports:
• Run Reports and Read
on the records included
in the reports
AND
Create and Customize
Reports

To create, edit, and delete

dashboards:
• Run Reports
AND
Manage Dashboards

https://appexchange.salesforce.com/listingDetail?listingId=a0N30000001SUEwEAO.

Use Packaged Reports to Analyze Site Usage

The Sites Usage Reporting managed package contains the following reports for the sites in your organization. You can find these reports
in the Site Usage Reports folder under All Reports in the Reports tab. You can also select Site Usage Reports in the Folder drop-down
list, then click Go.

Note: Site usage data is aggregated at midnight, GMT, so the current day's page view counts may not be accurately reflected in
reports, depending on your time zone. Cache server page views may take a day or more to be reflected in reports.

1257
Extend Salesforce with Clicks, Not Code Salesforce Sites

Report Description
Current Period Page Views Shows the total page views for the current period (calendar month), measured against page
views allowed. Page views are broken down by site and by day. The current period limit applies
to all sites within the organization.

Daily Total Bandwidth Usage Shows the total bandwidth usage over the last 30 days, broken down by site, by day, and by
origin and cache servers.

Daily Total Page Views Shows the total page views over the last 30 days, broken down site, by day, and by origin and
cache servers.

Site Daily Origin Bandwidth Usage Shows the total origin bandwidth usage over the last 30 days, broken down by site and by day.

Site Daily Request Time Usage Shows the total origin service request time over the last 30 days, broken down by site and by
day.

Top Bandwidth Consuming Sites Shows the sites that consumed the most bandwidth during the current period.

Top Resource Consuming Sites Shows the sites that consumed the most service request time during the current period.

Top Sites by Page Views Shows the sites that generated the most page views during the current period.

Create Custom Reports to Analyze Site Usage

You can also create custom reports on sites:
1. From the Reports tab, click New Report.
2. For the report type, select Administrative Reports, then Site Usage Reports. You must enable sites for your organization and
install the Sites Usage Reporting managed package to see the Site Usage Reports custom report type.
3. Click Create to create a custom report. Fields related to your sites, such as Site Name, Site Status, Daily Bandwidth
Limit, and Daily Request Time Limit can all be used in your custom report.

Note: When you create your own custom reports using the Site Usage Reports custom report type, be aware that the Origin
Bandwidth column is measured in bytes, and the Request Time column is measured in milliseconds. Make sure you
consider the difference in units when comparing these columns to the Daily Bandwidth Limit and Daily Request
Time Limit columns, which are measured in megabytes and minutes, respectively.
For the out-of-the-box reports included with the managed package, bandwidth is measured in megabytes and request time is
measured in minutes.

Use the Site Usage Dashboard to Monitor Sites

The Sites Usage Reporting managed package contains the Site Usage Dashboard to help you monitor the sites in your organization at
a glance. The dashboard contains a component for each of the reports provided in the managed package.
To access the dashboard, from the Dashboards tab:
• Use the View Dashboard field.
• Or, click Go to Dashboard List and select Site Usage Dashboard from the dashboard list.

1258
Extend Salesforce with Clicks, Not Code Salesforce Sites

To modify the dashboard, click Edit. You can also create your own custom dashboard using any custom reports you may have created.
Consider adding the Site Usage Dashboard as the dashboard snapshot on your home page.

SEE ALSO:
Track Your Salesforce Sites with Google Analytics

Salesforce Sites Security

Review how the Sites and Domains settings related to secure connections affect what your users
EDITIONS
see when accessing your org.
All authenticated access requires HTTPS. Users logging into a site with a non-secure (HTTP) site URL Available in: both Salesforce
are redirected to a secure (HTTPS) URL. To set restrictions based on IP or login hours, HTTPS is Classic (not available in all
required. orgs) and Lightning
Experience
Salesforce requires HTTPS connections to all sites and automatically upgrades HTTP requests. If
you’re using a custom domain to serve a site, to ensure connectivity, we recommend that you select Available in: Developer,
one of the options to serve your domain over HTTPS. Only select the Use a temporary non-HTTPS Enterprise, Performance,
domain option if you’re configuring your domain before it can be secured with HTTPS. For example, and Unlimited Editions
to configure DNS or add a subdomain whose CNAME points to another service. For more information,
see Custom Domains.
These behaviors and sharing settings affect users accessing sites.

Warning:
• We recommend setting the default external access to Private for the objects on which you grant “Read” access for your site
on the Sharing Settings Setup page. This ensures that users accessing your site can view and edit only the data related to your
site.
• We also recommend securing the visibility of all list views. Set the visibility of your list views to Visible to certain
groups of users, and specify the groups to share to. List views whose visibility is set to Visible to all users
may be visible to public users of your site. To share a list view with public users, create a new public group for those users and
give them visibility. If the object's sharing is set to private, public users won't be able to see those records, regardless of list
view visibility.

• For custom domains with the Use a temporary non-HTTPS domain HTTPS option selected, if users connect using HTTP instead of
HTTPS, they can experience a connection timeout.
• If a user opens a custom domain with the Use a temporary non-HTTPS domain HTTPS option selected, we attempt to redirect the
user to the site's preferred HTTPS custom domain. If the site doesn’t have a preferred HTTPS custom domain, the user is redirected
to the org's my.salesforce-sites.com domain. In sandboxes and Developer Edition orgs, the org's
my.salesforce-sites.com domain is used. For example, you registered www.example.com as an HTTP-only custom
domain. When the URL is upgraded to HTTPS and no HTTPS-capable custom domains are linked to the site, the URL changes to
https://MyDomainName.my.salesforce-sites.com. For more information, see Managing Salesforce Sites Login
and Registration Settings.If you’re not using enhanced domains, your org’s Salesforce Sites URL is different. For details, see My Domain
URL Formats in Salesforce Help.
• Authenticated and non-authenticated users may see different error messages for certain conditions—for example, on Apex exceptions.
• Cache settings on static resources are set to private when accessed via a Salesforce Site whose guest user's profile has restrictions
based on IP range or login hours. Sites with guest user profile restrictions cache static resources only within the browser. Also, if a
previously unrestricted site becomes restricted, it can take up to 45 days for the static resources to expire from the Salesforce cache
and any intermediate caches.

1259
Extend Salesforce with Clicks, Not Code Salesforce Sites

• Guest users aren’t owners of records they create in Salesforce Sites. Instead, when a guest user creates a record in a Salesforce Site,
the record’s ownership is assigned to the site’s default record owner.

SEE ALSO:
My Domain URL Formats

Salesforce Sites-Related Apex Methods and Expressions

EDITIONS
Lightning Platform Apex Methods
Apex methods for Salesforce Sites are contained in the site class, cookie class, and Available in: both Salesforce
urlRewriter class. See the Lightning Platform Apex Code Developer's Guide. Classic (not available in all
orgs) and Lightning
Experience
Salesforce Sites-Related Expressions
Available in: Developer,
Lightning Platform also provides the following expressions to use on Visualforce pages, email Enterprise, Performance,
templates, and s-controls: and Unlimited Editions

Merge Field Description

USER PERMISSIONS
$Site.Name Returns the API name of the current site.
To create and edit Salesforce
$Site.Domain Returns your Salesforce Sites based URL. Sites:
• Customize Application
$Site.CustomWebAddress Returns the request's custom URL if it doesn't end in
force.com or returns the site's primary custom URL. If OR
neither exist, then this returns an empty string. Note that Create and Set Up
the URL's path is always the root, even if the request's custom Experiences
URL has a path prefix. If the current request is not a site
request, then this field returns an empty string. This field's
value always ends with a / character. Use of
$Site.CustomWebAddress is discouraged and we
recommend using $Site.BaseCustomUrl instead.

$Site.OriginalUrl Returns the original URL for this page if it’s a designated error
page for the site; otherwise, returns null.

$Site.CurrentSiteUrl Returns the base URL of the current site that references and
links should use. Note that this field might return the referring
page's URL instead of the current request's URL. This field's
value includes a path prefix and always ends with a /
character. If the current request is not a site request, then
this field returns an empty string. Use of $Site.CurrentSiteUrl
is discouraged. Use $Site.BaseUrl instead.

$Site.LoginEnabled Returns true if the current site is associated with an active

login-enabled portal; otherwise returns false.

$Site.RegistrationEnabled Returns true if the current site is associated with an active

self-registration-enabled Customer Portal; otherwise returns
false.

1260
Extend Salesforce with Clicks, Not Code Salesforce Sites

Merge Field Description

$Site.IsPasswordExpired For authenticated users, returns true if the currently logged-in user's password
is expired. For non-authenticated users, returns false.

$Site.AdminEmailAddress Returns an empty string. This merge field is deprecated.

$Site.Prefix Returns the URL path prefix of the current site. For example, if your site URL is
MyDomainName.my.salesforce-sites.com/partners,
/partners is the path prefix. Returns null if the prefix isn’t defined. If the
current request is not a site request, then this field returns an empty string.

$Site.Template Returns the template name associated with the current site; returns the default
template if no template has been designated.

$Site.ErrorMessage Returns an error message for the current page if it’s a designated error page for the
site and an error exists; otherwise, returns an empty string.

$Site.ErrorDescription Returns the error description for the current page if it’s a designated error page for
the site and an error exists; otherwise, returns an empty string.

$Site.AnalyticsTrackingCode The tracking code associated with your site. Services such as Google Analytics can
use this code to track page request data for your site.

$Site.BaseCustomUrl Returns a base URL for the current site that doesn’t use a subdomain. The returned
URL uses the same protocol (HTTP or HTTPS) as the current request if at least one
non-force.com custom URL that supports HTTPS exists on the site. The returned
value never ends with a / character. If all the custom URLs in this site end in
force.com or salesforce-sites.com, or this site has no custom URL’s,
then this returns an empty string. If the current request is not a site request, then
this method returns an empty string.
This field replaces CustomWebAddress and includes the custom URL's path
prefix.

$Site.BaseInsecureUrl This merge field is deprecated. Returns a base URL for the current site that uses
HTTP instead of HTTPS. The current request's domain is used. The returned value
includes the path prefix and never ends with a / character. If the current request
is not a site request, then this method returns an empty string

$Site.BaseRequestUrl Returns the base URL of the current site for the requested URL. This isn't influenced
by the referring page's URL. The returned URL uses the same protocol (HTTP or
HTTPS) as the current request. The returned value includes the path prefix and never
ends with a / character. If the current request is not a site request, then this method
returns an empty string.

$Site.BaseSecureUrl Returns a base URL for the current site that uses HTTPS instead of HTTP. The current
request's domain is preferred if it supports HTTPS. Domains that are not force.com
subdomains are preferred over force.com subdomains. A force.com subdomain, if
associated with the site, is used if no other HTTPS domains exist in the current site.
If there are no HTTPS custom URLs in the site, then this method returns an empty
string. The returned value includes the path prefix and never ends with a / character.
If the current request is not a site request, then this method returns an empty string.

1261
Extend Salesforce with Clicks, Not Code Salesforce Sites

Merge Field Description

$Site.BaseUrl Returns the base URL of the current site that references and links should use. Note
that this field may return the referring page's URL instead of the current request's
URL. This field's value includes the path prefix and never ends with a / character.
If the current request is not a site request, then this field returns an empty string.
This field replaces $Site.CurrentSiteUrl.

$Site.MasterLabel Returns the value of the Master Label field for the current site. If the current request
is not a site request, then this field returns an empty string.

$Site.SiteId Returns the ID of the current site. If the current request is not a site request, then
this field returns an empty string.

$Site.SiteType Returns the API value of the Site Type field for the current site. If the current request
is not a site request, then this field returns an empty string.

$Site.SiteTypeLabel Returns the value of the Site Type field's label for the current site. If the current
request is not a site request, then this field returns an empty string.

Note: To use these expressions, the Salesforce Sites feature must be enabled for your organization. You must also use them within
the context of your public site; otherwise, an empty string is returned for all expressions except {!$Site.Template}, which returns
the default template for the site.

Salesforce Sites Considerations

Before you create and use Salesforce Sites, consider the following:
EDITIONS
Packaging
The following apply to packaging for sites: Available in: both Salesforce
Classic (not available in all
• Sites are not packageable. However, you can package sample code, Visualforce pages, Apex
orgs) and Lightning
classes, or components for a site using a managed package.
Experience
• You must have Salesforce Sites enabled to be able to install unmanaged packages that
contain Visualforce pages or Apex classes that refer to a site. Available in: Developer,
Enterprise, Performance,
Access and Authentication and Unlimited Editions
You can grant “Read” and “Create” permissions on all standard objects except products, price
books, and ideas; and “Read,” “Create,” “Edit,” and “Delete” on all custom objects. For additional
access, you must authenticate site visitors as portal users.
Custom authentication isn’t supported. You can authenticate via the following:
• Customer Portals—enable public login and registration
• Partner portals—create partner users

Tip: You can also enable single sign-on for portals, as well as Sites.

URL Conflicts Between Sites

If you host multiple sites on the same Salesforce-managed domain, be sure to review your site URLs for conflicts, as it’s possible to
configure the same URL for pages on two different sites.

1262
Extend Salesforce with Clicks, Not Code Salesforce Sites

Let’s say you use https://SitesSubdomain.force.com for Site A’s homepage, and
https://SitesSubdomain.force.com/products for Site B’s homepage. If you create a page on Site A that uses the
subpath /products, that page and Site B’s homepage both use the URL
https://SitesSubdomain.force.com/products.
In this scenario, a site visitor can only access the Site A page through a navigation menu on Site A. If a site visitor navigates to
https://SitesSubdomain.force.com/products any other way, they’re directed to Site B’s home page.

SEE ALSO:
Setting Up Salesforce Sites

Salesforce Sites Usage and Billing

Salesforce Sites usage is governed by monthly and daily allocations. Understanding these allocations
EDITIONS
is important to the success of your sites.
Salesforce provides tools to help you reduce bandwidth consumption and monitor site usage. Available in: both Salesforce
Classic (not available in all
• Usage and Billing Terminology
orgs) and Lightning
• Sites Allocation by Edition Experience
• Bandwidth and Service Request Time Limit Enforcement
Available in: Developer,
• Billing and Monthly Page Views Enforcement Enterprise, Performance,
• What Counts as a Page View? and Unlimited Editions
• Monitoring Usage

Usage and Billing Terminology

This section defines the terminology used for Salesforce Sites usage and billing.
• “Page Views” are calculated as the total number of pages served from the site's origin server.
• “Bandwidth” is calculated as the number of megabytes served and received from both the site's origin server and the cache server.
• “Service request time” is calculated as the total server time in minutes required to generate pages for the site.
• “Rolling 24-hour period” refers to the 24 hours immediately preceding the current time.
• “Origin server” refers to the web server that hosts your site.
• “Cache server” refers to the CDN server that serves your cached site pages.
• “Current period” refers to the current calendar month for which you are entitled a certain number of page views for your organization.

Sites Allocation by Edition

The following table lists allocations for each edition.

Edition Maximum Bandwidth Allocation (per Service Request Time (per Maximum Page
Number of Sites rolling 24-hour period per rolling 24-hour period per Views
site) site)
Developer Edition 1 500 MB 10 minutes N/A

Enterprise Edition 25 1 GB for sandbox 30 minutes for sandbox 500,000

40 GB for production 60 hours for production

1263
Extend Salesforce with Clicks, Not Code Salesforce Sites

Edition Maximum Bandwidth Allocation (per Service Request Time (per Maximum Page
Number of Sites rolling 24-hour period per rolling 24-hour period per Views
site) site)
Unlimited Edition 25 1 GB for sandbox 30 minutes for sandbox 1,000,000
Performance Edition 40 GB for production 60 hours for production

Make sure to consider the available caching options to keep you within your allocation. Use the Site Usage analytics tools to monitor
your Salesforce Sites.

Bandwidth and Service Request Time Limit Enforcement

Bandwidth and Service Request Time limits are tracked and enforced over a 24-hour period. Sites that exceed provisioned limits within
the 24-hour period remain available if the host instance has resources to serve the site. However, even if a site is available once limits
are exceeded, there’s no guarantee in service level.

Billing and Monthly Page Views Enforcement

This section describes how Salesforce enforces limits on monthly page views for Salesforce Sites.
• Billing is based on the number of monthly page views purchased for your organization. This page view limit is cumulative for all
Salesforce Sites in your organization.
• If your organization exceeds 110% of its page view limit for four consecutive calendar months, your Salesforce Sites can be disabled
until the next calendar month begins or you purchase more page views. Before disabling Salesforce Sites for this reason, Salesforce
sends an email notification to the site and billing administrators, and the related account executive.
• If, in a given calendar month, your organization reaches 300% of its page view limit, your Salesforce Sites can be disabled until the
next calendar month begins or you purchase more page views. Before disabling Salesforce Sites for this reason, Salesforce sends an
email notification to the site and billing administrators, and the related account executive.

What Counts as a Page View?

This section describes how page views are counted for Salesforce Sites.
A page view is a request from a non-authenticated site user to load a page associated with one of the sites within your Salesforce Sites
domain or custom domain. Requests from authenticated portal users are not counted as page views.
Requests that Count as Page Views
Requests for the following are counted as page views.

Note: If you’re not using enhanced domains, your org’s My Domain URLs are different. For details, see My Domain URL Formats
in Salesforce Help.

Requests for... Example URL

Your Salesforce Sites domain https://MyDomainName.my.salesforce-sites.com

Your custom web address https://mycompany.com

Any page associated with your site https://MyDomainName.my.salesforce-sites.com/mypage

Authorization Required error page https://MyDomainName.my.salesforce-sites.com/Unauthorized

1264
Extend Salesforce with Clicks, Not Code Salesforce Sites

Requests for... Example URL

AJAX requests such as: n/a

• JavaScript remoting (for example, Apex

RemoteAction)
• Lightning
• Visualforce <apex:actionFunction>
• Visualforce <apex:actionPoller>

Requests that Do Not Count as Page Views

Requests for the following are not counted as page views.

Requests for... Example URL

Salesforce images https://MyDomainName.my.salesforce-sites.com/img/force_logo_w09.gif

Your static resources https://MyDomainName.my.salesforce-sites.com/resource/1233771498000/background

Robots.txt https://MyDomainName.my.salesforce-sites.com/robots.txt

Favorite icon https://MyDomainName.my.salesforce-sites.com/favicon.ico

Attachments and Documents n/a

Error pages, apart from https://MyDomainName.my.salesforce-sites.com/BandwidthExceeded

Authorization Required, such as
Limit Exceeded and Maintenance

Images included with an HTML field https://MyDomainName.my.salesforce-sites.com/servlet/rtaImage

Custom file field https://MyDomainName.my.salesforce-sites.com/servlet/fileField

Note: Limit Exceeded, Maintenance, Page Not Found, and designated Inactive Home pages aren't counted against page view
and bandwidth limits. You can use static resources to brand these pages, but the following limitations apply.
• Static resources must be 50 KB or smaller in size.
• Static resources must be style sheets (CSS), image files, or JavaScript files.
• You can't use Apex controllers for these pages.
• You can't perform SOQL or DML operations from these pages.

Monitoring Usage
Page views, bandwidth, and time consumption are tracked and made available in your org. You can view this information for a site under
Setup > Build > Develop > Sites. Select a site, and you see related lists for page views for the current month’s billing cycle, and the
24-hour bandwidth and service request time usage history.
Also, you can install the Salesforce Sites Usage Reporting app from AppExchange to monitor usage. Keep in mind that the information
available in the app might not be as current as the information you find directly in your org.

1265
Extend Salesforce with Clicks, Not Code Resources for the Point & Click Administrator

For more information about bandwidth and service request time, see Viewing 24-Hour Salesforce Sites Usage History.

SEE ALSO:
Viewing 24-Hour Salesforce Sites Usage History
Track Your Salesforce Sites with Google Analytics
My Domain URL Formats

Can I use the same domain name for my Salesforce Sites and my Experience Cloud
Sites?
With enhanced domains, your Salesforce org’s My Domain name is the subdomain for Salesforce Sites and Experience Cloud sites. If
enhanced domains aren’t enabled in your org, you can’t use the same domain name for Salesforce Sites and Experience Cloud sites.
Here are the URL formats for Experience Cloud sites and Salesforce Sites in orgs with and without enhanced domains.

URL Type Format with Enhanced Domains Format Without Enhanced Domains
Experience Cloud MyDomainName.my.site.com ExperienceCloudSitesSubdomainName.force.com
sites

Salesforce Sites MyDomainName.my.salesforce-sites.com SitesSubdomainName.secure.force.com

or
SitesSubdomainName.force.com

In orgs without enhanced domains, Salesforce Sites and Experience Cloud sites must each use a unique domain name. If you’re using a
subdomain name for your Salesforce Sites and you want to use it for your Experience Cloud sites instead, contact Salesforce Support for
assistance with renaming the subdomain.

SEE ALSO:
Enhanced Domains

Resources for the Point & Click Administrator

In addition to online help, Salesforce creates guides and tip sheets to help you learn about our features and successfully administer
Salesforce.

Platform and Apps

Guides and Tip Sheets For End Users For Admins
Implementing State and Country/Territory Picklists

Useful Workflow Rules

Useful Approval Processes

1266
Extend Salesforce with Clicks, Not Code Resources for the Point & Click Administrator

Formulas
Guides and Tip Sheets For End Users For Admins
Useful Formula Fields

Tips for Reducing Formula Size

Using Date and Date/Time in Formulas

Useful Validation Rules

1267
INDEX

C N
clickjack protection Notification Builder 582
Site.com 1084
Custom fields P
references 272 Prompts 65, 76, 78, 80–81, 84, 86–87
Custom Help 106
S
I Site.com
In-App Guidance 65 clickjacking 1084

1268