Allow Customers to Opt Out of Emails: Give customers the choice to opt out of marketing emails. Flow builder logs a lead or customer's unsubscribe request in Salesforce. Process Builder launches the Flow when there’s a new unsubscribe request.
Delete Email and Events Captured by Einstein Activity Capture and Salesforce Inbox: You can delete customers’ personal email and event data from the Activity Platform Hyperforce infrastructure, not from the Salesforce platform. Engagement data is deleted when the associated email is deleted. If Sync Email as Salesforce Activity is enabled, emails and events are stored directly in Salesforce. This deletion policy doesn't apply to those activities.
Exclude People’s Personal Data from Modeling and Data Enrichment: If you use Einstein Activity Capture, Salesforce Inbox, or Einstein Automated Contacts, it’s easy to honor your customers’ requests to exclude their personal data from factoring into machine learning models. You also exclude personal data from being used by Salesforce features, such as Einstein Automated Contacts and Recommended Connections.
Manage Data Policies for Einstein Features: We provide tools to help you honor customers’ requests for how to handle their data. If you use Einstein Activity Capture, Inbox, Sales Cloud Einstein, or Service Cloud Einstein, you can control some aspects of how data is used. You can also delete email and event data.
Preference Form Access Tokens: Create preference form access tokens so that users can view and edit your preference forms from an external site, static web page, or Experience Cloud site without logging in. You can create access tokens in Preference Manager or with REST API or Apex.
Privacy Center: Satisfy Customer Requests and Data Privacy Laws: Honor customer requests on how their sensitive data is handled, and manage components of data privacy laws like the General Data Protection Regulation (GDPR). Use the Privacy Center app to create unique policies, manage requests, and monitor the status and results of scheduled jobs.
Delete Data with Right to Be Forgotten Policies: For data subjects who want their data to be erased or masked, create Right to Be Forgotten (RTBF) policies to run on individual customer records. Create policies that capture the objects you want to delete or make anonymous, then manually run the policy on a specific record at any time.
Contact Salesforce About Accessibility: Have a question, need guidance, or want to report an issue regarding Salesforce accessibility? Here are some resources and links to help you navigate.
Keyboard Shortcuts: Use keyboard shortcuts to work efficiently in Salesforce. Shortcuts help you navigate and work with records faster and without using your mouse. You can use these shortcuts with your web browser shortcuts.
Use Lightning Experience with a Screen Reader: Learn how to get the most out of a screen reader and other assistive technologies when you use Lightning Experience, where accessibility features are built in.
Accessibility Standards: Learn about the standards for low-vision users and deaf or hearing impaired users that Salesforce follows to design applications with accessibility in mind.
Record Translated Names: Use local name fields to store translated names for accounts, contacts, or leads.
Change a Record’s Owner: You can give ownership of a record to another user as long as that user has at least Read permission for the type of record being transferred.
Accrual Process: Accrual transactions occur when a member performs an activity that earns them points. For example, an activity can be a product purchase from a host business or partner, a bonus, or any other business interaction. The business is responsible for payment when the member redeems or makes a claim for rewards.
Methods for Verifying Your Identity: To protect your user account and business data from unauthorized access, Salesforce requires multi-factor authentication (MFA) for an extra layer of security when you log in. In addition to entering your username and password, you’re also prompted to provide a verification method that helps prove your identity. You can register several types of verification methods for your account, including authenticator apps, built-in authenticators, and physical security keys. You can also use a registered verification method if you receive a device activation challenge because you’re logging in from a browser or IP address that Salesforce doesn’t recognize.
Activate the Flow in Flow Builder: Before you can sync your data between Salesforce Suites and your external apps, activate your flow in Flow Builder.
Add Custom Fields to Your Page Layout: If your flow uses custom fields, add them to your record page layout so that your users can see them. For example, if you created a custom Jira Status field that belongs on the Case page, use Lightning App Builder to add it to that page layout.
Grant Profile Access to Custom Fields: If your flow uses custom fields, grant field-level access so that users assigned to a profile can see the fields on their record pages.
Add an Email Address: When you log in with your email address again, the page lists previous email addresses that you signed in with. You can choose an email address from the list or log in with a different email address.
Add Members to a Group: After you create a group, you can add Individual or Corporate type loyalty program members to the group. Members of a group can contribute nonqualifying points to the group's point balances.
Add Partner Products: You can associate products or product categories that are applied to a particular promotion.
Add Products or Product Categories: Before you add products or product categories for your program partner, create products in the Product object and categories in the Categories object.
Add a Program Partner: You can add program partners to the loyalty programs. The program partners can only be an account in the organization.
Add Segments: You can add the segments targeted for a particular promotion.
Register a Third-Party Authenticator App as an Identity Verification Method for Salesforce Orgs: Register a third-party authenticator app so you can use it to verify your identity when logging in with multi-factor authentication (MFA) or if you receive a device activation challenge. Authenticator apps, such as Google Authenticator, Microsoft Authenticator, or Authy, generate verification codes that you enter in Salesforce to verify your identity. There are mobile apps, browser extensions, and desktop options such as most password managers. You can use any third-party product that generates time-based one-time password (TOTP) codes. The registration process sets up your authenticator app as a personal verification method by creating a connection between your Salesforce account and the app.
Adjust Points: Use Adjust Points to manually adjust member’s credited or debited points. The adjustments happen in real time.
Adjust Points for a Transaction Journal: Use Adjust Points to manually adjust a member's credited or debited points. The system makes these adjustments in real time.
Customize the Fiscal Year Structure: If your custom fiscal year needs a different structure than one available from the templates, modify the details of your custom fiscal year definition.
Customize the Fiscal Year Labels: Customize the labels of your fiscal years in two ways: Naming schemes and prefix choices or fiscal year picklist customization.
Set Your Personal or Organization-Wide Currency: If you have a single-currency organization, you can set the default currency for your organization. Multi-currency organizations don’t have a default currency. Instead, change your corporate currency or your personal currency.
Set Your Corporate Currency: In multi-currency organizations, set or change your corporate currency to the currency in which your corporate headquarters reports revenue. All conversion rates are based on the corporate currency.
Set Your Currency Locale: If you have a single-currency organization, you can set your default currency.
Set Your Personal Currency: In multi-currency organizations, you can set a personal currency that’s different from the organization’s corporate currency.
Developer Org Expiration: Developer Edition (DE) orgs that haven’t been logged into for 45 days are deleted immediately. Developer Edition (Legacy) orgs that haven’t been logged into for 180 days are queued for deletion. When a Developer Edition org is flagged as inactive, Salesforce sends an email to warn you that the DE org is about to expire. You have a window of time to log in before the org is deleted.
Deactivate a Developer Edition Org: When a Developer Edition org has outlived its usefulness and it’s time to move on, you can deactivate it or allow it to expire.
Define or Modify a Custom Fiscal Year: Set up your company’s custom fiscal years to fit your company’s calendar. If you define a custom fiscal year and want to change it, edit the existing fiscal year definition.
Organize Data with Divisions: Divisions let you segment your organization's data into logical sections, making searches, reports, and list views more meaningful to users. Divisions are useful for organizations with extremely large amounts of data.
How Divisions Work: Divisions can be assigned to users and other kinds of records. For example, you can create a report to show the opportunities for just the North American division to get accurate sales numbers for the North American sales team.
Einstein and Data Usage: Einstein intelligence is built on data. As an Einstein customer, it’s important for you to know what data is being used in your Einstein products. Click on each product to see the data usage for all features in Commerce Cloud, Lightning Platform, Marketing Cloud Account Engagement, Marketing Cloud Growth, Salesforce Personalization, Sales Cloud, Service Cloud, Tableau Generative AI, and Slack AI.
Add AI Solutions to Your Setup: Some Einstein features require you to accept terms and review usage limitations before turning them on. Also, review which data is used for global models.
Turn Einstein Features On or Off: See if your Sales Cloud, Service Cloud, or Lightning Platform license comes with included Einstein features. Access to included Einstein features may be subject to usage limitations and your acceptance of additional terms.
Export Backup Data from Salesforce: Your Salesforce org can generate backup files of your data on a weekly or monthly basis depending on your edition. You can export all your org’s data into a set of comma-separated values (CSV) files.
Add the Quip Associated Documents Component: Add the Quip Associated Documents component to your page layouts so that documents are easy to access. You can add the component to accounts, opportunities, leads, most other standard objects, and your custom objects.
Sample Apex Trigger to Specify Documents or Templates: Use an Apex trigger to programmatically specify a document or template in a custom URL field. You must add a field if you selected the Different templates for different records option when you added the Quip Document component to a Lightning page.
Create Custom Fields for the Document and Template URL: If you want to use different documents or templates for your Salesforce records, create a custom field. Quip stores the URL of the embedded document or template in the custom field of the Salesforce object. If each record uses the same document, you don’t need to create the fields.
Quip Document Component: With the Quip Document Lightning component you can work with fully functional documents and spreadsheets directly within Salesforce records. All of your favorite features are there—comments, @mentions, live apps, and more. It's all the collaboration that you need, right where you need it.
Set Up Synced Sharing: Manage user access at the org level via Synced Sharing for your documents associated with Salesforce records. Grant users with access to a record view, comment, or edit access to its linked documents, or align document access with Salesforce record permissions.
Mail Merge Examples: Use templates to prepopulate documents with content that’s specific to the Salesforce record they’re embedded in. For example, you want to use a document to store an Account Plan for each account. When a user creates an Account Plan, you want it to include the same boilerplate content for every account. But you also want to include specific field values from the account, such as the account name and description.
Use the Quip Document Component: After you add the Quip Document component to a Lightning page, your users can create and edit documents directly in Salesforce. If they prefer, users can also edit the document on your Quip site. Both options provide the same rich collaborative environment.
Set Up the Lightning Experience Home Page: Give your users everything they need to manage their day from the Home page in Lightning Experience. Your sales reps can see their quarterly performance summary and get important updates on critical tasks and opportunities. You can also customize the page for different types of users and assign custom pages to different apps and app-and-profile combinations.
Set a New Default Home Page: Set a new default Home page to surface the information that’s most relevant for your users. All users see the default Home page unless they have profiles that are assigned to another Home page.
Language, Locale, and Currency Settings: The Salesforce settings for language, locale, time zone, and currency can affect how objects, such as Accounts, Leads, or Opportunities, are displayed.
Local Name Fields: Local name fields are additional standard text fields that allow you to define original or translated text for certain fields on Account, Contact, and Lead objects. For example, you can define local name fields for a contact so that their name appears in a language appropriate for their locale.
Add Local Name Fields to a Page Layout in Salesforce Classic: By default, local name fields don’t appear in page layouts for accounts, contacts, or leads. To see a local name field on one of these pages, add it to the page layout and then make it visible using Field-Level Security settings.
Add Local Name Fields to a Page Layout in Lightning Experience: By default, local name fields don’t appear in page layouts for accounts, contacts, or leads. To see a local name field on one of these pages, add it to the page layout and then make it visible using Field-Level Security settings.
Considerations for Adopting the ICU Locale Formats: Learn why Salesforce chose to adopt the International Components for Unicode (ICU) locale formats. Understand why we recommend testing the new formats in a sandbox and enabling them in production before they’re enforced. Then review recommendations on handling installed packages, custom code, and notifying your users.
Check for API Versions: Not sure whether your org has Apex classes, Apex triggers, and Visualforce pages? Each has a list in Setup that includes the version number.
Custom Code and Locale Format Changes: Address, currency, date, datetime, integer, name, and time formats can change when a user changes locales. These formats can also change when the locale format standard changes or formats are updated. Learn how to avoid errors by using locale-neutral methods in your code and review examples. Then understand how to verify that your integrations work with new or changed formats.
Example Code with Locale-Formatted Data: Review examples of code that handles data that can be formatted based on the user’s locale. See how code can break when it relies on a specific format for dates, times, and currencies. And review examples of how to fix these issues by using standard methods for handling these types of data.
Update Your Integrations for New Locale Formats: If you integrate data from external systems into Salesforce or if you send Salesforce data to external third parties, use locale-neutral formats whenever possible in the related code. When locale formats change, review the code that handles the affected formats.
Use Locale-Neutral Methods in Code: Data formats can change based on the user’s locale, adoption of new standards, or updates to the standard locale formats. To avoid errors when a locale format changes, use standard methods to handle this data in your code. If your code formats the data using the user’s locale, apply the format after all other processing is complete.
Create a Custom Object for a Report: To identify which users chose to use each locale, create a custom field on the User object. Then use that custom field to create a report that lists users by locale code.
Determine the Locales in Use: To identify the locales used in your org, you can use an SQQL query, a report, or both. When locale formats change, your adoption effort depends on the locales used in your org. For example, when you migrate from Oracle’s Java Development Kit (JDK) locale formats to International Components for Unicode (ICU) locale formats, or when existing locale formats change.
Salesforce Supported Locales and ICU Formats: Salesforce supported locales and their corresponding International Components for Unicode (ICU) formats for name, address, numbers, currencies, dates, and times. We use ICU version 71.1, which uses the Unicode Common Locale Data Repository (CLDR) version 41. These formats are available upon activation of the Enable ICU Formats critical update and require version 45.0 or later of the Salesforce platform API.
Identify Changes to Your Locales with ICU: To ensure that you understand the impact of migrating from Oracle’s Java Development Kit (JDK) locale formats to International Components for Unicode (ICU) locale formats, determine the specific locale format changes.
Salesforce Supported Locales and JDK Formats: Salesforce supported locales and their corresponding Oracle’s Java Development Kit (JDK) formats for name, address, numbers, currencies, dates, and times. We use JDK version 11, which uses Common Locale Data Repository (CLDR) version 33. We replace these formats with the International Components for Unicode (ICU) formats in Spring ’24. Or, now you can adopt the new formats through the Enable ICU Formats release update.
Locales Overview: Locales determine the display formats for date and time, users’ names, addresses, and commas and periods in numbers. The start day of the week for calendars varies per locale. For single-currency organizations, locales also set the default currency for the organization when you select them in the Currency Locale picklist on the Company Information page.
Identify Locales in Use by User: To gather information about the users for each locale, use a custom field to create a report that lists users by locale code.
Create a SOQL Query: To gather details about locale use, like user count by locale, create a SOQL query
ICU Locale Format Migration Tests: To avoid unexpected behavior after you migrate from Oracle’s Java Development Kit (JDK) locale formats to International Components for Unicode (ICU) locale formats, test the ICU locales. When you migrate from JDK to ICU, the formats for some locales change. Use functional tests to verify existing functionality, and confirm that these formats appear correctly for each affected locale used in your org. Also, verify that integration with third parties works as expected, and test your installed packages with the new formats.
API Versions for Apex Classes, Apex Triggers, and Visualforce Pages: The International Components for Unicode (ICU) locale formats are available with API version 45.0 and later. To use the ICU locale formats in your customizations, all Apex classes, Apex triggers, and Visualforce pages must use API version 45.0 or higher..
Data and Storage Resources: View your Salesforce org’s storage limits and usage from the Storage Usage page in Setup.
Monitor Setup Changes with Setup Audit Trail: Setup Audit Trail tracks the recent setup changes that you and other admins make. Audit history is especially useful when there are multiple admins.
Set Password Policies: Improve your Salesforce org’s security with password protection. You can set password history, length, and complexity requirements. You can also specify what to do when a user forgets the password.
Set Up Your Company in Salesforce: Use the Company Information page in Setup to track what’s important about your company’s organization in Salesforce. You can also manage your licenses and entitlements. This page contains the information that was provided when your company signed up with Salesforce.
Accruals and Payouts: Accrual is the potential financial commitment based on data projections, whereas payout is the amount that you actually pay based on the recorded transaction.
Add the Program Rebate Types Panel to Accounts: Add the Program Rebate Types Panel Lightning component to an account record page so that your account managers can view the applicable rebate types for an account. They can also view the rebates and incentives attainment for an account.
Configure the Output Parameter for the Get Eligible Program Rebate Types Flow Action in Flow Builder: The Get Eligible Rebate Types flow action has two output parameters, Resultant Rebate Types for API and Resultant Rebate Types for Flow. Use the Resultant Rebate Types for API parameter for API calls and the Resultant Rebate Types for Flow parameter when creating a flow with the GetEligibleRebateTypes invocable action.
Accruals and Payouts Calculation in Rebate and Accrual Management Advanced: Learn how the Advanced Rebate Engine uses Program Rebate Type configurations to process high-volume transaction data in Data Cloud. By setting independent accrual and payout bases, you can track estimated financial liabilities on a different cadence than finalized cash disbursements.
Assign Permission Sets for Rebate and Accrual Management Advanced: Assign permission sets to users to give them access to objects, fields, and features for Advanced Rebate and Accrual Management and related features. Permission sets extend users' functional access beyond their user profiles but can't take access away. You can assign multiple permission sets to a user.
Automate Rebate Payout Calculation Processes with Flows: Automate the end-to-end rebate calculation lifecycle on Data Cloud using the configurable, predefined orchestration flow, Manage Rebate Payout and Accrual Calculations. You can clone this flow, customize it to meet your business needs, and schedule it to run at regular intervals. Each run handles continuous data aggregation and incremental payout updates as new transactions are ingested. When a period's Payout Calculation Date is reached, post-calculation actions finalize values, update records across Program Rebate Type Payout Source, Program Rebate Type Payout, and Rebate Program Member Payout, and set the payout and period statuses to Calculated and Closed.
Calculate Flat Rebates Per Transaction (Example): This example shows how flat, per-transaction rebates are calculated independently for each transaction record as it is ingested into Data Cloud without period volume aggregation.
Calculate Payouts for Year-Over-Year Growth (Example): This example shows how payouts are calculated for a growth-based rebate type by comparing a member's current period revenue against baseline revenue from the same period in the prior year.
Capabilities of Rebate and Accrual Management Advanced: Use Rebate and Accrual Management Advanced to automate the tracking of financial liabilities and the calculation of rebate payouts with a scalable and transparent accounting process. By processing high-volume transaction data and sales-related data leveraging DPE with Data 360, you can maintain an accurate view of your financial commitments. Set up and configure data processing engines to maintain an accurate, up-to-date view of your current rebate obligations.
Checklist to Run an Advanced Rebate Program: Review the high-level procedure to configure and manage financial liabilities and payouts for an advanced rebate program. Use the data processing engine to run an end-to-end accrual and payout calculation process.
Clone and Activate Data Processing Engine Definitions: Advanced Rebate and Accrual Management uses a coordinated sequence of six Data Processing Engine definitions to move, transform, and aggregate high-volume data between Salesforce Core and Data Cloud. Administrators must manually clone and activate these templates before running advanced accrual processing. Once cloned, you can customize the definition's nodes, variables, and aggregation logic to meet your business requirements.
Compare Classic Rebate Management and Rebate and Accrual Management Advanced: Rebate and Accrual Management Advanced builds on Classic Rebate Management. It adds accrual-based liability tracking and runs calculations on Data 360 with the Accrual and Payout Engine, so you can process high transaction volumes and recognize financial liabilities independently of payouts.
Compare Stepped and Retrospective Calculation Methods (Example): This example contrasts how the same transaction volume produces different financial output and source records depending on whether the rebate type uses the Stepped or Retrospective calculation method.
Rebate Configuration Checks: A configuration check reviews whether a rebate program is set up correctly. The check runs before program execution to catch setup errors early and ensure accurate calculations.
Configure Program Rebate Types Panel on Record Pages: Add the Program Rebate Types Panel to a record page so that sales reps and account managers can view the rebate types, benefit tiers, and attainment that apply to a record, such as an order, opportunity, or account, directly in context.
Configure Data Cloud Connector: To ingest rebate objects and fields into Data Cloud, update the system permissions for the Data Cloud Salesforce Connector in your Salesforce org.
Extend Accrual Aggregation with Custom Anchors: By default, the Advanced engine aggregates accruals by Member only. The engine supports up to five aggregation anchors in total — Account, Product, and three custom anchors (Anchor1, Anchor2, Anchor3). To track liabilities by dimensions such as Region, Territory, or Channel, you must configure custom anchors. This ensures the Data Cloud engine knows how to group your transaction data for financial forecasting. This requires configuring three DPEs in your accrual calculation workflow.
Configure Advanced Rebate and Accrual Pre-Processing - Data Preparation DPE: Map your custom dimension values through the pre-processing workflow so Data Cloud can use them during calculation. Activating an anchor in the Rule Configuration DPE tells the engine a custom dimension exists. This DPE populates that anchor with actual field values from your Transaction Journal so the engine has data to process.
Deploy the Accrual and Payout Engine Data Kit: Streamline your Data Cloud configuration by deploying the predefined Data Kit, which creates the required DLOs and DMOs for advanced calculations.
Data Lake Objects (DLOs) in Rebate and Accrual Management Advanced: The Accrual and Payout Engine uses 15 Data Lake Objects (DLOs) across four layers to move data from Salesforce Core through calculation and back. The same DLOs are used for both accrual and payout calculations; the Reason and Code fields on the output records distinguish accrual results from payout results. Understanding which layer a DLO belongs to helps you configure inputs correctly and troubleshoot calculation issues.
Input Layer: Admins configure the Data Preparation DPE to populate these DLOs. Ensure the fields listed here are mapped correctly in the Transaction Journal datasource node and flow through all join nodes.
Output Layer: The Source Generation DPE writes final calculated results to this DLO and syncs them back to Salesforce Core as Program Rebate Type Accrual Source records.
Advanced Rebate and Accrual Pre-Processing - Data Preparation: The Data Preparation DPE combines the Rule Meta records from Rule Configuration DPE with the active member list and the April 2026 accrual period. For each member–rebate type–period combination, it creates a Rule Ingest record that defines the applicable date range and a Tier Ingest record for each benefit tier within that range.
Accrual and Payout Engine - Delta Calculation: The Delta Calculation DPE compares the current run's Rule Ingest and Tier Ingest records against records stored from the previous run. Records unchanged since the last run are marked Unmodified and not reprocessed. This prevents double-counting when the engine runs multiple times in the same period.
Calculate Accruals and Payouts with Data Processing Engine (DPE) Definitions (Example): This example shows how the six DPE definitions on Data Cloud process transaction data to generate calculation outputs. While this example illustrates accrual calculations for members enrolled in two rebate programs with different aggregation criteria, payouts follow the exact same processing sequence and rules.
Advanced Rebate and Accrual Pre-Processing - Rule Configuration: The Rule Configuration DPE reads the rebate type and benefit configuration and creates the reference records that the subsequent DPEs use. No accrual amounts are calculated at this stage.
Accrual and Payout Engine - Rule Processing: The Rule Processing DPE reads the Tier Stage records from Delta Calculation DPE and calculates the accrual value for each transaction against each applicable tier.
Advanced Rebate and Accrual Post-Processing - Source Generation: The Source Generation DPE reads the calculated amounts from Rule Processing DPE and writes them into three Salesforce objects. Program Rebate Type Accrual Sources provide the most granular view — the accrued amount per benefit tier per member per period. For stepped rebate types, a separate record is created for each tier the member crossed.
Advanced Rebate and Accrual Post-Processing - Status Update: The Status Update DPE sets the Status field on each Rebate Program Member Accrual from Calculation In Progress to Calculated after all amounts are confirmed. The records are now available for review and approval in the Rebate Program Member Accruals list view.
Enable Traceability with Data Cloud Related Lists: To view which specific output records contributed to generated Accrual Source or Payout Source records, configure Data Cloud Related List enrichments on their respective record pages.
Key Roles in Rebate and Accrual Management Advanced: Rebate and Accrual Management Advanced users include admins, rebate program managers, partner users, key account managers, and the finance team. Admins set up and configure features. Rebate program managers design the rebate programs and their incentives based on requirements provided by sales and finance. Partner users are beneficiaries of rebate programs and enroll in programs to maximize their profits by gaining the best incentives. Key account managers craft incentives for their accounts within the sales process to increase revenue. The finance team tracks payments and approvals of payments and incentives, helps with audits, and maintains the book of business.
Learn About Rebate and Accrual Management Advanced: Understand the features of Rebate and Accrual Management Advanced. See the overall workflow for program management including the benefits of Data 360 integration and the data model for Rebate and Accrual Management Advanced.
Use Data Processing Engine (DPE) for Accrual and Payout Calculations: Clone and activate Data Processing Engine definitions to calculate accruals. Rebate and Accrual Management Advanced uses a coordinated sequence of six Data Processing Engine (DPE) definitions to move and calculate data between Salesforce Core and Data Cloud.
Manage Advanced Rebate Payout Calculations: Payouts are the actual amounts paid to members based on finalized transactions and tier attainment for a payout period. To compute payouts, run a sequence of six Data Processing Engine (DPE) definitions on Data Cloud using a payout calculation basis. The engine aggregates finalized transactions, determines each member's tier attainment, and syncs output back to Salesforce Core across three payout objects.
Rebate and Accrual Management Advanced: Automate financial liability tracking and rebate payout processing and improve profit and loss accuracy by managing high-volume rebate accruals and payouts through DPE on Data 360. Companies that sell through indirect channels such as manufacturing, automotive, and consumer goods can use Rebate and Accrual Management Advanced to ensure that funds are reserved and forecasted correctly, and that final payouts are calculated and settled accurately.
Populate Transaction Data in Transaction Journals: Use Transaction Journal to store transaction records for member accounts as inputs for accrual calculations. Retrieve transaction data from Salesforce objects such as Orders and from external systems.
Refine Accruals with Benefit Mappings: Use benefit mappings to create benefits for a rebate program that vary by additional criteria such as product category, partner territory, member enrollment status, and industry segment. For example, a volume-based rebate type can have benefits in which the accrual amount varies by product category for the same benefit tier.
Set Up Rebate and Accrual Management Advanced: Set up features for Rebate and Accrual Management Advanced. Enable the required features in Setup. Assign users the necessary permission sets. Set up object access, deploying required data packages, and configure the required settings for Experience Cloud site.
Set Up an Approval Process: Use Approval Process to automate the process of approving accrual-related records for program members. An approval process automates how records are approved in Salesforce.
Set Up Data Processing Engine (DPE) for Rebate and Accrual Management Advanced: Learn how a coordinated sequence of Data Processing Engine (DPE) definitions on Data Cloud calculates accruals and payouts. Clone and activate the standard definitions, execute them in exact sequential order, extend your aggregation model using custom anchors, and build automated flows to run the entire pipeline seamlessly.
Set Up an Experience Cloud Site: Set up Experience Cloud to give your partners access to view rebate programs and accrual information.
Set Up Program and Data Ingestion: Before running payout calculations, ensure your program rules, eligibility criteria, and transaction sources are properly configured.
Who Can Use Rebate and Accrual Management Advanced: Companies requiring end-to-end incentive management solutions for their partners, dealers, or distributors and those selling through indirect channels can use Rebate and Accrual Management Advanced to automate financial liability and rebate payout tracking. You can implement these capabilities across manufacturing, automotive, consumer goods, retail, hi-tech, and med-device industries.
Aggregate Payouts by Account (Example): This example shows how you can use the Aggregate by Account template to aggregate transaction records for an account that’s added as a member in two rebate programs.
Aggregate Payouts by Member (Example): This example shows how you can use the Aggregate by Member template to aggregate transaction records for a program member for two rebate types.
Aggregate Payouts by Member with Aggregate Item Details (Example): This example shows how you can use the Aggregate by Member with Aggregate Item Details data processing engine (DPE) template to aggregate transaction records for a program member for a rebate type along with the transaction details of each aggregate record.
Aggregate Payouts by Product and Member (Example): This example shows how you can use the Aggregate by Product and Member template to aggregate transaction records for a program member for two products.
View the Rebates and Incentives Attainment Snapshot on Accounts: Equip account managers and channel partners with rebate insights to maximize earnings and create mutually beneficial deals. The Program Rebate Types panel on an account displays progress against enrolled programs based on the current date.
Approvals for Rebate Management: Use Approval Process to automate the process of approving rebate payout amounts for program members. An approval process automates how records are approved in Salesforce.
Permission Sets for Rebate Management: Assign permission sets to users to give them access to objects, fields, and features for Rebate Management and related features. Permission sets extend users’ functional access beyond their user profiles but can’t take access away. You can assign multiple permission sets to a user.
Calculate Payouts for the Parent Account (Example): This example shows how you can use the Account Hierarchy Member Aggregate using Member template to aggregate values for all accounts within a hierarchy. If you have multiple accounts within a hierarchy added as members to a single rebate program, you can offer payouts only to the parent account.
Calculate Payouts for Ship and Debit Programs (Example): This example shows how you can use the Ship & Debit Program Aggregate using Member template to calculate, process, and validate payouts for ship and debit programs.
Calculate Year Over Year Growth Aggregates by Member (Example): This example shows how you can use the Year over Year Growth Aggregate using Member template to compare aggregate values for the same payout periods for the current and previous years.
Capabilities of Rebate Management: Use Rebate Management to manage incentives for your partners and distributors. Create rebate programs and specify the type of rebate, eligibility rules, and benefit structure. Set up and configure flow actions, batch jobs, and data processing engines. Engage with your partners by using Experience Cloud.
Checklist to Run a Rebate Program: Review the high-level procedure to configure, create, and manage a standard rebate program. Use the predefined Rebate Orchestration flow to run an end-to-end rebate calculation process.
Store Aggregated Transactions in an Object: Track payouts effectively by aggregating members’ transaction records for a specific payout period in a single cumulative record. Store this aggregated data either in the default aggregate object, Rebate Member Product Aggregate, or in a custom object. You can aggregate transactions by using an appropriate data processing engine definition.
Manage Data Processing Engine Definitions for Rebate Management: Clone and use the data processing engine definitions for Rebate Management as-is, extend them to meet your business needs, or create definitions from scratch. To use a definition for a rebate type, activate the definition.
Manage Rebates and Incentives Within Sales Processes: Craft better deals and make the right incentive decisions within your existing sales and Configure, Price, Quote (CPQ) processes. Account managers, sales teams, dealers, distributors, and rebate managers can better visualize an account’s rebate attainment, view projected rebate amounts on transactions, make informed decisions, and better negotiate deals. They can view rebates an account is earning from in the context of a sales transaction, or select eligible rebate types and add them to the transaction. All applicable incentives are visible in the context of the transaction be it a Quote, Opportunity, Order, Sales Agreement, Contract, or any other transaction.
Create Field Mappings: Admins define mappings by retrieving, editing, and deploying XML component files through the metadata API.
Create Program Rebate Types Using APIs: You can create program rebate types for migration and integration purposes by using APIs that are available with Rebate Management. However, to define the eligibility criteria for rebate types that are created by using APIs, ensure that you complete these additional steps.
Batch Management with Rebate Management: Rebate Management flows use Batch Management capabilities to process a large number of filtered and aggregated transactions in manageable batches, and calculate rebate amounts. Two predefined batch jobs, Calculate Rebate Payout and Calculate Rebate Payout for All Periods, that are available with Rebate Management and can be used in any scheduled flow. Modify the predefined batch jobs, or create your own.
Deploy and Use Rebate Analytics: Rebate Analytics dashboards give you actionable insights that help you improve your programs and increase product sales. The embedded dashboards give you immediate insights into incentives for your orders, sales agreement products, and rebate programs from Salesforce pages you use everyday. The Einstein Discovery for Rebate Management app lets you predict rebate-driven sales, identify high-potential accounts to add to rebate programs, and recommend top rebate programs to your customers.
Create a Screen Flow to Add Rebate Types to a Sales Agreement: Design a screen flow to automate the business process of adding eligible rebate types to a target record, such as a Sales Agreement. Account managers can select multiple rebate types from the Eligible tab of the Program Rebate Types panel and confirm the selections by adding the associated account to a rebate program. Using a flow ensures that reference records are created systematically, linking the transaction to the correct incentives.
Customize Data Processing Engine Definitions to Support a Large Number of Rebate Eligibility Conditions: Data Processing Engine (DPE) definition runs can fail if there are multiple eligibility criteria conditions to filter transactions that qualify for member payouts. Having a large number of filter conditions in a DPE definition increases the recipe size that’s not supported by the calculation engine framework. To reduce the chances of DPE failure, use the Compute Valid Transaction Journals Per Rebate Type custom node.
Data Processing Engine Templates with Rebate Management: Rebate Management has Data Processing Engine (DPE) templates to help you aggregate transactions by different criteria and manage other rebate processes. Examples of processes are: converting order records into transaction journal records, validating ship-and-debit transactions, and calculating payouts at the parent-account level.
Simple Scenario-Based Data Processing Engine Edits for Rebates: Use the Data Processing Engine Edits for Rebates prebuilt app to easily group and aggregate Rebate Member Product Aggregate records. You don’t need to edit a Data Processing Engine (DPE) definition and modify multiple nodes to add custom grouping and aggregation logic.
Install the Data Processing Engine Edits Prebuilt App: Get easy access to the Data Processing Engine Edits for Rebates prebuilt app by directly installing a package in your org. You can also manually create a package in the learning org, add the app to the package, and then deploy the package in the target org. Unless you customize the prebuilt app in the learning org and want to deploy the customized version in your org, we recommend that you directly deploy the package in your org.
Simplify Data Processing Engine Edits to Group and Aggregate Data: The Data Processing Engine Edits for Rebates prebuilt app helps you quickly map fields between Transaction Journal and Rebate Member Product Aggregate. Typically, you manually edit multiple nodes in a Data Processing Engine (DPE) definition to map similar fields on both objects. With this prebuilt app, you can use a point-and-click solution to map the group and aggregate fields for the Aggregate Payouts by Member with Aggregate Item Details definition. The app also helps you download the modified Data Processing Engine definition file. You can simply upload the modified file in the DPE builder to update the definition.
Work with the Data Processing Engine Edits Prebuilt App: Use the Data Processing Engine Edits for Rebates prebuilt app to easily edit Data Processing Engine (DPE) definitions. Map custom fields between Transaction Journal and Rebate Member Product Aggregate, and download the modified DPE JSON file for the Aggregate Payouts by Member with Aggregate Item Details definition. The grouping and aggregation logic is automatically updated in the DPE definition based on the field mappings. You can upload the JSON file in the DPE builder to view the changes to an existing DPE definition in your org.
Eligible and Applied Rebate Types on a Transactional Object: Account managers can view rebate types that are eligible for or applied to a target record, such as a Sales Agreement, Contract, or Quote, directly within the sales process. The Program Rebate Types panel provides real-time visibility into incentives, helping users drive larger deals by understanding potential and confirmed payouts.
Enable Data Pipelines: To create and run Data Processing Engine definitions, enable Data Pipelines. With Data Pipelines, you can query and compute data available in your Salesforce org.
Enable Rebate Management: To access Rebate Management objects in your org, you must enable the feature in Setup. When you enable the feature, the predefined templates for Flow builder, Data Processing Engine, and Batch Management are also available for use. Rebate program managers can create programs and calculate payouts.
Predefined Flow Actions with Rebate Management: Use flows to automate the processes of calculating rebates for members during a payout period. The members must be active and enrolled in an active rebate program. The rebate types and associated benefits must also be active. Admins can use predefined flow actions to extend the flow templates available with Rebate Management, or while creating a flow from scratch. Find the required flow actions in the Rebates category in Flow Builder.
Flow Templates with Rebate Management: Rebate Management comes with Flow templates that help orchestrate rebate calculations. You can configure and use them for your end-to-end rebate calculations and extend the templates as required. The flows trigger the data processing engine definitions to update the aggregate records, and also trigger calculation processes to update the final payout amounts. Admins can schedule the flows at regular intervals.
Group Rebate Payouts by Region and Aggregate by Member (Example): A company wants to group and aggregate transaction data of rebate program members by region of sale. Program managers and sales managers want to track and reward members based on region-specific sales. Also, the benefits rolled out to the members vary by region. Region-based numbers give insight into the regions where the company can promote their products and increase their footprint. This example shows how you can achieve the aggregation.
How Are Accruals Calculated?: Define the calculation basis of a rebate type and add an accrual rate to specify how to calculate accruals for members. Be better prepared with your finances for an ongoing period by accruing on a regular basis, even though the actual payout is settled at the end of a period. You can view the accrual and payout amounts of a member for each payout period.
How Are Rebate Payouts Calculated?: Review the necessary steps to calculate rebate payouts for the members in a rebate program. Transaction Journal records are used as the input for calculation, and the output is stored in Rebate Member Payout records.
Insert Invoice Records Into Transaction Journals (Example): This example shows how you can customize and use the Insert Orders to Journals with Member template to transfer records from a custom Invoice object to the Transaction Journal object.
Key Roles in Rebate Management: Rebate Management users include admins, rebate program managers, partner users, key account managers, and the finance team. Admins set up and configure features. Rebate program managers design the rebate programs and their incentives based on requirements provided by sales and finance. Partner users are beneficiaries of rebate programs and enroll in programs to maximize their profits by gaining the best incentives. Key account managers craft incentives for their accounts within the sales process to increase revenue. The finance team tracks payments and approvals of payments and incentives, helps with audits, and maintains the book of business.
Manage Accruals and Payouts: With Rebate Management, you can calculate accruals and payouts for rebate types. Program managers can view the accrual and payout information for each member and each payout period. Understand how accruals are calculated in Rebate Management. Analyze a use case that showcases how accrual calculations can help you manage finances in a better manner.
Capture Rebate Claims and Proof-of-Sale Documents in Experience Cloud: Partners can upload rebate claims and invoices through the Experience Cloud site. Admins convert these documents into Transaction Journal records to use for rebate payout processing and calculation. Partners can also view rebate information such as the programs they’re enrolled in.
Map Fields for Eligible and Applied Rebate Types: To view eligible and applied rebate types on a record, you must map the fields of your target object with fields in the Transaction Journal using the ObjectHierarchyRelationship metadata API. If these mappings are not defined, the Eligible tab shows all integratable rebate types regardless of criteria, and the Applied tab remains empty.
Automate Rebate Payout Calculation Processes with Flows and Batch Management: Automate the rebate calculation process with configurable predefined flows. Schedule the flows at regular intervals. Use predefined flow actions to customize the rebate process as required. Configure an end-to-end orchestration flow to manage the rebate lifecycle. Use Batch Management capabilities to process a large number of filtered and aggregated transaction records in manageable chunks.
Rebate Orchestration Flow: Run the Rebate Orchestration Flow to calculate rebate amounts and process payouts. It includes other predefined Rebate flows as subflows. The flow searches for data processing engine definitions with Process Type as Rebates and triggers the aggregation of data. Then, the flow runs the calculation process to generate member payout amounts.
Rebate Orchestration Flow 2: Rebate Management includes a simpler and more scalable orchestration flow called Rebate Orchestration Flow 2. Just like the Rebate Orchestration Flow, this flow automates rebate records aggregation, calculation of rebate amounts, and payout processing. This flow includes a Calculate Rebate Payout for All Periods batch job that calculates the rebate payouts for aggregate records of all periods. The last execution date of the batch job is used to determine which aggregate records are used to calculate the rebate amounts and generate payouts. After payouts are successfully generated, a Data Processing Engine job closes the payout periods. This flow includes the other flows as subflows.
Populate Transaction Data for Rebate Payout Calculations: When partners purchase your products, the transactions are recorded as claims and invoices. These transactions are used as inputs for rebate payout calculations. Retrieve transaction data of your org from Salesforce objects such as Orders, from partners submitting claims via the Experience Cloud site, and from external systems.
Extend Rebate Management with Prebuilt Apps: Use prebuilt apps for Rebate Management to get started with your implementation. These apps include custom metadata, permission sets, Data Processing Engine templates, flow templates, and more. While you can easily access these apps using the Manufacturing Cloud learning trial org, the apps can be extended for other industry-specific implementations using Rebate Management.
Process Per Transaction Per Member (Example): This example shows how you how you can use the Process Per Transaction using Member template to process each transaction record of a member and generate a payout amount for that transaction.
Upload Proof-of-Sale Documents and Resolve Errors: Partners can upload proof-of-sale documents such as invoices and claims in .csv files from the Experience Cloud site to claim rebate payouts. These documents are validated against standard business rules, and the partner can edit and resubmit the documents if there are errors. The admin then converts the records in the .csv file into Transaction Journal records for payout processing. Each uploaded file is stored as a Received Document record, which tracks the processing status, number of records processed, and any errors.
Recalculate Payouts for Closed Periods: Recalculate payouts for past periods or for periods when you need a recalculation due to changes in incentive structure. The rebate flows run at regular intervals to calculate payouts for all active periods. On the payout calculation date, the payout period is set to Closed and associated member payouts are set to Calculated. To reconsider such periods for payout processing, modify the payout records and run the flow again.
Recalculate Payouts with No Change in Benefits: Recalculate the payouts when a member submits the transactions after a payout period is closed, or when there’s an error in calculating payouts.
Recalculate Payouts Due to Changed Benefits: You can recalculate the payouts generated for a rebate program member when the member benefits change due to changed requirements.
Refine Rebates and Incentives with Benefit Mappings: Use benefit mappings to create benefits for a rebate program that vary by additional criteria such as product category, partner territory, member enrollment status, and industry segment. For example, a volume-based rebate type can have benefits in which the rebate amount varies by product category for the same benefit tier.
Get Started with Rebate Management: Use Rebate Management to give monetary incentives to partners who meet an agreed-upon sales target and inspire deeper loyalty and drive the desired channel purchasing behavior. Explore a trial org and then learn about what’s included, what setup we recommend, and how to get ready for your implementation.
Set Up Rebate Management: Set up features for Rebate Management. Enable the required features in Setup. Assign users the necessary permission sets. Set up object access, and configure the required settings for Experience Cloud site.
Calculate Rebate Payouts with Data Processing Engine: Use Data Processing Engine (DPE) definitions to transform data stored in various standard or custom objects in your org and to write back the results to a target object. Query, filter, and aggregate Transaction Journal records for rebate calculation. Choose the correct DPE definition for your use case. Clone and customize predefined definitions or create a definition, and then activate the definitions.
Supported Objects for the Program Rebate Types Panel: Use the Program Rebate Types panel to integrate incentive data into your standard sales and Configure, Price, and Quote (CPQ) processes. The panel provides visibility into eligible rebates, projected amounts, and benefit tier progress.
Track and Adjust Rebate Payouts: View the payout details for rebate program members in a single snapshot. Track these details at any point in time, and also when they’re finalized. Recalculate payouts if necessary. Adjust payouts as required and submit them for approval.
Get Your Own Trial Org for Rebate Management: Get hands-on experience with Rebate Management features through proof-of-concept and guided self-exploration for 30 days via a trial org.
View Aggregated Payout Information: Payouts are calculated for each record in the aggregate object. The admin can either use the default Rebate Member Product Aggregate object to store aggregate records, or create a custom object for the purpose. The aggregate values get updated each time a Data Processing Engine is run to process the transactions as defined in a rebate type. Track the aggregate records to view the total transaction quantity, total transaction amount, and other details for each rebate type for a member in a specific payout period.
Field Mappings for Eligible and Applied Rebate Types: Use the ObjectHierarchyRelationship metadata API to map fields between any standard or custom object and Transaction Journal. Rebate Management uses these field mappings to show the list of eligible and applied rebate types on the Program Rebate Types panel of a target record. The eligibility criteria of a rebate type determine whether it’s shown on a transaction record.
What Are Prebuilt Apps for Rebate Management?: Use prebuilt apps tailored for Rebate Management to implement custom business use cases. While some prebuilt apps can be deployed directly into a production or sandbox org as managed packages, for others, you can create a package in the learning trial org and install that package into your own org.
Who Can Use Rebate Management?: Companies requiring end-to-end incentive management solutions for their partners, dealers, or distributors, companies selling through indirect channels, and companies benefiting from rebate programs and incentives can use Rebate Management. You can implement Rebate Management for not just the manufacturing industry, but also the automotive, consumer goods and retail, hi-tech, med-device sales, and other industries.
Rebate Management Workflow: Before you implement or use Rebate Management, understand the end-to-end workflow and the key decisions involved in each step.
Modify Session Security Settings: Use the Session Settings screen to configure session security. You can configure settings such as the session connection type, timeout restrictions, and IP address ranges to protect against malicious attacks.
Errors in Lightning Experience: Errors, while unfortunate and hopefully uncommon, are a normal part of using Salesforce, or any software system. Here’s an explanation of the various types of errors that you can encounter, and various options for handling them.
Enable the Error Console in Setup: Enable or disable the Error Console for your users. The console collects warnings and non-fatal errors so you can see them when it’s convenient, instead of being an interruption. The Error Console setting applies to all users of your org.
View Errors in the Error Console: When enabled, the Error Console captures and shows component and page errors without interrupting your work in Salesforce. The console collects non-fatal errors so you can see them when it’s convenient for you, and they don’t require interaction. Fatal errors still show in error windows that you must dismiss before continuing. The Error Console also collects fatal errors for later inspection.
View Errors in Error Windows: Before Spring ’26, and by default, Lightning Experience shows runtime errors in an error window.
Find Items in Setup with Advanced Setup Search (Beta): With Advanced Setup Search, users can search for many types of items in Setup. These items including approval items, custom objects and fields, custom profiles, permission sets, workflow items, users, and so on.
Setup Search Results Page (Beta): The Setup Search Results page displays various types of items in Setup that match your search terms, including approval items, custom objects and fields, custom profiles, permission sets, workflow items, users, and so on.
Enable and Disable State and Country/Territory Picklists: When you enable state and country/territory picklists, the picklists are immediately available to users. However, it can take some time for Salesforce to populate the ISO code fields on existing records. If users try to edit the state or country/territory on a record before the code field is populated, they’re prompted to select a code value.
Configure State and Country/Territory Picklists: Configuring state and country/territory picklists means choosing which states and countries you want to be available in your Salesforce org. It lets you make state and country/territory picklists available for purposes like importing data, working with external systems, and accessing picklist data from the Metadata API.
Convert State and Country/Territory Data: To convert text-based state and country/territory data to picklist-compatible values, select specific text values and choose the standard values you want to map them to. For example, you can select all occurrences of “USA” and change them to “United States.”
State and Country/Territory Picklist Field-Syncing Logic: When you save records with state and country/territory picklist values, Salesforce syncs the records’ integration and code values for states and countries. You can’t directly edit state or country/territory integration values on record detail pages. You can directly edit records' state or country/territory integration values only with workflows, Apex code, API integrations, and so on.
Integration Values for State and Country/Territory Picklists: An integration value is a customizable text value that’s linked to a state or country/territory code. Integration values for states, countries, and territories default to the full ISO-standard state, country, and territory names. The way integration values function is similar to the way API names of custom fields and objects function. Configure integration values so integrations that you set up before enabling state and country/territory picklists continue to work.
Let Users Select States, Countries, and Territories from Picklists: State and country/territory picklists let users select states, countries and territories from predefined, standardized lists, instead of entering state and country/territory data into text fields. State and country/territory picklists offer faster and easier data entry. They help to ensure cleaner data that can be harnessed for other uses—in reports and dashboards, for example. They protect data integrity by preventing typos, alternate spellings, and junk data—even in records updated through the API.
Prepare to Scan State, Country, and Territory Data and Customizations: Before switching from text-based state and country/territory fields to standardized state and country/territory picklists, scan your org to see how the change affects it. This discovery process shows you where and how state, country, and territory data appears in your org. The process also shows where this data is used in customizations, such as list views and reports. After you’ve analyzed the scan results, you can plan to convert your data, update your customizations, and turn on state and country/territory picklists.
Standard Countries and Territories for Address Picklists: Salesforce provides 235 countries and territories as standard for country/territory address picklists. Additionally, some countries and territories have state codes with special considerations.
Canada State Codes: The state codes and state/province names your standard country/territory picklist uses for Canada depend on when the standard country/territory picklist was configured. Refer to this table for state/province names with special considerations.
Japan State Codes: The state codes and state/province names your standard country/territory picklist uses for Japan depend on when the standard country/territory picklist was configured. Refer to this table for state/province names with special considerations.
Supported Currencies (ICU): Salesforce supported currencies, listed by locale with International Components for Unicode (ICU) formats.
Supported Currencies (JDK): Salesforce supported currencies, listed by locale with Oracle’s Java Development Kit (JDK) formats.
Supported Date and Time Formats (ICU): The start day of the week and the International Components for Unicode (ICU) date and time formats for each Salesforce supported locale.
Supported Date and Time Formats (JDK): The start day of the week and Oracle’s Java Development Kit (JDK) date and time formats for each Salesforce supported locale.
Get Adoption and Security Insights for Your Organization: The Lightning Usage App lets you monitor adoption and usage of Lightning Experience in your org, with metrics such as daily active Lightning Experience users and the most visited pages in Lightning Experience. In addition, the app lets you monitor login metrics in your org. See how many users are logging in with your org’s various identity services, including Multi-Factor Authentication (MFA) and Single Sign-On (SSO).
Add the New Order Action to the Account Record Page: To let telesales reps start an order directly from a customer account, make sure the New Order action is available on the account record page layout in the Service Console for Telesales.
Add Products to the Assortment: Add valid products to an assortment to define the SKUs that customer accounts or warehouse locations are authorized to order.
Capture Orders Using Advanced Orders for Telesales: Advanced Orders for Telesales guides telesales reps through creating, configuring, pricing, and releasing high-volume customer orders. It bridges account-level commercial relationships with guided, compliant order execution.
Configure Account Roles for Orderer Validation: Configure account roles to set the allowed orderer type (Direct or Indirect) for customer accounts. This setup ensures that telesales reps can select only order specifications that match the customer's authorized orderer type.
Configure Product Qualification: Product Internal Organization Unit (IOU) qualification filters the products a rep can order so that they see only the products qualified for their internal org unit. Create a single product qualification procedure and add the qualification steps your business needs.
Configure Search Indexing and Product Discovery: Configure Product Discovery search index settings in Product Catalog Management (PCM) so that reps can search across authorized catalog and assortment products at order capture, and so that the search index stays current automatically.
Create a Product Catalog: Create a product catalog to organize the products that telesales reps can order.
Create Account Account Relations: Create Account Account Relation (AccountAccountRelation) records to link a customer account to its specific partner accounts, such as Bill To, Ship To, Payer, or Wholesaler or Broker fulfillment accounts.
Create an Assortment Specification: An assortment specification (AssortmentSpec) acts as a reusable template that defines rules and properties across multiple assortments. This template is optional.
Create Assortments: Create an assortment to define a list of authorized products for a business unit or market.
Create Assortments and Assortment Products: Define product assortments (Assortment) and add valid products (AssortmentProduct) to establish standardized lists of orderable SKUs for your customer accounts and warehouse locations.
Create Internal Organization Units (IOU) and Relationships: Internal Organization Units (IOUs) control data visibility by grouping orders, products, accounts, and users by business unit. Create an IOU for each unit that processes orders, and then link your records so that users see only relevant data.
Create Location Assortments for Direct Store Delivery: Link product assortments to physical warehouse locations using Location Assortments (LocationAssortment) and Associated Locations (AssociatedLocation) to support Direct Store Delivery (DSD) order workflows.
Create Party Role Relationships: Set up party role relationships (PartyRoleRelation) to define how customer accounts interact with partner roles such as Bill To, Ship To, Payer, and Wholesaler or Broker fulfillment accounts during order creation.
Create the Product Qualification Procedure: Create one qualification procedure and add the Product IOU Qualification step, which is the required step. Add any other qualification steps you need in the same procedure.
Create Product Unit of Measure: Configure multiple units of measure (ProductUnitOfMeasure) to define how products are ordered, measured, and priced across different markets and Internal Organization Units.
Create Unit of Measure: A unit of measure quantifies the consumption of a usage resource.
Advanced Orders for Telesales Data Model: See how Advanced Orders for Telesales separates master business data from execution specifications, assortment listings, and transactional order records.
Extend Context Definitions for Qualification and Pricing: Advanced Orders for Telesales provides standard context definitions that structure the data payload passed between product discovery, qualification, and pricing. The standard context definitions work by default, so you don't need to configure them for standard use cases. Extend an existing context definition when you want to add custom attributes without modifying the base attributes.
Advanced Orders for Telesales: Create and manage complex B2B sales orders through guided workflows with automated pricing and product qualification, so that captured orders match final ERP invoices and fulfillment rules.
How Advanced Orders for Telesales Processes Orders: Follow the step-by-step sequence the Advanced Orders for Telesales framework runs to turn an account interaction into an ERP-consistent, released order.
Link Accounts to the Internal Organization Unit: Associate customer accounts with an internal organization unit by creating Account Internal Org Unit records to enforce market-level account scoping.
Link Assortments to a Warehouse Location: Create a Location Assortment (LocationAssortment) to link the products physically stocked at a warehouse or distribution center to that location.
Link Order Product Specifications to Order Specifications: Associate Order Product Specifications (OrderItemSpec) with Order Specifications (OrderSpec) using the junction object OrderSpecOrderItemSpec to define which item types are permitted within an order template.
Link Users to the Internal Organization Unit: Assign sales reps and admins to an IOU by creating Internal Organization Unit User records. This step controls user-level access, sets working hours and work days, and defines a user's default unit during order creation.
Link the Warehouse Location to a Customer Account: Create an Associated Location (AssociatedLocation) to link the warehouse that supplies inventory to the customer account that receives shipments.
Scenario 2: Capture an Indirect Order: Walk through capturing an indirect order, where a telesales rep places an order for a customer account that's fulfilled through a third-party wholesaler or broker rather than directly by the manufacturer. This flow follows the same steps as a standard order, with additional handling for the fulfillment account.
Scenario 1: Capture a Standard Order: Walk through the baseline order capture flow, where a telesales rep captures a standard (direct) order for a customer account, adds a single line item, calculates pricing, and activates the order.
Advanced Orders for Telesales Scenarios: Review real-world business scenarios to see how telesales reps capture, price, and release customer orders using the Advanced Orders for Telesales framework.
Troubleshoot Advanced Orders for Telesales: Diagnose and resolve common issues that prevent orders from being created, populating products, calculating quantities, or releasing to your ERP system.
Verify the Pricing Decision Table: Verify that the pricing decision table is active and refreshed so that it picks up the current price book data.
Proactively Improve Org Health with Advisements (Beta): Advisements is an in-app experience that delivers intelligent, org-specific recommendations directly to admins with step-by-step remediation guidance for improving implementation health. Each advisement is automatically tracked and verified for completion, giving you clear visibility into your org's health.
Set Up Advisements (Beta): As a Salesforce admin, turn on Advisements (beta) from Setup to start generating org-specific health recommendations. If you use a cloned or custom Salesforce admin profile, also make Advisements (beta) visible in the App Launcher.
Agentforce for Scale: Use conversational AI to monitor org performance and analyze results directly in Scale Test, Scale Center, and ApexGuru.
Set Up Agentforce for Scale: Configure and activate Agentforce for Scale to use AI-powered performance analysis in Scale Test, Scale Center, and ApexGuru.
Subagents for Omnistudio (Pilot): Whether you’re a designer, developer, or implementation specialist, the agent provides instant, relevant information about any Omnistudio component or element you’re working with. It can also provide a complete build plan that helps design end-to-end solutions, based on an industry vertical. For Omniscripts, you can also run diagnostics that help you discover any issues that might lead to runtime errors.
Aggregate Fixed Non-Qualifying Points in Expiration Ledgers: Run the Aggregate Fixed Non-Qualifying Points in Expiration Ledgers Data Processing Engine definition if you decide to consolidate members’ fixed-type, non-qualifying points in batches. Before you run the definition, make sure that there are no duplicate loyalty aggregated points expiration ledgers.
Add Source Objects to a Configuration: Add standard or custom source objects to a research configuration so AI Relationship Research reads the CRM data that you choose.
Add Validation to a Lead or Contact Record Page: Attach a validation-enabled research configuration to a Lead or Contact record page so that the relationship graph flags employer discrepancies for your users.
AI Relationship Research: AI Relationship Research is an AI-powered feature that automatically discovers, analyzes, and presents relationship intelligence about the people and organizations connected to your Salesforce records.
Agentforce for AI Relationship Research: AI Relationship Research uses AI to discover, analyze, and present information about the people and organizations connected to your Salesforce records. The AI Relationship Research Subagent brings this capability into Agentforce conversations. Users can ask an agent to generate new relationship research or retrieve existing insights. The agent coordinates the required actions and returns sourced relationship insights directly in the conversation, without requiring users to open the record or use a separate research tool.
Assign AI Relationship Research Permissions: Assign the correct permission set to each user based on whether they set up AI Relationship Research or use it on record pages.
Configure AI Relationship Research: Configure AI Relationship Research by selecting the Salesforce objects to research, the data sources to use, and the relationship types to prioritize.
Configure AI Relationship Research Subagent: Add the AI Relationship Research Subagent to an agent so users can retrieve relationship insights about accounts, contacts, leads, and opportunities in Agentforce conversations.
AI Relationship Research Data Sources: AI Relationship Research draws from three independent data source categories: public web search, internal Salesforce CRM records, and Data 360 objects and data libraries.
Generate AI Relationship Research Insights: Generate relationship insights for an Account, Contact, Lead, or Opportunity record to surface the top-ranked people and organizations connected to your record.
How AI Relationship Research Works: AI Relationship Research uses generative AI and large language models to search across multiple data sources simultaneously and generate an interactive relationship graph.
Internal CRM Records: AI Relationship Research searches the Accounts and Contacts in your Salesforce org to identify and analyze potential relationships from the people and organizations already in your org.
Key Benefits of AI Relationship Research: AI Relationship Research surfaces hidden connections, replaces manual research, and enables you to act on relationship insights without leaving Salesforce.
Public External Search: AI Relationship Research searches the public web to discover relationships not yet captured in your CRM.
AI Relationship Research Relationship Graph: The relationship graph is the primary way you interact with AI Relationship Research, displaying up to eight related people and organizations as nodes around your target record.
AI Relationship Research Requirements: Before setting up AI Relationship Research, confirm that your org has the required licenses, permissions, and platform features.
Review and Resolve an Employment Discrepancy: Resolve an employment discrepancy from the AI Relationship Research graph by keeping the CRM value or confirming the researched value.
Secondary Research Data Validation for Leads and Contacts: Secondary research data validation checks the employer information on your Contact and Lead records against the employer that AI Relationship Research discovers through research, and flags any discrepancy so that users can keep the current value or apply the discovered one.
Set Up AI Relationship Research: Setting up AI Relationship Research is a four-stage process. The setup process includes preparing your org with the required features and licenses, assigning the correct permission roles to admins and users, configuring the product to research the right objects from the right data sources, and placing the component on the record pages where your users work.
Set Up Secondary Research Validation: Add secondary research data validation to a Contact or Lead configuration so that AI Relationship Research checks employer information and flags discrepancies on the AI Relationship Research graph.
AI Relationship Research Source Objects: Source objects define which CRM data AI Relationship Research searches when it generates relationship insights for a research anchor object. Choose from a set of standard source objects delivered for each anchor object, and add your own custom objects to extend research to the data that's unique to your business.
Target Audience: AI Relationship Research is designed for anyone who needs to better understand the people and organizations connected to a Salesforce record and act on those connections.
Use AI Relationship Research: After AI Relationship Research is set up and added to your record pages, you can generate relationship insights directly from an Account, Contact, Lead, or Opportunity record.
AI Relationship Research Use Cases: AI Relationship Research helps sales, financial services, and marketing teams uncover relationship intelligence and take action directly from Salesforce records.
Delete Records from Trending Datasets: General Data Protection Regulation (GDPR) requires you to delete customers’ personal data when customers request it, or when it’s no longer necessary to keep. You can remove customers’ data from the Analytics for Loyalty app by deleting the records from a trending dataset.
Deploy Analytics for Loyalty: Before you create an app from the Analytics for Loyalty template and use the dashboards, deploy Analytics for Loyalty in your Salesforce org.
Loyalty Analytics Base App: With the Loyalty Management license, your Salesforce org is also provisioned with five user licenses for the Loyalty Analytics Base App.
Deploy and Use Analytics for Loyalty: The Analytics for Loyalty app gives you actionable insights into loyalty programs that help you devise strategies to increase membership, retain customers, improve processes, and grow your business.
Add Einstein Predictions to a Loyalty Member Page: To display predictions on the likelihood of member inactivity on a member page, add the Einstein Predictions component on the Loyalty Program record page and configure the component visibility settings.
Einstein Discovery Apps: The Loyalty Einstein Discovery apps give you predictions that help you improve member engagement and increase your promotion revenue.
Predictions for Member Engagement Dashboards: The Predictions for Member Engagement app provides predictive insights that help you strategize and improve member engagement in a loyalty program.
Predictions for Promotion Revenue (Beta): The Predictions for Promotion Revenue app gives predictions on revenue generated from promotions and lets you identify target segments that generate higher revenue, and devise strategies to improve promotion revenue.
Embedded Dashboards: The Analytics for Loyalty app includes dashboards that Salesforce admins can embed in specific Lightning Experience pages. These dashboards give detailed insights into your members’ preferences and the assistance the members recieved.
In-App Dashboards: You can access the in-app dashboards through Analytics Studio.
Key Performance Indicators: Learn the definitions and calculations of key metrics shown in Analytics for Loyalty dashboards.
Schedule Dataflow for the Analytics for Loyalty App: The app creation process includes a dataflow that imports the latest data to CRM Analytics. Schedule the app to refresh every day to ensure that your app uses up-to-date data.
Analytics for Loyalty Dashboards: Use Analytics for Loyalty dashboards to get actionable insights into loyalty programs that help you devise strategies to increase membership, retain customers, improve processes, and grow your business.
Use Quip in a Salesforce Sandbox: Use Quip Advanced and Quip (previously Quip for Customer 360) features in a Salesforce sandbox.
Add a Salesforce Template Data Mention: As you set up your templates, use Salesforce Template Data Mentions instead of mail merge syntax. When a user creates a document from your embedded template, the Salesforce Data Mentions automatically populate with record’s data and continue to stay up to date.
Add Opportunity Team Members to a Close Plan: Automatically add an Opportunity’s Team Members to a Close Plan when an Opportunity is created. Also add Opportunity Team Members to existing Close Plans already linked to an Opportunity so they always have a 360-degree view.
Add Users to Your Quip Site: To give your users access to your Quip site, add them manually, upload a CSV, or automatically grant access to all users from a Salesforce org.
Manage Quip Permissions in Salesforce: Manage access to Salesforce data in Quip with Mirrored Salesforce Permissions, set org access to documents shared in Salesforce with Synced Sharing, and more.
Quip in Salesforce: Quip helps your users collaborate to make smarter, faster decisions—all within the context of your Salesforce data. With Quip Advanced (previously Salesforce Anywhere Advanced), your users can project manage with living documents and spreadsheets that centralize teamwork. It doesn’t matter if people are in the same room or on the other side of the globe. They can work in tandem and focus on what matters. Embed customizable business process templates in Salesforce records to create a single source of truth about your customers.
Complete the Quip Connection: To use Quip features in Salesforce, users must complete the Salesforce and Quip connection.
Considerations for Quip in Salesforce: Review some important information about products, features, and availability to get the most out of Quip in Salesforce.
Considerations for Using Quip in Flow Builder: Review some important information about requirements and limitations to get the most out of Quip actions in Process Builder and Flow Builder.
Create a Document in Lightning Experience: Create a document no matter where you are in Lightning Experience and link it to a record. Use the New Document global action to take freeform notes that stay open as you move around Lightning Experience.
Document Linking in Quip: Link important documents to your Salesforce records. Make it easier to find your documents in Salesforce by linking them to related Salesforce records.
Create Document Ranges in Your Templates: Add headings to your templates to create defined sections, called document ranges, and see how your templates are structured.
Quip Automation Use Cases: Learn about ways to streamline and customize business processes with Quip actions in Flow Builder.
Quip Global Quick Actions: Add Quip global quick actions to almost any page that supports actions. Use global actions to let your users create documents without leaving the page that they’re on.
Quip Lightning Components: Use Quip Lightning components, like the Quip Associated Documents component, to get the best out of Quip features in Lightning Experience.
Link a Document to a Record from Quip: To manage documents related to Salesforce, link them to a record. You can see which documents are linked to the record from the document or from the record itself.
Salesforce Live Apps: Bring your freeform content and your Salesforce data together with Salesforce live apps in documents. Collaborate on list views, records, dashboards, and maps, and sync your changes to Salesforce.
Deactivate Quip Users: Ensure that your Salesforce users are configured to get the most out of Quip.
Add the New Document Global Action Manually: To let your users create a document no matter where they are in Lightning Experience, add the New Document global quick action manually to individual global publisher layouts.
Remind Quip Users to Connect to Salesforce: Identify the users who haven’t connected Salesforce and Quip, and then send them an email reminder to complete the connection. After they complete the connection, your users can access all Quip features in Salesforce, and your Quip engagement metrics become more accurate.
Set Up Quip in Salesforce: Learn about technology requirements, setup, and permissions to get your users up and running with Quip in Salesforce.
Template Library for Administrators: Quip site admins can create custom galleries, called company galleries, to organize templates thematically and publish them for their Quip site users.
Connect Quip and Salesforce: Connect your Quip site to Salesforce. When you set up your site, we create permission sets, an Auth. provider, and external data source for you.
Apex Investigations FAQ: Get answers to common questions about Apex investigations in Scale Center.
ApexGuru Antipattern: Aggregating Records in Apex: SOQL queries that manually compute aggregate functions in Apex are inefficient and lead to performance issues. This approach wastes CPU resources and results in bloated, less readable code that's harder to maintain. Instead, use SOQL’s built-in aggregate functions like SUM(), AVG(), COUNT(), and COUNT_DISTINCT() to perform the work at the database level.
ApexGuru Antipattern: Busy Loop Delay: Busy loops that introduce a delay aren’t efficient and lead to performance issues. They waste CPU resources due to continuous loop execution. Governor limit breaches cause transaction failures. For delayed execution, use Salesforce alternatives like scheduling systems in Apex. If the delay is due to an async job, use System.enqueueJob with a delay parameter.
ApexGuru Antipattern: Copying List or Set Elements Using a For Loop: Using a For loop to copy parts of a list or set takes more CPU time and can cause governor limit breaches, especially with large datasets. Instead, Apex provides the addAll() method to copy elements efficiently in a single operation, improving both performance and code clarity.
ApexGuru Antipattern: DML in a Loop: Executing DML operations (insert, update, and delete) inside loops causes excessive resource consumption and can hit governor limits. Instead, batch DML operations by storing records in a list and performing the DML operation one time outside of the loop.
ApexGuru Antipattern: Expensive Debug Statements: Overusing System.debug() slows down execution, especially in production environments. Writing large amounts of data to logs increases the execution time and affects performance. Plus, the logs fill, making it harder to identify important issues.
ApexGuru Antipattern: Expensive Methods: Hot methods that consume over 5% of CPU time can cause performance bottlenecks, breach governor limits, and decrease system performance. Expensive methods consume more than 2% but less than 5% of CPU time. Critically expensive methods consume more than 5% of CPU time. To reduce CPU consumption, refactor expensive methods.
ApexGuru Antipattern: Expensive String Comparison: The == operator for string comparison invokes java.text.Collator.compare(), which is slower than using String.equals() or String.equalsIgnoreCase(). Longer strings and larger loops increase overhead.
ApexGuru Antipattern: Limits.getHeapsize() Methods: The Limits.getHeapSize() method monitors memory consumption during execution. This operation increases resource consumption, especially when used in production environments. When used in debug statements or logs, this method is evaluated even if the logs aren’t printed in production and this causes more performance degradation.
ApexGuru Antipattern: Redundant SOQL: Executing multiple SOQL queries on the same sObject with identical or nearly identical filter conditions creates inefficiencies. This practice wastes governor limits and increases transaction time because it requires more database round-trips. Processing separate query responses wastes CPU time and heap space.
ApexGuru Antipattern: Schema.getGlobalDescribe() Called Multiple Times Within a Class: Multiple calls to Schema.getGlobalDescribe() in a class cause performance issues and are computationally expensive. Calling this method multiple times within the same method results in redundant schema retrieval. Increased CPU usage can cause you to go over your governor limits.
ApexGuru Antipattern: Schema.getGlobalDescribe() In a Loop: The Schema.getGlobalDescribe() method collects schema information on all SObjects, which is computationally expensive. Using Schema.getGlobalDescribe() inside a loop can lead to performance issues, including breaking governor limits.
ApexGuru Antipattern: Schema.getGlobalDescribe() Not Efficient: Using Schema.getGlobalDescribe() to retrieve metadata for a single known SObject isn’t efficient. This method causes unnecessary overhead, decreases performance, and increases the latency of the associated entry point.
ApexGuru Antipattern: SObject Map in a For Loop: Building Map<Id, sObject> in a For loop inserts one record at a time. This query fetches all Custom Object__c records without filtering, which causes extra CPU usage. Filtering later in Apex boosts memory use, risks overflow, and slows performance. Instead, use Apex's map constructor or putAll().
ApexGuru Antipattern: SOQL in a Loop: Executing SOQL queries inside loops can quickly exhaust the governor limits and decrease system performance. Salesforce enforces a limit on the number of queries per transaction. Instead, batch SOQL queries outside of loops.
ApexGuru Antipattern: SOQL in a Loop (One Hop): The SOQL query is placed in a method in one class and the loop that invokes this method is in a different class. This structure leads to excessive SOQL queries, potentially hitting governor limits. Repeated query execution across class boundaries causes performance bottlenecks. Refactor the code to batch SOQL queries outside the loop, even if they’re spread across multiple classes.
ApexGuru Antipattern: SOQL with Apex Filter: Executing SOQL queries without a WHERE clause or LIMIT statement and filtering them in Apex retrieves unnecessary data. This process increases memory and CPU usage and can lead to overall system performance and governor limit issues.
ApexGuru Antipattern: SOQL with Negative Expressions: SOQL queries that use negative expressions such as NOT IN or != don't index effectively, leading to full-table scans. Less-efficient database operations increase query time and CPU usage. Avoid negative expressions. Use positive expressions wherever possible.
ApexGuru Antipattern: SOQL with Unused Fields: Retrieving unused fields in SOQL queries increases overhead, resource consumption, and query execution time. It also increases heap size and causes governor limits to be exceeded, especially with large datasets or complex objects. Only include fields directly required by your logic. Regularly review and improve SOQL queries to remove unused fields.
ApexGuru Antipattern: SOQL with Wildcard Filter: Using a wildcard such as LIKE '%term in SOQL queries prevents the use of indexes and causes full-table scans. Full-table scans increase query execution time and CPU usage. Use indexed fields for filtering and optimized search strategies.
ApexGuru Antipattern: SOQL Without Platform Cache: Running the same SOQL query repeatedly during a transaction or across requests can slow down performance and put an unnecessary load on the database. Instead, use Platform Cache to eliminate the need for custom settings or persistent storage.
ApexGuru Antipattern: SOQL Without a WHERE Clause or LIMIT Statement: Executing SOQL queries without a WHERE clause or LIMIT statement can retrieve too many records, leading to governor-limit breaches for the number of rows returned. To restrict the amount of data returned, include a WHERE clause or LIMIT statement in SOQL queries.
ApexGuru Antipattern: Sorting in Apex: Sorting records in Apex code uses more central processing unit (CPU) time and can exceed governor limits. This is especially true for large datasets. Using Apex to sort can also lead to heap-size overflows and degraded query performance.
ApexGuru Antipattern: Unused Methods: Unused Apex methods contribute to code bloat and increase the cognitive load for developers. These pieces of code make it harder to maintain the system and can also increase the size of the deployment package, making it more difficult to stay within the Salesforce Apex code size limits. Identify and remove unused methods to improve code clarity and performance.
ApexGuru Antipatterns: The antipatterns highlighted in ApexGuru help you detect avoidable inefficiencies in your Apex code. Where practical, we also share recommendations for revising your approach to improve the efficiency of your code.
ApexGuru Code Duplicates: Identify exact and near-duplicate Apex code across your org to reduce maintenance burden and free up governor limit headroom.
ApexGuru FAQ: Get answers to common questions about ApexGuru.
ApexGuru Insights: Use AI and machine learning models to analyze your Apex code, surface performance antipatterns, detect unused and duplicated code, and generate prescriptive optimization recommendations.
Use ApexGuru in Agentic IDEs with DX MCP: Resolve Apex performance issues directly in environments like VS Code, Agentforce Vibes, and Cursor without switching to the Salesforce UI.
ApexGuru Skills: Run Apex performance scans directly from Agentforce Vibes and other agentic surfaces without switching to the Salesforce UI.
ApexGuru Test Case Antipattern: Writing Filler Statements: Using meaningless code to inflate test coverage undermines code quality. Filler statements cause technical debt, missed bugs, and false code confidence. Focus on quality over quantity. Write meaningful tests for actual business logic and use coverage as a guide, not the goal.
ApexGuru Test Case Antipatterns: The test cases highlighted in ApexGuru help you find places in your Apex test code that aren’t valid, maintainable, or production-ready.
Unauthorized Managed Packages: To participate in the AppExchange Partner Program, Salesforce’s partners must meet certain standards and submit their AppExchange products for security review. When you install a managed package that the AppExchange Partner Program hasn’t authorized for distribution, we notify you during installation.
Archive App: Manage growing data volumes and improve system performance by archiving old or inactive data. The Archive app not only enhances system performance by reducing data volume but also helps you maintain accurate and consistent data. You keep only important and reliable information in production.
Archive Activities Tab: The Activities tab opens the Activities Table in the default list view of logs in the Archive app. You can create your own custom list views to filter and sort this information.
Add Objects to a Legacy Salesforce Archive Policy: To specify the records and files that you want to archive, add an object to your Legacy Salesforce Archive policy. While configuring the object, you determine which records to process, how to handle related files and attachments, and which related objects to archive in addition to the primary object.
Archive Admin Permissions: To secure sensitive archived data and manage storage efficiently, configure granular access levels for admins and end users. A role-based approach restricts unarchive or purge capabilities to authorized users or teams based on their specific operational requirements.
Archive Apex Data Queries: Archive Apex Data Queries enable programmatic access to archived data in the Archive app. These data queries automate business processes, support third-party system integrations, create custom views and reports, and cross-reference archived data with active records.
Archive Apex—Right to Be Forgotten (RTBF): Data privacy regulations grant individuals the Right to Be Forgotten (RTBF), requiring organizations to securely erase personal data upon request. Archive Apex enables compliance by identifying and deleting specific data from the Archive app, ensuring thorough removal while preserving the integrity of other archived data.
Archive Apex Testing: Before working in your production environment, test your Apex Class Wrapper in Archive Apex in the Archive app.
Unarchive Apex: Programmatically unarchive records in the Archive app based on specific filters and retrieve search results that match your request.
Authenticated User Permission Requirements for Archive: Archive connects to your Salesforce org through the API via an Authenticated User. This user account serves as the integration point for all Archive operations.
Create a Custom Agent Action: Create a reusable action, and then assign that action to the agent in the Archive app.
Create Archive Policies: To select specific records for archiving, define filters, schedule a process, and set data retention periods, create a policy in the Archive app.
Create a Legacy Salesforce Archive Policy: Create and save a new Legacy Salesforce Archive policy. After your policy is created, you can target the records that you want to archive by adding objects.
Archive Dashboard (Home Tab): The Archive app dashboard under Home provides a comprehensive overview of your data, file storage, and other essential metrics.
Export Archive Search Results: Set criteria to find target archived records in the Archive app and export the search results. You can download these search results as a CSV file.
Get Started with the Archive App: The Archive app helps you manage storage costs and improve performance. Archive moves historical data out of your org.
How Purge Policies Work: A purge policy permanently deletes archived records that match your query conditions, up to 1,000,000 records in each run. It doesn't delete records under legal hold or records protected by Archived Data Protected from Purge.
Hyperforce Infrastructure in the Archive App: Your Archive region—not your Salesforce org's Hyperforce status—determines whether Archive uses an authenticated user or the Platform Integration User (PIU), and which setup, security, and import and export options you see.
Import Data from a Local Drive in the Archive App: Import offloaded Salesforce data stored in local CSV files to the Archive app staging area. Then manage the final data migration and set specific retention periods for your records by configuring an Archive import policy.
Manage Staged Data: View or clear records in the staging area before archiving them.
Restrict Visibility for Imported Data in the Archive App: Secure sensitive archived records by manually enabling Archive Component Restriction Rules and uploading custom sharing entries for specific objects. This configuration prevents unauthorized users from accessing imported data in the Archive component while maintaining visibility for record owners.
Archive Incremental Export: Rather than exporting the entire dataset from the Archive app every time, export only the data that was changed or added after the last export.
Archive Limitations: Various limitations and unsupported features for archiving, unarchiving, and other functionalities within the Archive app, including policy record limits, object exclusions, and operational constraints.
Manage Index Fields in the Archive App: Efficient management of index fields in the Archive app is essential for optimizing search and query performance. Archive automatically indexes certain fields based on internal algorithms. However, some fields can't be indexed at all, and you configure others manually. The Index Fields Setup feature shows admins which fields are indexable so that they can manually select fields to improve search performance.
Manage Legal Hold Requests in the Archive App: Place archived records on legal hold by creating a legal hold request in the Archive app. When records are under legal hold, they can't be unarchived, deleted, or removed—whether accessed through the SDK RTBF or the user interface.
Manage Archive Policies: To streamline your data archiving process in the Archive app, run, edit, clone, estimate, and preview archive policies.
Manage Archive Component Controls and Layout: Manage the display and configuration of objects within the Archive component, defining both root and child objects that end users can query. Also, the layout provides insights into root-child object relationships via the Is Root identifier.
Find Documentation for Archive Products: Learn how to identify which data archiving product is active in your Salesforce org and where to find documentation for each product. Salesforce has three products for archiving data: the Archive app, the Archive managed package, and the legacy Salesforce Archive. Each product helps you manage data and improve system performance by moving old or inactive data into storage. In this way, you keep only important and reliable information in production.
Identify Object Records that You Want to Archive: Select an object and apply filter conditions. You can archive records that meet any condition, all conditions, or a custom set of conditions in Legacy Salesforce Archive.
Salesforce Objects Excluded from the Archive App: Objects excluded from the Archive app fall into one of these categories: non-deletable and non-queryable objects, or objects without relationship names.
Store Data Externally with Legacy Salesforce Archive: Legacy Salesforce Archive is your external storage solution for records and files. Reduce storage consumption in your org and boost performance by archiving historical or nonessential data. Comply with privacy regulations by maintaining customer records in a secure, low-cost environment. For on-demand access to archived records, you can set up your data store with Salesforce Connect.
Preview a Legacy Salesforce Archive Policy: Generate and acknowledge a preview of your Legacy Salesforce Archive policy. Previews estimate the number of records and files that your policy affects, helping you evaluate its impact on the data in your org.
Purge Policies: Define data removal policies for archived records in the Archive app. Purge policies override the original data retention expiration set at the time of archiving. When designated to do so, purge policies permanently delete data.
Archive Regions and IP Addresses for Allowlisting: Find the AWS data center locations where Archive stores data. To ensure successful connection requests, add the IP addresses for your specific region to your organization's allowlist.
Retention Vs Purge Policies in the Archive App: Retention sets how long Archive keeps records. A purge policy deletes records before that period ends, such as for Right to Be Forgotten requests.
Set the Run Schedule for a Legacy Salesforce Archive Policy: Define when and how often your Legacy Salesforce Archive policy executes. For example, you can choose to manually start your policy, or you can schedule it to run at regular intervals.
View Archived Records Via Salesforce Connect: To view archived records in Legacy Salesforce Archive directly from the Salesforce UI, set up your data store with Salesforce Connect.
Archive Search: Search for and view the records you've archived. Archive Search respects only object-level permissions, not sharing rules or role hierarchy, so users with access can view all records for accessible objects. Limit access to admins.
Search with the Archive Agent: Search for archived records in the Archive app by using the Archive Agent. Specify an object directly in your search phrase, add criteria for accuracy, and work within system limitations to find the records you need.
Set Up the Archive Component in the Archive App: Show archived data as related lists within Salesforce. Even though the data has been archived and is no longer stored directly in Salesforce, end users can still access and view the data in the familiar Salesforce interface.
Archive Storage Analyzer: Analyze data and file storage consumption in your org to identify archiving opportunities and create policies directly from the analysis workflow.
View Archived Records in the Archive App: When a record is archived, the Archive app preserves the record's metadata at the time of archiving, including its assigned Record Type and the data available on the layout. Page Layouts are based on the viewing user's profile, while Dynamic Forms aren't supported for archived records.
Archive Component Restriction Rules: Control end-user visibility in Salesforce of specific archived records according to object sharing tables in the Archive app. Applicable to Archive Single Objects and Archive Multiple Objects components.
Advanced Exchange: Use Advanced Exchange to streamline the creation of return and replacement requests for defective products or parts. Field technicians or service managers can quickly capture product details and initiate both return and replacement requests in a single, unified process—ensuring smooth operations with minimal disruption.
Advanced Exchange Permissions: Salesforce admins, service managers, and field technicians require permissions to create and manage advanced exchange requests.
Prerequisites for Advanced Exchange: Complete these prerequisites before you set up and use Advanced Exchange in Asset Lifecycle Management.
Create an Advanced Exchange Request: Create an Advanced Exchange request for one or more products associated with a work order. For each item being returned and each replacement requested, capture details such as the account, contact, source and destination locations, and the reason for the return. A single Advanced Exchange request can include multiple line items, allowing service teams to manage all expected returns in one efficient and consolidated process.
Advanced Exchange Setup: Set up and configure Advanced Exchange to enable a unified process for creating return and replacement requests for products or parts. Assign the necessary permissions to users to create and manage advanced exchange requests.
Advanced Exchange Requests: Easily raise an advanced exchange request to create return and replacement requests for the damaged products or parts you want to return to the manufacturer.
Advanced Exchange Workflow: Salesforce admins configure the org, assign required permissions, and enable the Advanced Exchange feature. Once set up, field service technicians or service managers can initiate return and replacement requests for damaged products or parts—all from one place, without navigating across multiple pages in the app.
Agent Topic: Asset Service Estimation: Service representatives can use the Asset Service Estimation agent topic to summarize asset performance and telematics data, select specific price books and quantities for multiple products, and apply individual coverage such as warranties, entitlements, or service contracts to each line item. It also helps to create service quotes and draft emails to customers.
Agentforce for Asset Service Management: Helps service representatives create summaries, generate quotes, and draft customer communications using conversational interactions.
Set Up Agentforce for Asset Service Management: Set up and configure features to use agentforce for Asset Service Management. Before creating an agent using this template, you must set up Data Cloud.
Agent Topic: Asset Service Work Order Management: Service representatives can use the Asset Service Management agent topic to retrieve accepted quotes, create work orders, and draft emails to share work order details with customers.
Create an Agent from the Asset Service Management Template: Create an agent using the Asset Service Management template to help users easily summarize asset performance and telematics data, generate quotes, and draft customer emails.
Create an Agent from the Inventory Management Template: Create an agent from the Inventory Management template that helps your users easily find products and vehicles in inventory, generate quick summaries, and create product requests to efficiently replenish stock.
Agentforce for Product Upsell and Cross-sell in Service: Use Agentforce to help every technician and service rep to identify and propose upgrades or add-ons for specific assets, or recommend new products during customer interactions. You can access this Asset Service Lifecycle Management (ASLM) feature on both desktop and the Salesforce Field Service (SFS) mobile app.
Agentforce for Inventory Management: Helps users efficiently monitor and manage inventory using natural language queries. It supports actions like finding products and vehicles, summarizing stock levels, and creating product requests. By mapping user input to relevant search criteria, the agent delivers accurate, contextual results. Whether it's about locating a specific product or part, checking stock levels, or an inventory manager creating a replenishment product request, the agent streamlines end-to-end inventory interactions for faster decision-making.
Agent Topic: Inventory Management: Use the Inventory Management agent topic to quickly search for inventory items across multiple locations, generate comprehensive summaries with stock status and quantities, and create product replenishment requests with ease.
Agentforce for Asset Service Lifecycle Management: Agentforce for Asset Service Lifecycle Management offers a suite of AI-powered agent templates that help you manage inventory tasks and asset service estimation through natural language interactions. With out-of-the-box agent topics and actions, quickly generate performance summaries, estimate service requirements for assets, and search for products or assets based on user-defined criteria.
Allocate Inventory: Allocating inventory allows users to soft reserve available stock for a specific demand source. Users can choose between auto allocation or manual allocation.
Asset Interactive Hierarchy: Asset Interactive Hierarchy offers a way to easily visualize and navigate a complex asset and its child assets.
Set up Asset Interactive Hierarchy: Set up Asset Interactive Hierarchy to provide asset hierarchy capabilities and view an extended hierarchy of assets on the console and on the mobile.
Asset Interactive Hierarchy Views: Asset Interactive Hierarchy offers real-time views of current, installed, and maintained assets, including key information such as installation dates, maintenance history, and current status. The asset interactive hierarchy views help technicians manage and maintain assets efficiently during field operations.
Asset Service Lifecycle Management: Asset Service Lifecycle Management empowers businesses to manage the entire lifecycle of asset service operations, streamline field service operations, and boost the productivity and satisfaction of your field service teams. Asset Service Lifecycle Management offers a suite of features that help businesses maximize asset lifetime value, minimize asset downtime, improve service delivery, manage product services at scale, and simplify the work order management process.
Assign Permission Sets to Users: Assign the required Agentforce permissions to the Field Technician and Service Representative users to grant agent access on both the desktop console and the Salesforce Field Service mobile app.
Best Practices for Agent Success: Know the best practices that maximize the quality of the agent's product and upgrade suggestions.
Book Service Appointment: Agents can easily view, book, reschedule, or cancel service appointments. This feature is accessible from a work order and other features.
Clone and Activate Book Service Appointment Flow: Clone a screen flow to book service appointments. This procedure guides you through setting up a new flow, adding the necessary components, and configuring the flow to book service appointments efficiently.
Enable Features for Book Service Appointment: This procedure outlines how to turn on Asset Service Lifecycle Management and Field Service in Salesforce. You'll turn on settings, add permissions, turn on quotes, and install the Field Service Managed Package to manage assets and service appointments effectively.
Launch Book Service Appointment Flow: You can launch the Book Service Appointment flow from various places in your Salesforce org, such as an account, an asset, a work type group, a quote, or a work order.
Set Up Book Service Appointment: Set up and configure Book Service Appointment to help your users book service appointments from Work Order Estimation or other processes.
Book a Service Appointment: Use Book Service Appointment to efficiently schedule service appointments. This procedure guides you through launching the process from various objects and booking an appointment with the necessary details.
Configure the Agent Topic to Use Revenue Cloud Quoting: Update the Upsell and Cross-sell agent topic by adding or removing specific actions. Refine the instructions to enable the agent to use Revenue Cloud quoting capabilities.
Create and Update Custom Pricing for Work Order Estimation: Get your pricing outcome by creating or updating your own pricing API with or without customizations. Launch the work order estimation flow by using accounts, assets, quote, order, or worktypegroup.
Cross-sell New or Related Products During Service Engagements: Assist field technicians and service reps to drive revenue through cross-selling, suggesting new products based on the customer account profile rather than a specific existing asset.
Customize Book Service Appointment: Book Service Appointment (BSA) is made more modular, comprehensive, and customizable by using LWC, Lighting Messaging Services (LMS) and flows. To customize or extend BSA default implementation you can modify the existing flow as well as built custom LWC to add or replace existing ones as per your requirements.
Customize Upsell and Cross-sell Topic to Use Revenue Cloud Quoting: Customize the standard Upsell and Cross-Sell agent topic if you want to utilize the Revenue Cloud quoting capabilities. This customization gives you greater flexibility to manage complex quotes, supporting multiple line items and precise, per-line-item discounting.
Deallocate Inventory: Deallocating inventory releases previously reserved stock when it is no longer required. This can occur when an order is canceled, modified, or when allocated quantities need to be made available for other demand sources.
Define Location Hierarchy: Organize your inventory facilities by defining parent-child relationships between locations. By defining a location hierarchy, you can group sub-locations such as aisles, shelves, or rooms under a single parent warehouse or service center. This structure allows inventory managers to create comprehensive inventory count plans for an entire facility at once, reducing the administrative effort of managing hundreds of individual sub-locations.
Delete Records for Work Estimation: Provides functions to cancel work orders and delete components from a quote, such as removing an entire work source or just the lines of a specific work type.
Depot Repair: Depot Repair streamlines the repair process for damaged products or parts returned to depots. Work orders for depot repair can be created directly from return order line items with auto-populated data, simplifying the work order creation process. Structured workflows and real-time tracking improve service performance and ensure consistency across depot operations.
Depot Repair Permissions: Salesforce admins and depot managers require permissions to create and manage depot repair work order requests.
Prerequisites for Depot Repair: Complete these prerequisites before you set up and use Depot Repair in Asset Lifecycle Management.
Create a Depot Repair Request: You can create a depot repair work order for one or more return order line items. For each depot repair work order, specify the work type and priority, assign it to a user or service queue, and select a parent work order if applicable.
Depot Repair Setup: Set up and configure the Depot Repair feature to create depot repair work orders directly from return order line items. Assign the necessary permissions to users who create these work order requests.
Depot Repair Requests: Easily raise depot repair requests for the damaged parts or products that are returned.
Depot Repair Workflow: Salesforce admins set up the org, assign the required user permissions, and configure settings to enable Depot Repair. Service managers create and manage depot repair work orders for returned items.
Discover and Set Up Asset Service Lifecycle Management Features With Salesforce Go: Explore, set up and configure, and monitor usage of Asset Service Lifecycle Management features in one streamlined setup location. Access content resources, such as videos, online tours, Trailhead, and Salesforce Help articles, to learn about features, and get help with configuration - all without leaving the setup page. Discover more ASLM features and add-on licenses that are available based on your Salesforce edition. And if you've turned on the Your Account app, you can quickly buy add-on licenses for some products directly from Salesforce Go.
Configure Work Estimation Flow for Partner Community: Partners can perform work order estimation for Asset Service Lifecycle Management (ASLM) from the community site. Create and assign customized permissions and buttons to launch the work estimation flow on the community site.
Extend Work Order Estimation Customizing Flow and Using Custom Lightning Web Component: Work Order Estimation (WOE) is made more modular, comprehensive, and customizable by using LWC, Lighting Messaging Services (LMS) and flows. To customize or extend WOE default implementation you can modify the existing flow as well as built custom LWCs to add or replace existing ones as per your requirements.
Inventory Allocation: Inventory Allocation enables organizations to soft reserve inventory for diverse demand sources such as Sales Orders and Work Orders, while maintaining visibility into on-hand, allocated, and available inventory. It ensures inventory is reserved, prevents over commitment, and provides accurate inventory visibility even during high-volume, concurrent transactions.
Add the Inventory Allocation Component to Record Pages: Add the Inventory Allocation component to Order and Work Order record pages, allowing users to view and trigger allocations for products available as line items. The Inventory Allocation component can be added to the record pages using the Lightning App Builder.
Inventory Allocation Data Model: The Inventory Allocation data model includes objects and fields that help you track inventory and manage allocations across inventory locations.
Inventory Allocation Permissions: Salesforce admins and inventory managers require specific permissions to configure, create, and manage inventory allocations.
Inventory Allocation Setup: Set up and configure Inventory Allocation to automate or manually manage the allocation of product items.
Inventory Allocation Workflow: Salesforce admins enable and configure Inventory Allocation by turning on required features, assigning user permissions, and adding the Inventory Allocation component to Order and Work Order record pages. Order managers create inventory allocations, define product fulfillment locations to automate source selection, and track allocations on product item records.
Inventory Batch Management: Track and manage inventory more efficiently for both serialized and non-serialized products using batch details.
Inventory Batch Search: Helps inventory managers, service managers, and customer service reps search inventory using batch level details.
Permissions for Inventory Batch Search: Salesforce admins, inventory managers, partner users, and other users that manage inventory require permissions to set up and use Inventory Batch Search.
How Inventory Records Work for Inventory Batch Search: Track and monitor inventory with batch-level details across locations. Helps you manage serialized and non-serialized products with enhanced traceability across your supply chain.
Search Products Across Inventory Locations: Use batch details to search for products and parts stored across multiple inventory locations. Quickly find the inventory you need using configurable search criteria set up by your admin.
Configure a Searchable Object for Inventory Batch Search: Create a searchable object configuration to define the object that's the basis of the search experience. This configuration determines how the object's data is updated, parsed, aggregated, and displayed in both search criteria and results. You can reuse a searchable object configuration across multiple search criteria configurations. For Inventory Batch Search, use the Product Inventory Batch Searchable Field object. Use an activated copy of the Update Product Inventory Batch Searchable Field Values data processing engine (DPE) definition template to automatically sync the data.
Create a Search Criteria Configuration for Inventory Batch Search: Create a search criteria configuration to design the inventory batch search experience for your users. You can define the fields from the searchable object that can be used as search criteria and shown in the search results. You can also define the display format of the search result and how search results can be filtered, grouped, aggregated, and sorted. For your inventory batch search experience, create a search criteria configuration based on the Product Inventory Batch Searchable Field object.
Use Inventory Batch Search: Search inventory across locations using batch level criteria. This visibility helps ensure product traceability and better stock planning across locations.
Workflow for Inventory Batch Search: Inventory and service teams can search for serialized and non-serialized inventory based on product, product attributes, and batch details such as batch name, manufacture date, and expiry date. Use the Criteria-Based Search and Filter (CBSF) framework to define how batch level inventory data is used and displayed within the search experience.
Add Product Items to an Inventory Count Plan: Inventory managers can easily add product items to inventory count plans and assign the inventory auditors to count the product items. For each set of product items added to a count plan, inventory managers define if the count is a blind count and provide count instructions to auditors. After product items are added to count plans, Inventory Count Plan Item records are created. These records are created or updated: Inventory Count Assessment and Inventory Count Product Item.
Perform Inventory Count by Using Salesforce Field Service Mobile App: Inventory auditors can record inventory counts for serialized and non-serialized products at inventory locations by using the Salesforce Field Service mobile app. Quickly capture counts by entering count details or scanning product barcodes. Note the reasons for count discrepancies and key instructions, observations, or contextual details. If you count products in batches, or if the counting is interrupted, save your count progress intermittently and resume your count later.
Create an Inventory Count Plan: Inventory managers can create cycle and ad hoc inventory counts for different inventory locations. Schedule count plans for different locations based on your operational needs, regulatory requirements, and business cycles. To reduce administrative overhead, you can use Location Hierarchies to perform inventory counts across hierarchical structures, such as warehouses or service fleets, without creating separate plans for each room, aisle, or vehicle belonging to the location for which the inventory plan was created. Set a schedule for counts for a plan by specifying when counts start and end, how often counts occur, and the window for performing each count. The schedules of inventory count plans determine the schedules of inventory count assessments.
How Inventory Count Information Is Represented: Inventory count records store information about your inventory, inventory count plans, and counted inventory at inventory locations. Different records represent different aspects of the inventory count lifecycle, such as activities to count products at designated locations, the schedules of counting sets of products, and the serial numbers of counted products.
Enable Inventory Count: To set up and use Inventory Count, turn on Inventory Count in Setup.
Set Up Salesforce Field Service App for Inventory Count: The Salesforce Field Service mobile app is an intuitive, offline-first app that helps companies manage their field service and onsite operations. Inventory auditors can easily enter product counts, scan product barcodes, and note count observations by using the app. Set up the Salesforce Field Service mobile app, and customize it based on your unique processes. To help auditors perform counts, add the Inventory Count Assessment list view to a Salesforce Field Service app configuration by using the Field Service Mobile App Builder.
Inventory Count: Get an accurate picture of your inventory, compare your physical and system stocks, and maintain reliable inventory records with inventory counts. Plan cycle counts and create ad hoc counts for products and parts across inventory locations. Easily capture inventory counts for serialized and non-serialized products and take count notes at designated inventory locations by using the Salesforce Field Service mobile app. Get a single view of the accuracy, progress, counted quantities, and other key details of inventory counts.
Inventory Count Permission Sets: Salesforce admins, inventory managers, and inventory auditors require permissions to set up, manage, and perform inventory counts.
Inventory Count Setup: Set up and configure Inventory Count to effectively plan and perform inventory counts. Turn on Inventory Count in Setup, and grant users the required permissions. Help inventory auditors perform counts at inventory locations by setting up the Salesforce Field Service mobile app.
Managing and Performing Inventory Counts: Inventory count managers plan and schedule inventory counts by creating inventory count plans. They add product items to be counted to count plans and assign them to inventory auditors. Inventory auditors perform counts for serialized and non-serialized products at designated inventory locations by using the Salesforce Field Service mobile app. Inventory managers can track count progress and captured quantities.
Inventory Count Workflow: Manage inventory count plans, determine products to be counted, perform inventory counts at designated locations, and track count results.
Automated Inventory Replenishment Process: Build an inventory replenishment process that automatically replenishes product items based on their applicable inventory replenishment policies. Use a preconfigured batch job definition and create a flow to schedule and invoke the replenishment process.
Create an Inventory Replenishment Policy: Inventory managers design inventory replenishment policies to define how product items are replenished when they reach predefined levels. Create policies at both a granular level, such as individual products at specific locations, and at a broader level, such as product categories across all locations. Inventory managers define the minimum quantity at which product items must be replenished and the maximum quantity until which product items can be replenished.
Inventory Replenishment Data Model: The Inventory Replenishment data model includes objects and fields that you can use to track your inventory, manage inventory replenishment policies, and monitor product requests across inventory locations.
CSV File Import for Inventory Replenishment Policies: Easily create, update, and upsert data for a large number of inventory replenishment policies by importing CSV files with the policy data. Prepare CSV files with policy data, import the files to Salesforce, map the CSV header columns to the Inventory Replenishment Policy object's fields, and track import operations.
Customize Product Item Page Layout for Inventory Replenishment: Help inventory managers easily identify the applicable replenishment policy for each product item by adding the Applicable Inventory Replenishment Policy related list on the product item record page.
Inventory Replenishment: Prevent stockouts, ensure consistent product availability, and cultivate customer trust with a reliable, streamlined inventory replenishment process. Manage inventory replenishment policies to define how product items are restocked, where they're restocked from, and by how much they're restocked. Periodically run an automated inventory replenishment to trigger replenishment when stock levels drop below predefined thresholds—all without manual inventory checks.
Inventory Replenishment Permissions: Salesforce admins and inventory managers require permissions to build an automated replenishment process, create inventory replenishment policies, and manage product requests.
Define Product Fulfillment Locations for Inventory Replenishment: Establish designated replenishment source locations for product items at particular locations, of particular products, or both by creating product fulfillment location records. A product item is replenished from the fulfillment location if it's covered by an inventory replenishment policy with the Product Fulfillment Location replenishment source location criterion. With designated replenishment source locations, businesses get better control, reliability, and scalability for their inventory replenishment operations.
How Applicable Inventory Replenishment Policies Are Applied to Product Items: Inventory replenishment policies determine how and when to restock product items. The inventory replenishment policy that most closely matches a product item applies to the product item. If any policy doesn't exactly match a product item, then the applicable policy is determined through a systematic, hierarchical approach.
Inventory Replenishment Setup: Set up and configure Inventory Replenishment to automate the replenishment of product items based on inventory replenishment policies. Turn on Inventory Replenishment in Setup, and grant users the required permissions. Build an automated inventory replenishment process by using a predefined flow and a predefined batch job definition.
Managing Inventory Replenishment: Inventory managers track inventory levels, establish inventory replenishment policies, and manage the requests for products across inventory locations. Inventory replenishment policies define how product items are restocked when they reach a minimum stock level. Automated replenishment processes determine the product items to be restocked based on the replenishment policies. The policy with the most closely matching combination of product and location applies to a product item.
Inventory Replenishment Workflow: Monitor inventory levels, use an automated inventory replenishment process, and manage product requests across inventory locations.
Inventory Search and Transfer Data Model: The Inventory Search and Transfer data model includes objects and fields that you can use to store information about your inventory, inventory locations, and accounts, and build a search experience for your inventory.
Enable Inventory Operation Settings: To let users relate product transfers or disbursements that share the same source location to a single inventory operation, turn on Inventory Operation Settings.
Inventory Search and Transfer: Manage inventory stock and movement, and streamline your inventory operations by using Inventory Search and Transfer. Design a search experience to empower inventory and service teams to monitor products and parts at warehouses, plants, and other inventory locations. Configure the searchable object that's the basis of the search experience, what criteria users use to search for products, how search results appear, and what actions users perform on the search results by using Criteria-Based Search and Filter. Maintain optimal inventory levels and fulfill customer demand by easily transferring serialized and non-serialized products across inventory locations.
Permissions for Inventory Search and Transfer: Salesforce admins, inventory managers, partner users, and other users that manage inventory require permissions to set up and use Inventory Search and Transfer.
Configure a Searchable Object for Inventory Search: Create a searchable object configuration to define the object that's the basis of the search experience, how the object's data is updated, and how the object's data is used in the search experience. You can also define how the object's data is aggregated, parsed, and shown in the search criteria and results. You can use a searchable object configuration in multiple search criteria configurations. For your inventory search experience, use the Product Inventory Searchable Field as the searchable object and use an activated copy of the Update Product Inventory Searchable Field Values data processing engine (DPE) definition template to update the object's data.
Create a Search Criteria Configuration for Inventory Search: Create a search criteria configuration to design the inventory search experience for your users. You can define the fields from the searchable object that can be used as search criteria and shown in the search results. You can also define the display format of the search result and how search results can be filtered, grouped, aggregated, and sorted. You can also define the actions that users can take on the search results. For your inventory search experience, create a search criteria configuration based on the Product Inventory Searchable Field object and the Product Transfer search action.
Inventory Search and Transfer Setup: Set up and configure Inventory Search and Transfer to help inventory managers and service managers search for and transfer products across inventory locations. Assign the required permissions to users who set up and use the search experience. Design the inventory search experience by using Criteria-Based Search and Filter. Set up the search experience quickly by using the Product Inventory Searchable Field object, the Product Inventory Searchable Field data processing engine template, and the Product Transfer lightning web component.
Search for and Transfer Products Across Inventory Locations: Monitor inventory stock across inventory locations by searching for products and parts based on their business brand, product family, model year, and other key attributes. Review the available quantity of products at an inventory location and transfer serialized and non-serialized products to another location easily. After products are transferred, ensure that they're received to maintain accurate inventory information.
Configure the Product Transfer Action for Inventory Search: Define the types of actions that users can perform on search results. Create action configurations to help users launch Flow, Lightning Web Component, or Omniscript-based actions. For your inventory search experience, help users transfer products by creating an action configuration with the prebuilt Product Transfer lightning web component. The Product Transfer lightning web component is a workflow that helps users transfer serialized and non-serialized products across inventory locations.
Using Inventory Search and Transfer: Inventory and service managers can model and track inventory stock and movement by using the inventory management data model. Use the inventory search experience to search for and track products across locations based on their business brand, make name, product family, and other attributes. Meet customer demand and maintain the right inventory level by transferring serialized and non-serialized products across inventory locations.
Workflow for Inventory Search and Transfer: Salesforce admins enable features for Inventory Search and Transfer, grant permissions to users, configure the searchable object, design the inventory search experience, and add the search component to the required pages. Inventory and service managers manage inventory records, monitor inventory stock, transfer products across locations, and receive transferred products.
Screen Header: Displays a screen heading, using either predefined or custom text.
LWC Book Service Appointments: Manage the full lifecycle of service appointments for work orders, from booking and rescheduling to viewing current schedules.
Custom Navigation for Work Estimation: Shows a set of footer options on the screen, where each option is set up to trigger a specific event once you select it.
Lightning Web Components for Work Order Estimation: WOE is made more modular, comprehensive, and customizable by using LWC, Lighting Messaging Services (LMS), and flows. This section lists the technical specifications for each out-of-the-box (OOTB) LWC, including its purpose, inputs, and events.
Display Child Work Orders: Streamlines the work estimation process by allowing you to find and import line items from existing work orders directly into a quote.
Display Quote Line Items for Work Source: Provides a comprehensive interface for managing the work sources on a quote, including their associated work types, QLIs, and coverages.
Display Work Estimation Quote Detail: This LWC displays basic quote details and dynamically selects one of two layouts, showing an additional field if the quote is linked to a work order.
Enter Quote Details: Capture the mandatory quote details for creating or updating a quote. Your quote can include details such as name, price book, and optional address.
Finalize Quote Approval: Set a quote to approve or reject status stating a reason in the description. It creates new work orders or merges work orders under the existing parent work order conditionally.
Lightning Web Component for Book Service Appointment: BSA is made more modular, comprehensive, and customizable by using LWC, Lighting Messaging Services (LMS), and flows. This sections lists the LWC along with the details such as purpose, inputs, outputs, triggers, and other relevant information
Orchestrate Lightning Message Service Events: Use this LWC to orchestrate UI events like modal openings, hyperlink redirections, and messages triggered by clicking other components. This manages the global lightning spinner by having it listen to the loaderstatus event to show an operation in progress.
Pricing Orchestrator for Work Estimation: You can combine quote line items (QLIs) and their chosen coverages into a Pricing Data output. This output is compatible with the Work Estimation Coverages Context or other extensions.
Work Estimation CUD Operations Handler: Use this LWC to listen to LMS events related to create, update, and delete (CUD) operations. When these events are received, the LWC triggers the relevant APIs to manage records for quotes, work sources, line items, and work orders.
Manage Inventory Allocation: Use Inventory Allocation to monitor allocation status, adjust quantities as needed, and ensure inventory is correctly reserved, released, or consumed based on business demand.
Set Up Pricing for Partner Community: Get the customized pricing outcome on the community site. Update the pricing procedure, configure the user profile with the necessary permissions, and grant API access on the community site.
Propose Product Upgrades or Add-ons During Service Engagements: Enable field technicians and service reps to capitalize on on-site sales opportunities by providing a streamlined flow for proposing product Upgrades (replacements or betterment) or Add-ons (supplements) for specific assets.
Set Up Actionable Lists for Product Service Campaign: Set up and configure Actionable Lists features to help service managers create lists of assets that must be included in product service campaigns. To set up actionable lists, assign the required permissions to users, turn on the features in Setup, and configure the data sources for actionable lists based on your business needs. You can create actionable lists from two data sources: actionable list definitions and Data Cloud segments.
Create a Product Service Campaign: Service managers can create product service campaigns to define the activities to be performed on products, such as recalling, upgrading, modifying, or servicing assets. Each product service campaign has a fixed duration and a priority that helps companies assess the scale and impact of the campaign.
Product Service Campaign Data Model: The Product Service Campaign data model includes objects and fields that you can use to organize activities in product service campaigns, track assets and vehicles in product service campaigns, and manage the services to be performed for assets and vehicles.
Manage Items in Product Service Campaigns: Service managers can efficiently add the assets that they must recall, repair, modify, or upgrade, to a product service campaign. Easily curate and segment lists of assets to be included in a product service campaign by creating actionable lists with the assets. You can add items to a product service campaign by creating an actionable list with the impacted assets, by associating a campaign to an existing list, or by manually creating product service campaign item records.
Customize Page Layouts for Product Service Campaign: Help service managers and agents capture key information, review critical details, and perform relevant actions for product service campaigns. Configure page layouts to help service managers and agents create product service campaign items from actionable lists and quickly generate work orders for product service campaign items. Add the required fields, buttons, and related lists to page layouts for the Product Service Campaign, Product Service Campaign Item, and Work Order objects.
Product Service Campaign: Organize impactful, timely product service campaigns to service products in disrepair, recall defective products, upgrade eligible products, and streamline product communications at scale. Product service campaigns help companies nurture a robust reputation, cultivate customer loyalty, and ensure customer safety. Service managers can design product service campaigns to assess issues in a large number of assets in a product line and coordinate activities to address the issues. They can easily segment and curate actionable lists of assets in product service campaigns, and assign lists to service agents. Service agents can monitor the services to be performed on the assets.
Product Service Campaign Permissions: Salesforce admins, service managers, and service agents require permissions to create and manage product service campaigns and actionable lists.
Create Return Orders for Product Service Campaigns: Service agents can track and facilitate the recall and return of assets in a product service campaign by creating return orders. Return orders outline the reason for the return of assets, and the source and the destination of the return shipment. You can capture how customers are reimbursed for the returned asset, the processing plan for the assets after they’re returned, and other key details. Create a return order for a product service campaign and a return order line item for each asset included in the campaign.
How Product Service Campaign Management Records Work Together: Compliance officers, quality assurance engineers, safety managers, and product developers at original equipment manufacturing companies can define and track product campaigns for recalls, upgrades, or maintenance services with precision. Understand how product service campaign information is represented.
Create a Product Service Campaign Group Definition: Specify information about product service campaign definitions within groups based on attributes, such as the origin, status, or consequences of a campaign.
Manage Scope of Product Service Campaigns: Enable precise definition of product service campaigns, such as recalls and maintenance service campaigns. Capture granular details on the scope, causal parts, and impacted inventory across partners and define campaign groups by attributes like origin or status. Map and allocate the most appropriate service providers within a specific geographic area to minimize costs and turnaround time for the execution of a product service campaign.
Product Service Campaign Setup: Set up and configure Product Service Campaign features to help service managers orchestrate product service campaigns and to help service agents manage services for the impacted assets. Assign the required permissions to users for creating campaigns, curating actionable lists of impacted assets, and executing campaigns. To help users create lists of assets for product service campaigns, set up the Actionable List features and configure the data sources for actionable lists. Also, customize page layouts to help service teams create product service campaign items from actionable lists and create work orders for product service campaign items.
Product Service Campaign Creation and Management: Service managers can coordinate initiatives to evaluate and address issues about products or services by creating product service campaigns. They can easily curate lists of the impacted products and add products to the campaigns. Service agents can capture and track the actions to be performed on the impacted products, and perform outreach activities.
Create Work Orders for Product Service Campaign Items: Service agents can manage and monitor the services and upgrades on assets and vehicles in a product service campaign by creating work orders. Work orders describe the work that service technicians and agents perform during service appointments, and outline asset service plans. Generate work orders for selected items or all items in a campaign with minimum effort.
Set Up Inventory Batch Search: Set up and configure Inventory Batch Management to search and manage inventory data based on batch details. Turn on Inventory Batch Management in Setup, and grant users the required permissions.
Show Coverages: Select, modify, or view coverage for any specific work source.
Show Work Type Details: View the details of work types and their associated Quote Line Items (QLIs) for a specific work source. You can also apply discounts to coverages from the QLI's discount field.
Create a Part Return Request Using the Field Service Mobile App: With the Salesforce Field Service mobile app, field service technicians can request the return of parts when they visit a customer location. They analyze the issue and quickly record information such as the distributor details and source and destination locations in a work order. If the technician is in an area with no internet access, this app seamlessly works offline as well, and syncs the data automatically when the internet is available.
Field Service Mobile App Setup: The Field Service mobile app is designed as an offline-first app. You can work and have your changes saved without internet connectivity. Salesforce service managers and field technicians require permissions to create and manage part return requests.
Service Parts Return: Manage the return process for service parts to improve service process efficiency for users. Field service technicians can request the return of damaged parts related to a work order when the part must be replaced.
Service Parts Return Permissions: Salesforce admins, service managers, and field technicians require permissions to create and manage part return requests.
Service Parts Return Setup: Set up and configure the Service Parts Return features to create part return requests and help field technicians to capture the parts to be sent back to the manufacturer. Assign the permissions for Service Parts Return to users who create requests to return a part.
Create a Part Return Request Using Desktop: Service teams can create a part return request for one or more products related to a work order. For each part that must be returned, they can specify the dealer details, source and destination location, and the reason for the return. Each part return request can contain multiple requests for all the parts that the manufacturer is expecting back.
Part Return Requests: Easily raise part return requests for the damaged parts that you want to be returned to you. Your field technicians can request the return of the damaged parts during a service appointment.
Service Parts Return Workflow: Field service technicians can request the return of damaged parts during a service appointment.
Set up Automatic Time Sheet Entry Creation: Set up the flows and actions that create time sheet entries on the start and end of a service appointment, based on technician geolocation.
Agentforce for Timesheets: Boost the efficiency of your technicians by integrating the assistive and autonomous AI capabilities of Agentforce into your business in Timesheets and Labor Cost Optimization. Technicians and crew leads can use Agentforce to self-serve and quickly resolve their timeheets-related queries.
Assign Permission Sets for Using Agentforce for Timesheets: Give your users access to the Agentforce for Timesheets by assigning them the required permission sets. With these permission sets, users can enable Agentforce and use this feature.
Verify Timesheets in Bulk for Technicians: Supervisors can verify timesheets for a crew and its active members. Select a crew and its members, and then verify the submitted timesheets.
Categorizing Technician Time with Time Sheet Entry Records: The Time Sheet Entry records represent the time that a technician spends on a field service task. To ensure compliance with labor laws, use the Time Sheet Entry record to categorize the time your technician has spent on different tasks in a shift.
Configure Timesheet Entry Fields: Create custom fields on the TimeSheetEntry object and update page layouts to make sure that technicians can enter the necessary details during their shifts.
Configure Timesheet Entry Item Fields: Create custom fields on the TimeSheetEntryItem object and update page layouts to make sure that technicians can enter the necessary details during their shifts.
Configure Vehicle Selection: Supervisors can configure the options for the technicians to select the vehicle.
Copy Timesheets: For recurring tasks, technicians can copy an approved or submitted timesheet to future dates.
Correct Timesheets and Timesheet Entry Errors: Field technicians can fix any errors in the timesheets and timesheet entries before submitting the timesheet for supervisor’s approval.
Create Timesheet Entry Items: Field technicians can create and edit their timesheet entry items in the Timesheet tool available in the Field Service mobile app.
Create Timesheets and Timesheet Entries in Bulk: Supervisors can create timesheets for a crew and its active members. The user selects a crew and its members, and then create new timesheets or timesheet entries.
Creating a Timesheet Template: Create a template that field service technicians use to quickly create timesheets with a consistent format. You can then use the template to automatically create timesheets for technicians.
Delete Timesheets: Technicians can delete timesheets to remove inaccurate entries or to create a new timesheet.
Edit and Delete Timesheet Operations: The Timesheets Agent already supports creating and deleting Timesheet records. Now we’ve added the ability to edit existing timesheet records, including modifying start times, end times, subjects, and associated work orders. Users can also delete timesheet records that were created in error. These operations are performed through natural language requests to the agent, which validates the changes against business rules before applying them.
Enable AI and Agentforce for Timesheets: Enable Einstein for Timesheets to get access to powerful generative AI features across Timesheets and Labor Cost Optimization features. A predefined prompt template determines the context for information generation.
Enabling AI and Agentforce for Timesheets: To enable the Timesheets Agent, navigate to the Advanced Timesheets and Labor Cost Optimization Settings page in Setup. The Enable AI and Agentforce for Timesheets toggle activates the conversational AI capabilities. This feature requires the Timesheets Agentforce add-on license, which must be provisioned separately from the base Timesheets and Labor Cost Optimization license
Extend Data Capture with Custom Forms: Enhance your data collection by creating Data Capture Forms and associating them with Timesheets or service resources.
Get Timesheet Details Action: Use this agent action to retrieve detailed information about a timesheet, including its entries and any validation errors, for a specific date.
How Timesheets Management Works: Use the Timesheets Management app to efficiently review and approve technicians’ work hours. Improve the accuracy of your financial processes by using the approved timesheet data to calculate employee pay and client billing. To make informed decisions and strategic plans, supervisors can generate reports from the aggregated timesheet data. Crew leaders can submit their own hours and those of their crew members, and monitor their submitted timesheet status, all within the web browser.
How Timesheets Work for Technicians: Field technicians can review their timesheets, create new timesheets, copy approved timesheets, or delete timesheets.
Idle Time Entry Creation: Administrators can configure the automatic time rounding feature to create idle time entries instead of closing gaps between consecutive timesheet entries. When enabled, gaps within the configured threshold generate a new idle time entry rather than extending the previous entry. This capability is useful for tracking breaks or transition time between tasks. The Time Gap Threshold accepts values from 0 to 480 minutes (8 hours), with validation to prevent excessively high values.
About Timesheets and Labor Cost Optimization: Enable mobile workers to input and manage their time, even when they are offline. Enable supervisors, time clerks, and crew leads to bulk edit and approve timesheets. Drive compliance with labor laws and union rules, flag non-compliant timesheet entries and automate meal allocations with Business Rules Engine. Gain insights into operations and costs with a unified view using data from Enterprise Resource Planning systems, fleet management systems, labor union rules, and projects.
Licenses Required for Using Agentforce for Timesheets: Boost the efficiency of your field technicians by integrating the AI capabilities of Agentforce into your business in Timesheets and Labor Cost Optimization.
Log Time in The Past or Future: Technicians can enter time up to 15 days in the past or in the future on the mobile app if they need to fill in missed hours or if they want to plan their work in advance.
Manage Informational Timesheet Validations: Review non-blocking informational messages regarding your shift and entry consistency while proceeding with your timesheet verification.
Manage Timesheets: Use the Timesheets and Labor Cost Optimization app to track and manage employee hours, especially the hours of your field technicians. Supervisors can approve and review timesheets, and ensure accurate record-keeping and payroll. Use timesheet data to generate reports with insights into labor costs, project efficiency, and resource allocation trends.
Mobile Crew Lead Time Management: Introduces the Enable Crew Management toggle in the Advanced Timesheets and Labor Cost Optimization Settings. When enabled, crew leads can manage crew members' timesheets in the Salesforce Field Service mobile app. The crew lead's mobile timesheets landing screen lets the crew lead create, edit, and manage each service resource's time, including timesheets, timesheet entries, timesheet items, and wage type summaries. The crew lead can create time for crew members in bulk or individually. This dedicated crew lead experience, with time aggregated by crew member, is available after an admin turns on the org preference for crew lead functionality in Setup.
Object Access Levels with User Permissions: Set the access of objects based on the roles of technicians, supervisors, and admins with permission sets for Timesheets and Labor Cost Optimization.
Pay Period Date Validation: Pay Period is used in the mobile app so that the Service Resource may see their total hours over a day, week and over their personal pay period. Pay period records now include enhanced date validation that prevents saving records where the end date is before the start date. The validation message guides users to select an end date that is on or after the start date, ensuring data integrity in pay period configuration.
Pull Down Refresh: Refresh your mobile view to display updated record statuses, altered details, or new validation errors across supported pages.
Recommendations for Objects: When setting up Timesheets and Labor Cost Optimization objects, understand their purpose and the best practices.
Record Multiple Shifts in a Day: Field technicians who split their work between day and night crews and technicians who work intermittent hours on the same day can create and submit more than one shift in a single timesheet.
Rejected Timesheet Resubmission and Pull-Down Refresh: Service Resources can now edit and resubmit rejected timesheets as if they were in the Verified state, eliminating the need to create new timesheet records after rejection. Pull-down refresh is implemented across the Timesheet History, Timesheet Details, Work Order, Meals and Gifts, and Time Off pages, providing a consistent mobile experience for viewing updated data.
Review and Approve Timesheets in Bulk: Supervisors can review multiple submitted records, identify records that fail validation, fix issues, update shared fields for multiple entries, and approve or reject in bulk with comments on the Timesheet Management app.
Review Timesheet History: Technicians can review and edit their timesheets on the Field Service mobile app.
Run an Over or Under Hours Report: For teams that require technicians to work a certain number of hours per week, supervisors can create an Over or Under Hours report which includes the details of the total hours of each technician.
Set Up Automatic Meal Calculation: Set up the flows and Business Rules Engine components that you can use to automatically calculate the meals and supplementary compensation earned by mobile workers for approved time sheets.
Set up Automatic Time Sheet Validation: Set up the expression set and records that are used to automatically validate a timesheet submitted by the technician. Automatically create the time sheet entry items and time sheet wage type summaries associated with the submitted timesheet.
Set up Automatic Vacation Time Updates: Set up the flows that you can use to automatically update the time sheet records when any resource absence records are modified.
Set up Bulk Time Sheet Actions: To bulk approve timesheets and automatically update the associated time sheet entries and time sheet entry items, set up the flows and buttons in the record page and list layouts.
Set up Flows for Timesheets and Labor Cost Optimization: Use the Flow Builder templates in your org to set up Timesheets and Labor Cost Optimization. Clone these flow builder templates. When you clone a template, you can customize and then activate the cloned template. Alternatively, you can create a flow from scratch, and add the required flow actions to it.
Set up Permission Set Groups for Timesheets and Labor Cost Optimization: Timesheets and Labor Cost Optimization is built for the Field Service Technician and Supervisor personas. Assign the right permission sets for the admin, supervisor, and technician permission set groups and assign them to users to allow Timesheets and Labor Cost Optimization access.
Setting Up Timesheets and Labor Cost Optimization: Enable Salesforce Field Service, set up permission set groups and assign them to users, review recommended access levels for Timesheets and Labor Cost Optimization objects, create a timesheet template, set up flows, and add the Timesheet component to your Field Service Mobile app.
Sharing Settings for Timesheets and Labor Cost Optimization Objects: Review the organization-wide default sharing settings to understand the minimum level of access for each object for a field service technician. You can extend the default level of access to your users, both internal and external. You can also use permission sets, sharing rules, and role hierarchies to fine-tune access beyond the organization-wide default options.
Submit Timesheets in Two Steps: Verify your hourly breakdowns and perform data overrides before finalising your timesheet submission.
Summary View Enhancements with Pay Cycle Filtering: Service Resources and crew leads can now filter the summary view by This Week, Last Week, Current Pay Period or , or Previous Pay Period or Cycle in addition to the existing custom date range option. The backend logic relies on the service resource's assigned Pay Group to determine pay period boundaries. Aggregated totals for regular time, time and a half, and double time update based on the selected filter. Additionally, meal counts and shift differential hours are now displayed in the aggregated summary.
Create Your Own Timesheets: Field technicians can create and edit their timesheets in the Timesheet tool available in the Field Service mobile app.
Timesheets and Labor Cost Optimization: Streamline the timesheet management process, improve compliance with labor union regulations, and reduce costs with Timesheets and Labor Cost Optimization.
Timesheets Agent with Agentforce: Use AI-powered Agentforce capabilities to edit and delete timesheet records through natural language interactions, reducing manual data entry and improving timesheet management efficiency for field service teams.
Timesheets and Labor Cost Optimization Setup with AI Tools: With an AI agent working headlessly through a command-line interface, a Salesforce admin configures Timesheets and Labor Cost Optimization for Field Service without clicking through each Setup node manually.
Timesheets and Labor Cost Optimization Design Considerations: Keep these design considerations in mind when you set up timesheets and labor cost optimization headlessly with AI tools. The initiate prompt matters: Setup timesheet alone can fail to find the correct endpoint. Use setup timesheets end-to-end.
Timesheets and Labor Cost Optimization Requirements: Before you set up timesheets and labor cost optimization with AI tools, confirm that your org has Field Service installed and the required licenses, features, and edition. You also need admin credentials, the Salesforce CLI, an AI coding agent, such as Claude Code or Agentforce Vibes, and at least one technician user and one admin user.
Use Summary View Filters: Utilize pre-defined date filters to view aggregated totals for regular time, time and a half, and double time based on your assigned pay group.
Use Timesheets: Field technicians and crew leaders can use the Timesheets and Labor Cost Optimization app to review their timesheets, create new timesheets, and perform more timesheet-related tasks.
Verify Automation Before Submitting the Timesheets: To ensure payroll accuracy, field technicians can review the results of automatic calculations before submitting the timesheet. If there’s a discrepancy, technicians can edit the pay codes, shift differentials, and job expense types.
Monitor Timesheet Summary: Field technicians can view time summaries over days or date ranges in the Field Service Mobile App.
Upsell and Cross-sell Topic: Field technicians and service reps can identify and display relevant product upgrade opportunities and add-on options for existing assets (upsell), and new product suggestions (cross-sell) applicable to customers. They can use the Upsell and Cross-sell agent topic to deliver a comprehensive overview of all recommended products in a single, clear communication. Providing all necessary information upfront enables customers to make well-informed decisions, thereby enhancing their trust and overall satisfaction.
Enable Features for Work Order Estimation: Enable Asset Service Lifecycle Management, configure Quotes Settings, and turn on Field Service. Set up the necessary configurations for work types, products, and related entities.
Extend Default Context Definition for Work Order Estimation: You can extend the Out-Of-The-Box (OOTB) context to create a custom context definition with additional attributes, without modifying existing ones. Similarly, you can extend the mapping to include additional mappings, without changing the existing ones.
Work Order Estimation Workflow: Streamline the process of estimating and generating work orders for field service tasks.
Set Up Foundational Features: Set up and configure Work Order Estimation features to help service managers and service agents estimate work, create detailed quotes, and generate work orders for field service tasks.
Create and Update Custom Quotes for Work Order Estimation: Create or update quotes by using preferred customizations, implementing your own quoting API. Launch the flow from any of the available records, such as accounts, assets, quote, order, and worktypegroup.
Integrate Book Service Appointment: On the cloned Work Order Estimation (WOE) flow, integrate Book Service Appointment (BSA) by completing the BSA setup and modifying the WOE flow.
Launch Work Order Estimation Flow: You can launch the Work Order Estimation flow from various places in your org, such as an account, an asset, a work type group, a quote, or a work order.
Work Order Estimation: Before starting any field service work, assess the costs and effort required to provide reliable quotes and plan efficiently. You can estimate field service work for different sources, such as repair or extension work for assets, installation tasks for quote items or order items within existing sales quotes and orders, and network and infrastructure expansions for specific work type groups.
Set Up Omnistudio Document Generation: This step is optional. To generate and download proposal documents, install and set up Omnistudio Document Generation.
Work Order Estimation Setup: Set up and configure Work Order Estimation to allow your users to accurately estimate field service work before starting the job.
Understand Salesforce Field Service Configuration for Work Order Estimation: Before configuring Salesforce Field Service for Work Order Estimation, ensure you understand key factors such as work types, product families, service contracts, and warranties. These factors play an important role in the setup and execution of work order estimation.
Use Salesforce Pricing with Custom Pricing Procedure for Work Order Estimation: You can modify the settings for the container that hosts the Lightning Web Components (LWCs) for the Work Order Estimation. The instructions provided here are for OmniScript, the default container, but you can customize these steps for other orchestration containers if necessary.
Use Work Order Estimation: Assess costs and required effort before starting any field service work to provide reliable quotes and plan efficiently. You can estimate field service work for various work sources such as assets (for example, repair and extension work), quote items or order items within existing sales quotes and orders (for example, installation of these items), and work types under specific work type groups (for example, network and infrastructure expansions).
Add Work Source for Work Estimation: Provides a guided, multi-screen process to select and add various types of work sources to the quote. You can add work sources such as Asset, QLI, Order Product, and Work Type Group to your current Quote.
Assign Member Tier Benefits: The Assign Member Tier Benefits is a flow action used as part of tier assessment. The action creates, updates, or expires records in the Member Benefits table. The action is based on the tiers associated with member benefits that include a defined Benefit Action.
Assign Permission Set to Users: Give your admins access to Privacy Center features by assigning a permission set license and permission set to them. With this license, users can create retention and portability policies, manage Right to Be Forgotten requests, and view run logs and Privacy Center schedules. Privacy Center comes with 30 licenses.
External Client Apps Association and Disassociation: External client apps are designed for second-generation (2GP) packaging, which means that they’re optimized for source-driven development on scratch orgs.
Associate the Experience Cloud Site with a Loyalty Program: You can associate a member with multiple loyalty programs. The Loyalty Member Portal shows the member’s loyalty programs that are associated with the Experience Cloud site. You can associate a Loyalty Member Portal only to one loyalty program member.
Configure a Connected App for the Authorization Code and Credentials Flow: The Authorization Code and Credentials Flow is the foundation of headless login, registration, passwordless login, and guest user identity. Before setting up these features, enable the Authorization Code and Credentials Flow at an org-wide level and configure required settings and access policies for your connected app.
Scheduled Reminders: Create automated email reminders to keep users updated about important occasions. Send recurring or one-time reminders to keep recipients informed and ready for upcoming or completed actions.
Adopt Release Updates Proactively: Adopt critical updates before they're enforced, giving you time to test and make updates to your org before they're enabled.
Availability at Salesforce: Learn how Salesforce maintains high availability and what steps you can take to improve your org's own availability and resilience.
Automate Testing and DevOps: Standardize and reduce the risk of human error through automated testing and by adopting DevOps practices.
Incident Plans and Recovery Exercises: Be prepared for incidents that can impact your org’s availability by developing a business continuity plan and performing recovery exercises.
Resilient Salesforce Solutions: Prioritize ways to design for business continuity and improve the overall stability and resiliency of your org.
Develop Monitoring and Support Processes: Consider monitoring and diagnostic solutions that alert you when issues arise and develop processes to help reduce the impact to your users.
Prepare for Availability: Availability is a shared responsibility. Improve your Salesforce experience by implementing and maintaining a solution that uses best practices and recommendations.
Test and Prepare for Major Releases: Familiarize yourself with release notes and use a sandbox to test your org's compatibility with a Salesforce major release before it's live in production.
Regular Performance Testing: Create and run performance tests regularly to check for issues that could affect your org’s performance, availability, and overall health.
What is Availability?: Learn what availability means at Salesforce and why it's important.
Why Salesforce Performs Maintenance: Learn why maintenance occurs and how it improves your Salesforce instance’s performance, security, and availability.
Facilitate Partner Referrals with B2B Referral Management: To amplify your growth targets, empower partners to refer new business clients. Drive business referrals with tailored rewards and accelerated program design. Automate the referral journey through guided stages and invocable actions. Optimize your sales with comprehensive visibility and tracking across referral programs and promotions.
Back Up and Recover Data with Salesforce Backup & Recover Next: Use Salesforce Backup & Recover Next to protect your Salesforce data from loss or corruption, recover from data incidents quickly, and simplify your overall data management strategy. Protect your organization from permanent data loss and corruption by automatically generating backups. Manage what data to back up, identify changes easily, and use precise data restoration tools to recover data affected by integration issues, system errors, or user error in just a few clicks.
Backup and Recover Next REST API: Use the Backup and Recover Next REST API to start backups, browse backup data, and review audit events from your own applications.
Audit Backup & Recover Next Events: You can download the audit log for a detailed record of all events in Backup & Recover Next, including who initiated the event and when. Events are stored for up to a year.
Run a Backup On Demand: Aside from scheduled backups, you can start backups on demand in Backup & Recover Next up to three times a day. Run a backup on demand before or after a deployment or maintenance, or any time an additional recovery point is needed.
Cancel a Running Backup: Stop a running backup in Salesforce to fix an error in production data or modify default backup options.
Choosing a Backup Region: When you set up Salesforce Backup & Recover Next, you select a region to store your backup data. The region determines the physical location of your backed-up data and can differ from your Salesforce org's region. After setup, you can't change your backup region.
Create Data Privacy Requests: Create data privacy requests to anonymize or correct every backed-up instance of a customer record. Use Forget requests to anonymize personal data or Rectify requests to replace it with corrected values.
Manage Customer PII with Data Privacy Requests: Data privacy requests help you protect a customer’s personal data throughout your backup history. Create requests in Backup & Recover Next to apply the required privacy protection to every backed-up instance of a record.
Enable Backups in Salesforce: After configuring your backup settings, enable backups for your org and run your first backup.
Exclude Files and Attachments from Backups: Backing up files and attachments makes sure that backups are as true and accurate as possible for recovery. If backups of files and attachments aren’t necessary in your case, you can remove them for improved backup times.
Exclude Object Groups: Within Backup & Recover Next are different object groups that we recommend excluding. When creating an exclusion rule, you can select to exclude these groups, rather than exclude each object individually.
Exclude Objects from Backups: Set up exclusion rules to customize and optimize your backup strategy. These rules define which Salesforce objects to exclude from backups, minimizing backup time and ensuring that backups only include essential data. Also use these rules to exclude data from your backup to conform with data security policies.
Include Objects or Object Groups: Remove exclusion rules that you created to include objects or object groups in future backups.
Back Up Data with Salesforce Backup and Recover: To maintain the integrity of your org, Saleforce Backup and Recover creates daily backups of data, attached files, metadata, managed packages, and sandboxes. Backup and Recover also highlights unusual data activity so you can quickly find and fix data errors or mismanagement incidents.
Pause Scheduled Backups: Pause and resume scheduled backups as needed. On-demand backups, compare, restore, and other app activities are still available when your scheduled backups are paused.
Assign the Salesforce Backup & Recover Next Permissions: Use Backup & Recover Next permissions so that users can run backups, configure specific settings, and run Backup & Recover Next activities. Assign them to profiles or permission sets to give your users the specific permissions that they need in Backup & Recover Next.
Preview Your Restore: When you restore data from a backup, you can select an object hierarchy depth to include child objects of that depth in the restore. To review all the child objects included in the restore before confirming the restore, do a preview restore.
Restore Your Data: Recover from data corruption or loss event by restoring backed-up records and their deleted child records in Salesforce Backup & Recover Next.
Restore Specific Fields: To avoid overwriting valid changes in objects you restore, select specific fields to restore.
Understand Backup Retention: A data retention policy describes how long to keep data to meet business or legal requirements. You can configure these policies to align with your organization’s internal requirements for data backups and control how long Salesforce stores your backups.
Retry Failed Records: Review your restore results to identify records that failed, and then reattempt the restoration.
Compare Your Backups: Identify record changes between two Salesforce backups by comparing them. Quickly spot additions, modifications, and deletions to ensure data accuracy and integrity.
Schedule When Your Backup Runs: Choose when and how often you want your backups to run to minimize the impact on your business.
Search for Terms in Your Backups: Find specific records across your backup data history. Search for records that contain a keyword or phrase and filter the search by object and backup date range. Add conditions to narrow the search results further.
Select Your Storage Region: Before you start backing up data, select the region where Backup & Recover Next stores backup data. Selecting a region helps your organization meet data residency requirements and align backup placement with disaster recovery plans.
View Backup Data: The Backup tab provides a full overview of all your backups. View backup information at a high level, or select a backup and see the included objects and details.
View Compare Results: The compare report shows the record changes, including additions, modifications, and deletions, between objects in two different backups.
View Restore Results: The restore results show a summary of the records included in the restore.
Protect Your Data with Salesforce Backup: Use Salesforce Backup to prevent data loss, recover from data incidents quickly, and simplify your overall data management strategy. Protect your organization from permanent data loss and corruption by automatically generating backups. You can create backup policies for high-value and regulated data, and restore that data in just a few clicks.
Apply Advanced Restore Filters in Salesforce Backup: Refine your search beyond the required filters and return a targeted set of records by selecting an object and setting filter conditions. You can process records that meet all conditions, any condition, or a custom arrangement of conditions.
Back Up Data with Salesforce Backup: Your Salesforce Backup policy defines what data is included in backups. You can back up object data, including related records, files, and attachments. You can rely on the daily scheduled backup, set a custom schedule, or backup manually.
Exception Codes for Troubleshooting Salesforce Backup: Salesforce Backup shows exception codes for specific errors that can happen during backup and restore processes. Use the exception code to determine what caused the error and how to fix the problem.
Export Data from a Backup: You can export data from backups made with the Salesforce Backup app. Exports are helpful when you want to reference historical data, values, or information models. You can also use exported backups to complete larger or more complex data restoration projects.
View and Interpret Salesforce Backup Logs: Follow these instructions to view logs in Salesforce Backup. These logs contain information about the status of various Salesforce Backup policies and activity.
Plan Your Salesforce Backup Strategy: To create high-value and time-efficient policies, make a plan for identifying and prioritizing the data that you want to back up. Then make sure that users have access to the objects that store data and build your backup policy in batches.
Configure Salesforce Backup Settings: After installing the Salesforce Backup app and assigning permissions, configure a secure connection between the app and Salesforce.
Restore Files with Salesforce Backup: Restore a deleted or modified file from a backup. When an older or shared file has multiple versions, you can use filters to identify and restore a specific version of a file quickly. A file is restored on all of the records that it’s related to.
Restore Records with Salesforce Backup: The Salesforce Backup app can restore records from a backup for you. Use this method for most restoration jobs. Before you start, make sure that you have object-level permissions for the records that you want to restore.
Restore Data from a Backup: The Salesforce Backup app can restore much of your data from a backup for you. You can also export data from a backup and restore it with a data import tool such as Data Loader or Data Import Wizard. Before you start, make sure that you have object-level permissions for the records that you want to restore.
Actions: You can create and manage loyalty programs for your organization using the standard and custom invocable actions. For example, change member tier based on their loyalty points, assign and process benefits based on their tier, manage loyalty points for a member, issue voucher for a member, and cancel redemption transactions for a member. You can also use Actions to integrate data in third-party systems with Loyalty Management.
Business APIs for Automating Loyalty Processes: Use Business APIs to integrate external systems with Loyalty Management for performing everyday processes of your loyalty program, such as updating member details, crediting points, or issuing vouchers.
Configurable Business APIs: For repetitive and complex loyalty tasks, Loyalty Management comes with process templates that you can run using the configurable business APIs. Each process template contains a set of predefined process parameters and rules. You can clone a process template to create a program process.
Cancel Voucher Process Template: To discard the unused vouchers or to withdraw the issued vouchers, you can cancel the vouchers especially from an external system. You can use the Cancel Voucher process template to create processes for canceling vouchers.
Change Member Tier Process Template: To upgrade or downgrade a member’s tier from an external system, you can use the Change Member Tier process template to create processes for changing the tier of the members in the loyalty tier group.
Credit Points to Members Process Template: When loyalty members gain points for transactions in external systems, you can use the Credit Points to Members process template to create processes for crediting the precalculated points to the member.
Debit Points from Members Process Template: If a redemption catalog doesn’t exist in external systems and when loyalty members redeem points for transactions, you want the Loyalty Management application to calculate the points and redeem the points from the member's points balance. Use the Debit Points from Members process template to create a process for processing the member’s transaction journals and debit points from the member’s points balance.
Enroll in Promotion Process Template: When loyalty members of a loyalty program enroll in loyalty promotions associated with loyalty program from an external system, you can use the Enroll in Promotion process template to process the enrollment of members for a promotion.
Get Member Promotions Process Template: Use the Get Member Promotions process template to create a process for showing member promotions on an external system.
Issue Voucher Process Template: To issue vouchers to loyalty program members or contacts, especially from an external system, you can use the Issue Voucher process template to create processes for issuing vouchers as per the specified voucher definition.
Unenroll Member Process Template: If your loyalty members are leaving the loyalty program and when you want to disengage those members from the loyalty program from an external system, you can use the Unenroll Member process template to create processes for inactivating the status of the member in the loyalty program.
Update Member Details Process Template: Use the Update Member Details process template to update an Individual type member’s details in their Loyalty Program Member record and the related Contact record. You can update standard fields, such as member address or custom fields, such as shopping preferences. You can also credit points to members for completing or updating their membership profile.
Integrate Loyalty Management with External Systems: Loyalty Management comes with a set of developer resources, such as business APIs, invocable actions, and standard objects that you can use to integrate your loyalty programs with external systems, such as point of sales, reservations, booking, billing, service, and operations. For example, to create a transaction journal and credit points to members for online purchases, you can integrate your external website with a business API that can run the relevant loyalty program process.
Overview of the Credit Points to Members Process Template: Learn about the Credit Points to Member process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Overview of the Debit Points from Members Process Template: Learn about the Debit Points from Members process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Overview of the Enroll in Promotion Process Template: Learn about the Enroll in Promotion process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Overview of the Get Member Promotions Process Template: Learn about the Get Member Promotions process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Overview of the Issue Voucher Process Template: Learn about the Issue Voucher process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
Overview of the Cancel Voucher Process Template: Learn about the Cancel Voucher process template and the template’s components. how you can use the template to create a loyalty program process and execute the process.
Overview of the Change Member Tier Process Template: Learn about the Change Member Tier process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
Overview of the Unenroll Member Process Template: Learn about the Unenroll Member process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
Overview of the Update Member Details Process Template: Learn about the Update Member Details process template and its components. Also, understand how you can use the template to create loyalty program processes based on your requirements and execute the processes.
Opt Out of Promotion Process Template: Use the Opt Out of Promotion loyalty program process template to let members leave the promotions that they’ve enrolled in.
Create a Process Using the Opt Out of Promotion Template: Use the Opt Out of Promotion loyalty program process template to create processes. After you create the process, customize the process to suit your loyalty program’s requirements.
Overview of Opt Out of Promotion Process Template: Learn about the parts of the Opt Out of Promotion loyalty program process template. Also, understand how to use the template to create a process based on your loyalty program’s requirements.
Standard Objects: Loyalty Management uses objects on the Salesforce core platform and the SObject APIs are available for all Loyalty objects. SObject APIs are defined on top of the Salesforce Objects. These APIs retrieve basic metadata for a specified object, or create a record for the specified object. For example, this resource can be used to retrieve the metadata for the Account object using the GET method, or create an Account object using the POST method.
Static Business APIs: The simpler tasks that don’t require customization are left as Business APIs. They have a fixed payload of parameters. You can change the parameters but not the structure.
Create a Process Using Cancel Voucher Process Template: Learn about the Cancel Voucher process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
Create a Process Using the Change Member Tier Process Template: The Change Member Tier process template contains a rule and a set of parameters that upgrade or downgrade a Loyalty Program Member of the Loyalty Tier Group. You can create a process using the template and extend it based on your requirements.
Create a Process Using Credit Points to Member Process Template: The Credit Points to Members process template contains a rule and a set of parameters that allow you to credit the accrued points of the Loyalty Program Member. You can create a process using the template and extend it based on your requirements.
Create a Process Using Debit Points from Member Process Template: The Debit Points from Member process template contains a rule and a set of parameters that allow you to debit points from the points balance of a Loyalty Program Member. You can create a process using the template and extend it based on your requirements.
Create a Process Using Enroll in Promotion Process Template: When you want to enroll your loyalty program members in promotions, especially from an external system, you can use the Enroll in Promotion process template. You can create a process using the template and extend it based on your requirements.
Create a Process Using Get Member Promotions Process Template: To display member promotions in an external application, you can use the Get Member Promotions process template that enables you to list the member promotions as required. You can create a process using the template and extend it based on your requirements.
Create a Process Using Issue Voucher Process Template: The Issue Voucher process template contains a rule and a set of parameters that allow you to issue vouchers to your loyalty program members and contacts. You can create a process using the template and extend it based on your requirements.
Create a Process Using Unenroll Member Process Template: The Unenroll Member process template contains a set of rules and parameters that allow you to inactivate the member status in the loyalty program member record. You can create a process using the template and extend it based on your requirements.
Create a Process Using the Update Member Details Process Template: The Update Member Details process template contains a set of rules and parameters that allow you to update member details on Loyalty Program Member and Contact records. You can create a process using the template and extend it based on your requirements. You can use the template to create multiple processes if you want to update member details based on different business scenarios.
360-Degree View of Your Customers: Salesforce Foundations comes with integrated applications, the ability to unify your customer data, and dashboards that provide a comprehensive view of customer interactions. So every employee gets a full picture of the customer.
Give Users Access to the Home App: Grant access to the Home app. To streamline navigation, we recommend you also turn on vertical navigation settings.
Data Cloud Considerations for Salesforce Foundations: Data Cloud powers campaign segmentation and unified customer profiles for marketing and commerce use cases in Salesforce Foundations. With Data Cloud, users can take advantage of flexible consent data tools and create audiences for order confirmation emails and marketing messages.
Marketing Considerations: Marketing for Salesforce Foundations gives you access to tools that help you collect, track, and store consent data.
Service Console Considerations: Service console is the app where customer service reps and supervisors work. Service Cloud comes with different versions of the service console.
Setup Considerations: When planning your Salesforce Foundations implementation, you have the flexibility to choose which features to turn on, whether it's the entire suite or a tailored subset.
User Interface Settings Considerations: There are important permission and navigation considerations related to enabling Quick Settings and vertical navigation.
Elevating Your CRM Experience with Foundational Features: Salesforce Foundations equips you with essential sales, service, marketing, and commerce capabilities, over a CRM foundation that’s powered by Data Cloud. This suite is seamlessly built into your preexisting CRM, providing you with new capabilities and a 360-degree view of your customers—all at no extra cost.
Simplified Navigation and Easy Access to Important Tasks: Salesforce Foundations navigation makes it simpler and faster to find the information and tasks you need. It’s important that you understand some key differences between standard Salesforce navigation and Salesforce Foundations navigation.
Supported Editions for Salesforce Foundations: Salesforce Foundations is included in supported editions of select Salesforce Clouds. This topic provides information about the editions and Clouds that support Foundations.
New Home Experience with the Home App: The Home app provides a visually friendly, uncluttered experience that helps you focus on the tasks that are most important to you.
Permission Set Groups for Salesforce Foundations: Give users access to Service Cloud, Marketing Cloud, Commerce Cloud, and Data Cloud for Salesforce Foundations. To save you time on permission assignment, Salesforce Foundations comes with standard permission set groups. These permission set groups are made up of standard permission sets that grant users access to common features and functionality based on user jobs. If you prefer permission sets for user management, assign the standard permission sets instead. To grant users access to other foundational features, review the corresponding Salesforce documentation.
Managing Your Salesforce Foundations Compliance: If you’re using Salesforce Foundations, you’re responsible for your Health Insurance Portability and Accountability Act (HIPAA) compliance. Manage your compliance by enabling only HIPAA-ready Salesforce features and implementing them securely.
Salesforce Foundations Standard Permission Set Groups: Salesforce Foundations comes with standard permission set groups that bundle standard permission sets by user jobs for faster and easier user management. If you enable Quick Settings, assign these standard permission set groups from the user management window. If you don’t enable Quick Settings, assign them from the permission set group page in Setup.
Salesforce Foundations Standard Permission Sets: Salesforce Foundations comes with standard permission sets that grant users access to apps and common permissions for features. Assign these permission sets from the permission set or user detail page in Setup. For faster assignment, use the standard permission set groups.
Turn On Quick Settings: Easily access important settings such as user management and business details in a few clicks.
Sales for Salesforce Foundations: If you have one of the supported editions, you have the foundational Sales features that come with Salesforce Foundations, and there is no setup. Review user interface and navigation settings that can help your sales teams work more efficiently. To incorporate a lighter, faster way to build emails into your Sales experience, enable Email Builder Lite. To handle billing and invoicing directly in Salesforce, turn on Invoice Management. If you upgraded from Starter or Pro Suite to another edition, you keep foundational Sales features and previous permission set group assignments.
Salesforce Foundations Setup: Save time and effort with the Salesforce Foundations setup page, your primary setup experience powered by Salesforce Go. After you review the considerations, turn on foundational features from a single page and manage feature and app availability. Your Salesforce Foundations license unlocks the entire page.
Implement Salesforce Foundations: After you’ve reviewed the considerations and determined which foundational features to add, you’re ready to set up the suite experience. Turn on user interface and navigation settings, assign permissions to users, and set up features across Sales Cloud, Service Cloud, Marketing Cloud, Commerce Cloud, and Data Cloud.
Set Up Service for Salesforce Foundations: Assign the General User or Service User permission set group. These permission set groups grant users access to features like the Foundations Service Console.
What Makes Salesforce Foundations Special: Salesforce Foundations provides a 360-degree view of your customer relationships across sales, service, marketing, and commerce through integrated applications and unified data. It also boosts productivity with streamlined, visually friendly user interface improvements, that you can turn on or off per your requirements.
User Interface and Navigation Enhancements: Learn how to turn on the user interface features that come with Salesforce Foundations. Boost your productivity with simplified navigation and manage app visibility for your users.
Turn On the Vertical Navigation Bar: Get to your favorite apps seamlessly with the vertical navigation bar. After you turn it on, all users can customize the apps included in the navigation bar, open apps without refreshing the page, and access App Launcher from the More button.
Add Topics to Records in Salesforce Classic: Add topics to quickly organize records around common themes, retrieve them in list views, and (with Chatter) view them on topic detail pages.
Add, Remove, and Organize Your Tabs in Salesforce Classic: Salesforce Classic uses tabs as starting points for viewing, adding, and editing information for an object. Different apps can have different sets of tabs. Add tabs for items you use frequently in any app.
App Switching in Lightning Experience: Use the App Launcher to navigate between your apps. You can easily switch between apps and access other Salesforce items and features.
Update Your Email Notifications in Chatter: Set your preferences for when to be notified via email about Chatter activity. For example, you can choose to not receive a notification when you have a new follower or when someone likes your posts.
Clone Records: Create a record by making a copy of a similar record. When you clone certain records, you can also clone related records.
What’s the Collapsible Sidebar?: The sidebar column that appears on the left side of most Salesforce pages in Salesforce Classic provides convenient access to links and commands.
Create and Update Records: Creating and updating records are standard procedures for most people who use Salesforce. There are various ways to create and update records in Salesforce.
Create Records in Feeds: If your administrator set up this action, you can create records in the feed on the home page, the Chatter tab, and record detail pages. Publishers on different feeds offer different actions.
Create a Record in Lightning Experience: Create Salesforce records for opportunities, leads, tasks, notes, accounts, and contacts. Some objects (such as Account) have special guidelines and considerations for you to be aware of, but the process of creating a record is similar for all.
Create Records with Quick Create: With Quick Create, you can create records from the home pages for leads, accounts, contacts, opportunities, and custom objects.
Update Records: Many Salesforce objects offer the convenience of inline editing for records. Updating custom object records is similar to updating standard object records. Whether you can access and change a custom object record, depends on your permissions.
Filter Your Report: Does your report give you more data than you need? Use filters to pare down your report until it only shows the data that you want.
Find Your Records: To view all standard and custom objects that are available to you in your org, click the plus icon (+). To see the records for a particular object, click the record’s tab.
Verify Your Identity: Use identity verification tools to secure and protect your data from unauthorized access.
What Is Multi-Factor Authentication?: Faced with rising threats like phishing attacks, credential stuffing, and account takeovers, we all want to keep our online accounts and data secure. Multi-factor authentication (MFA) is one of the easiest and most effective ways to do that because it requires multiple pieces of identity evidence each time you log in. MFA is so important, Salesforce requires it for all logins to the user interface.
Register an Identity Verification Method for Salesforce Orgs: Multi-factor authentication (MFA) is required for Salesforce logins. To access your account, you need a registered identity verification method that you provide after entering your username and password. When MFA is turned on, if you haven’t registered a method yet, you’re automatically prompted to do so at login. If you’re already logged in, you can register methods at any time. The registration process creates a connection between the chosen method and your Salesforce account. You can also use a registered verification method if you receive a device activation challenge for an unfamiliar login attempt.
Log In for the First Time: Your welcome email includes your login information and a link to your company’s Salesforce org. Use what’s in the welcome email to log in for the first time.
Set Up Your Chatter Profile: Your Chatter profile describes who you are to your coworkers and any customers you communicate with. It features your photo and basic information like your professional title and contact details.
Tips for New Users: Some tips to help you become a fast, productive Salesforce user on day one.
Usernames and Passwords: In Salesforce, each user is identified with a username, password, and profile. Together with other settings, the profile determines which tasks a user can perform, what data the user can see, and what the user can do with the data.
Why Can’t I See Some Features?: You learn about Salesforce features in our help documentation and training videos. However, sometimes you can’t seem to find or access these features in your Salesforce org.
Improve List View Performance: Develop a list view maintenance strategy and speed up your list views by optimizing their filters.
Explore the Salesforce Setup Menu: Salesforce includes many options for setting up, maintaining, and customizing your organization. If you’re a Salesforce administrator or developer, you use the Setup menu frequently.
Navigate List Views: In a list view, you see only the data that you have access to. You can see records that you own, have read or write access to, or are shared with you. List views also include records owned by or shared with users in roles below you in the hierarchy. The fields you see depend on your page layout and field-level security settings.
Explore Objects: Object home pages show information for your Salesforce objects, like a list of your accounts.
What’s the Difference Between Standard and Custom Objects?: Standard objects, such as accounts, cases, contacts, and opportunities, are included with Salesforce by default. Custom objects are based on standard objects, extend standard functionality, and store information that is unique to an org.
Access to Other Salesforce Apps: Looking for a particular feature? To see all the Salesforce apps that are available to you, check out the app menu or App Launcher.
Organize Your Data: Salesforce stores much of your data, like account information, in individual records, and organizes the data within objects. You can view and update your records and run reports on your data.
Organize Your Day: Stay on top of your meetings, tasks, and sales goals.
Pin List Views in Lightning Experience: Change an object’s default list view with a pinned list. An object’s pinned list loads as its default list view. The default pinned list for all objects is the Recently Viewed list.
Update Your Data: Much of your Salesforce data is stored in individual records, and organized within objects. For example, the Account object presents all of your account records. If the Acme company is one of your accounts, you’ll have an account record for Acme.
Analyze Your Data: Analyze and visualize your data with reports and dashboards. Salesforce offers a powerful suite of reporting tools that work together to help you understand and act on your data.
Run a Report: Reports give you access to the data your organization has accumulated over time, enabling you to make informed decisions.
Troubleshoot Issues With Transferring Your Accounts in Salesforce Authenticator: If you forgot your backup passcode, or you can’t access your verified email address or mobile number, there are still a few ways to reconnect your accounts to Salesforce Authenticator after getting a new device or reinstalling the app.
Transfer Connected Accounts in the Salesforce Authenticator Mobile App: If you back up your Connected Accounts in the Salesforce Authenticator mobile app, you can transfer them to another mobile device. You can also transfer your accounts on the same device if you delete and reinstall the app.
Search List Views in Lightning Experience: Use the list view search box to search for records in a list view. Click the search box or use the keyboard shortcut g+f, and then enter your query. The list view search looks at all searchable fields even if the corresponding columns aren’t shown in the list view.
Search Across Salesforce: Welcome to Einstein Search, on by default in Lightning Experience. Einstein Search boosts productivity right from the global search box. Get search results that are more actionable and tailored to how you work in Salesforce. Whether you’re searching for records, knowledge articles, or across Chatter feeds, Einstein Search gets you the right information.
Search for Records in Salesforce Classic: If enabled, use global search, at the top of every page, to search across Salesforce. From here you can find any searchable object by simply typing your search term in the search bar. Search shows only those records you have access to
Search for Records in Lightning Experience: To find a record, use global search at the top of the page. Filter and sort your search results and scan the record previews and related quick links to find what you need fast. You can also complete tasks right from the results.
Concepts, Products, and Services: As you get started with Salesforce, it’s helpful to learn some key concepts and terms. They come up frequently when you interact with the product, our documentation, and our service professionals. The concepts and terms here help you understand how Salesforce works.
Sort List Views: A list view is a filtered list of one object’s records, but even after filtering, there are sometimes so many records in the list that it’s a challenge to find what you need. To understand and navigate your records more easily, apply sorting to your list views. You can sort any list view by 1 field column, and in Lightning Experience, you can sort a list view by up to 5 columns. Sorting is alphanumeric.
Organize Records with Tags and Topics: Topics are words or phrases that you can associate with Salesforce records to organize them around common themes. Tags are words or short phrases that you can associate with most Salesforce records to describe and organize their data in a personalized way.
The Salesforce Admin: The Salesforce administrator—or “admin” is a Salesforce user with system administration duties and other super powers. Admins are responsible for setting up Salesforce for their organizations and making sure it runs smoothly.
Work with List Views in Lightning Experience: View, edit, and create records from a list. List views are a great way to sort, prioritize, and analyze the records that are most important to you.
Work with Related Lists on Records in Salesforce Classic: On Salesforce records, links and details for associated records are grouped within related lists. Some related lists let you perform common tasks for the related object, like create records or attach files.
Work with Related Lists on Records in Lightning Experience: Records in Salesforce include details and links to other related records. With some related lists, you can perform common tasks for the related object, like create records, or attach files.
Work with Related Lists: Records include details and links to other related records. View and perform actions on these related records with related lists.
Get Started with Salesforce: Welcome to Salesforce, the award-winning cloud computing service designed to help you manage your customer relationships, integrate with other systems, and build your own applications! Here are some key concepts to help you understand the Salesforce products and editions and guide you through common tasks in Salesforce.
Benefit Actions: Benefit Actions are actions that can be triggered for a benefit. Benefit Actions are executed when a benefit is assigned to a member. For example, when a member is upgraded from Silver to Gold tier, the member gets priority support as an entitlement. This benefit requires a downstream action to create a priority service entitlement record in the Service Cloud. The record is created in the Service Cloud through benefit actions. The benefit action is executed to create the Priority Support Entitlement record when the Priority Support benefit is assigned to the member.
Create Benefit Actions Using the Templates Provided: Use the prebuilt templates included to create Benefit Actions for common scenarios. You can also use the templates as a reference for setting up custom Benefit Actions.
Assign Dynamic Benefits to Members: Use dynamic benefits to reward members based on the members' level of engagement with their loyalty program regardless of their current tier. For example, Early Access to Level X shoes is a benefit that is given to members who have completed a survey.
Contact Salesforce: Help for this feature is currently not available. Please contact Salesforce for assistance.
Billing Type Options for Partners: While creating a Loyalty Program Partner record, you can specify the billing type—Prepaid or Postpaid—for your partner.
Activate a Theme: To customize your users’ visual experience, activate a theme that reflects your brand. Activate a custom theme that celebrates your brand identity, or use a built-in theme with preset color palettes and images. Either way, a theme elevates your Salesforce org and enhances the user experience.
Create a Custom Theme: To define your brand’s unique identity within Salesforce, create a custom theme. As an admin, you can specify your custom theme’s color palette, and upload your company logo and your own background images. Use a custom theme to rally your team around important initiatives, like a campaign or new product launch. Or you can make sure that your team’s work fits seamlessly into the rest of your company's environment.
Manage Custom Configurations for Themes: Customize your org’s theme with clicks, not code. To personalize your users’ Salesforce experience, add your company’s logo, define your brand colors, and more. Most customizations are available only for custom themes. Some customizations are available only if you built your theme on a specific version of the Salesforce Lightning Design System (SLDS).
Personalize Your Org with Themes and Branding: A theme is a collection of visual styles that defines the look and feel of a user interface, and it sets the tone for your users’ Salesforce experience. You can choose one of the built-in Salesforce themes, or create your own custom theme that reflects your brand with just a few clicks.
Allow Experience Cloud App Users to Initiate Deletion of Their Data: The App Store Review Guideline 5.1.1 (v) requires that all apps must allow users to initiate deletion of their account from within the app. Apple can remove your app from its App Store if your app doesn't meet this requirement.
Update Test User Credentials: Google reviews apps by logging in as a user to check the functionality. Update the test user credentials in your Google Play Console account to avoid any app rejections.
Urge or Require Users to Update to the Latest Mobile Publisher App Version: For publicly distributed Mobile Publisher for Experience Cloud apps, you can use the App Version Update settings in Experience Builder to configure a message that encourages or requires your app users to install updates. By updating their app, users can avoid any service disruptions.
Enable Advanced Authentication for a Mobile Publisher App: Advanced Authentication (browser-based authentication) allows authentication from an in-app browser instead of an in-app webview. Enable Advanced Authentication in Setup.
Create a Registration Handler: A registration handler is an Apex class that handles the heavy lifting of creating Salesforce users, updating users, and linking to existing users, accounts, and contacts.
Sign in with Apple for Third-Party Login Services: If you plan to offer third-party login services to authenticate a user’s primary account, you must also offer Sign in with Apple as a login option.
Testing: This information helps you troubleshoot when testing Mobile Publisher apps.
Request a Binary of Your App: Google and Apple provide programs that give your organization the ability to thoroughly test your Android and iOS apps before publishing them.
Test the Beta Version of Your App: Install the beta version of your app and see how your company’s branded assets look on a mobile device.
Enable Biometric ID App Unlock for iOS and Android: When using Mobile Publisher, you can apply biometric ID credentials to make your environment more secure. To use biometric ID credentials, your device must have a device passcode or PIN enabled and FaceID (for iOS) or Android Security and Privacy | Biometrics.
Set Time Value for Biometric Login: By default, users must reenter biometric ID credentials when the app is in the background for more than 15 minutes. You can set your own time value requirement by adding a custom attribute.
Build Your Branded App: Create a Mobile Publisher project, enter details about your app, and upload your custom branded assets to Salesforce.
Configure App Navigation: Users can navigate your branded mobile Experience Cloud app through various methods, depending on how you configure app navigation.
Enable Full Content Push Notifications for Experience Cloud App: Full content push notifications are alerts that appear on a mobile device when users have your app installed, but aren’t actively using it. These alerts can consist of text, icons, and sounds, depending on the device type.
Get Started: Learn everything from how the Mobile Publisher program works from start to finish, what information you need to gather to distribute your app to your users, and what assets you need to create your branded app.
Access the Mobile Device Calendar: Create a calendar import feature to manage events from one location, use preferred calendar apps, and save time from manually maintaining events or meetings in separate calendars.
Implement a Contact Import Feature: Create a customized contact import feature, create or update records with contact data, or otherwise reduce the friction of adding contact information from a mobile device.
Configure Your App's Orientation: Choose which orientations to support in your Mobile Publisher for Experience Cloud app. You can also opt in to support users who want to experience your branded Experience Cloud app on an iPad.
Implement and Use Location-Based Features: Show the current position on a map, provide directions, save the location when creating or updating a record, and otherwise add location awareness to your branded mobile apps.
Add a Privacy Policy for Binary Uploads: For Android and iOS apps using the Binary Upload distribution method, update your app’s information with a link to the privacy policy.
Manage How URLs Open from Your App: In your app’s Setup for Mobile Publisher project, use the URL Management section to configure how URLs open from your Mobile Publisher for Experience Cloud app.
Set Up a Binary Handoff Project for Experience Cloud Apps: Use the binary handoff distribution method to have Salesforce build your app and provide you with the binary file (.ipa or .aab) for manual signing and distribution. This method is ideal for organizations with security protocols that require in-house code signing or specific internal distribution processes. Use the binary handoff distribution when you’re certain you don’t want to change the distribution method, because you can't change it to fully managed or binary upload.
Enable Cross-Website Tracking (iOS): With iOS 14, Apple placed additional tracking restrictions on third-party applications. These tracking restrictions can prevent your custom web content from appearing in your branded app.
Change Distribution Account: You may have to change your distribution account if you need to change the developer account associated with your distribution type.
App Distribution Type Considerations: Choose the right distribution type based on your use case and Apple and Google guidelines. As an app developer, Salesforce complies with Apple and Google distribution guidelines, and violating the guidelines can cause Apple or Google to reject your branded app.
Set Up Private Distribution: You manage distribution of your branded app through your developer account privately. Your branded app is only accessible to your end users privately, and isn’t publicly available on the Apple App Store or Google Play.
Unlisted Option for iOS App Distribution: Learn about unlisted app distribution, an alternative to the traditional public and private app distribution options. Unlisted app distribution is sometimes appropriate for apps that were rejected from App Store public distribution.
Salesforce Managed Distribution: Salesforce manages distribution of the customer branded app via our developer account either publicly or privately.
Salesforce Managed Private Distribution: Salesforce manages distribution of the customer branded app via our developer account privately. The branded app is only accessible to the customer's end users privately, and isn’t publicly available on the App Store or Google Play.
Plan Your App Distribution: Before you set up your branded app, decide how Salesforce manages the release process and who your app is available to. These two decisions (your distribution method and your distribution type) shape every step of your setup.
Set Up a New External Client App (ECA) in Mobile Publisher: Start setting up an external client app (ECA) for your mobile app after completing the Set Up the Mobile App step in Mobile Publisher. Don’t create your external client app in the External Client App manager (accessed through Setup). Create your ECA in Mobile Publisher instead.
Migrating Connected Apps to External Client Apps: The Mobile Publisher platform is transitioning from using Connected Apps (CA) to External Client Apps (ECA). This migration reduces manual effort and bottlenecks associated with creating and managing Connected Apps.
Update Test User Credentials: Google reviews apps by logging in as a user to check the functionality. Update the test user credentials in your Google Play Console account to avoid any app rejections. This step applies to public distribution only.
Enable Mandatory Biometric ID App Unlock for iOS and Android: When using Mobile Publisher, you can apply biometric ID credentials to make your environment more secure. To use biometric ID credentials, your device must have a device passcode or PIN enabled and FaceID (for iOS) or Android Security and Privacy | Biometrics.
Set Time Value for Biometric Login: By default, users must reenter biometric ID credentials when the app is in the background for more than 15 minutes. You can set your own time value requirement by adding a custom attribute. The value that you set applies to both User Opt-In Biometric Login (beta) and Biometric ID App Unlock.
Biometric Login: Set up biometric login so that your users can log in to your Mobile Publisher for Experience Cloud app using face or fingerprint recognition. Enable User Opt-In Biometric Login (beta) to give your users the choice of logging in with biometric credentials instead of their username and password. Enable mandatory Biometric ID App Unlock to require users to log in with biometric credentials.
Mobile Publisher for Experience Cloud: Use Mobile Publisher to create a customized and branded Experience Cloud mobile app. When your users can identify the app with your brand, they’re more likely to use it, which increases adoption.
How to Check Your Experience Cloud Site URL: It’s important to know if your Experience Cloud Site URL contains /s at the end the URL. The Mobile Publisher team can build a better app for your org with this information.
Enable Cross-Website Tracking (iOS): With iOS 14, Apple placed additional tracking restrictions on third-party applications. These tracking restrictions can prevent your custom web content from appearing in your branded app.
Set Up URL Schemes: You can specify URL schemes for other apps and send users to external content inside the Mobile Publisher app.
Deep Linking: Deep linking directs users to open a specific page in a mobile app from a different app, such as a browser app, mail app, or any other app.
Set Up Distribution for Android: Prepare your branded app for distribution on Google Play. You can distribute the app either publicly on the public Google Play Store or privately through Managed Google Play to users within your organization.
Change Distribution Account: You may have to change your distribution account if you need to change the developer account associated with your distribution type.
App Distribution Type Considerations: Choose the right distribution type based on your use case and Apple and Google guidelines. As an app developer, Salesforce complies with Apple and Google distribution guidelines, and violating the guidelines can cause Apple or Google to reject your branded app.
Unlisted Option for iOS App Distribution: Learn about unlisted app distribution, an alternative to the traditional public and private app distribution options. Unlisted app distribution is sometimes appropriate for apps that were rejected from App Store public distribution.
Set Up Distribution for iOS: Prepare your branded app for distribution on the Apple App Store, either publicly to all users or privately through Apple Business Manager to users within your organization.
Enhanced Mobile App Security for Mobile Publisher: With Enhanced Mobile App Security, you can customize how your Mobile Publisher for Experience Cloud app responds to security threats. Specify which security threats your app detects, and configure the severity level for how your app automatically responds when threats are detected.
Set Up Enhanced Mobile App Security for Mobile Publisher: Enable Enhanced Mobile App Security in Setup for Mobile Publisher, configure security policies in Mobile Security, and assign the Enhanced Mobile App Security configuration to app users.
Mobile Publisher Best Practices for App Content Declarations: After you create a placeholder app, you complete Google Play’s required App Content declarations to publish your Android app. When you publish a Mobile Publisher Android app, follow best practices specific to Mobile Publisher for the Privacy policy, App access, Data safety, and Financial features declarations.
Find Your Managed Google Play Organization Info: To distribute your branded app privately, Mobile Publisher needs your Managed Google Play Organization info. This step applies to private distribution only.
Register Your Firebase App for Mobile Publisher Android Push Notifications: To set up push notifications for your Android app, provide Mobile Publisher with information from a Google Firebase project associated with your app. To get the required information, register your Android app and generate a private key. Then, submit the information to your app’s Setup for Mobile Publisher project.
Update Test User Credentials for Public Distribution: For public distribution, update the test user credentials in your App Store Connect account to avoid app rejections. For private distribution, this step was completed during the Create a Placeholder App step.
User Opt-In Biometric Login: With User Opt-In Biometric Login, your Mobile Publisher for Experience Cloud app users can easily and securely log in to your app using face or fingerprint recognition.
Enable User Opt-In Biometric Login: To enable and configure User Opt-In Biometric Login, enter custom attributes to your Mobile Publisher for Experience Cloud app’s external client app.
Push Notifications: Keep your users in the know with timely notifications sent to their mobile devices. Create custom push notifications using Notification Builder or use Marketing Cloud Engagement tools like Automation Studio or Journey Builder.
Temporarily Remove Mobile Publisher Apps from Sale: When an app has been delisted or temporarily removed from sale, current users aren’t affected. However, new users can’t search or download the delisted app.
Test with the UI Test Automation Model (UTAM) for Your App: Testing is paramount in getting your Mobile Publisher apps working as intended. Salesforce already uses UTAM to speed up UI testing, and we want you to have the tools available to thoroughly test your apps.
Request App Ratings and Reviews: Create an app review feature to prompt users to rate and submit reviews of your app to the app stores (Apple and Google). An app review feature lets you ask your users for feedback on their experience using your app. Their feedback can help improve your app experience, encourage downloads, and improve your app’s discoverability.
Mobile Publisher Best Practices for App Content Declarations: After you create a placeholder app, you complete Google Play’s required App Content declarations to publish your Android app. When you publish a Mobile Publisher Android app, follow best practices specific to Mobile Publisher for the Privacy policy, App access, Data safety, and Financial features declarations.
Choose Distribution Type: Start the public distribution process by selecting your distribution type.
Register Your Firebase App to Enable Mobile Publisher Android Push Notifications: To set up push notifications for your Android app, provide Mobile Publisher with information from a Google Firebase project associated with your app. To get the required information, register your Android app and generate a private key. Then, submit the information to your app’s Setup for Mobile Publisher project.
Register Your Firebase App to Enable Mobile Publisher Android Push Notifications: To set up push notifications for your Android app, provide Mobile Publisher with information from a Google Firebase project associated with your app. To get the required information, register your Android app and generate a private key. Then, submit the information to your app’s Setup for Mobile Publisher project.
Update Test User Credentials: Update the test user credentials in your App Store Connect account to avoid app rejections.
Mobile Publisher Best Practices for App Content Declarations: After you create a placeholder app, you complete Google Play’s required App Content declarations to publish your Android app. When you publish a Mobile Publisher Android app, follow best practices specific to Mobile Publisher for the Privacy policy, App access, Data safety, and Financial features declarations.
Government Cloud Considerations: This section covers guidance specific to Government Cloud customers. Because these apps use the legacy connected apps framework, some procedures for building and maintaining your app will differ from the standard process.
Create and Publish an App by Using Mobile Publisher for Experience Cloud: To publish an app using Mobile Publisher for Experience Cloud, sign up for the Mobile Publisher program and create developer accounts with the app platforms where you plan to distribute. Select the Experience Cloud site you want to turn into an app, and then build your app and package it for distribution. Test your app thoroughly before distribution.
Add a Smart App Banner: Create a smart app banner that shows your branded Experience Cloud app when users visit your Experience Cloud site in a mobile browser.
Limitations for Mobile Publisher for Experience Cloud LWR Sites: Experience Cloud sites are built on one of two frameworks—Lightning Web Runtime (LWR) or Aura. Each framework supports specific templates. Mobile Publisher for Experience Cloud supports all Aura templates and the Build Your Own (BYO) LWR template. Some limitations apply only to apps created from LWR sites. If your users need features that aren’t available with the BYO LWR template, use a site built with an Aura template instead.
About Managed Packages: A managed package is a container that includes the components of a Salesforce application, and it’s a mechanism for installing apps in Salesforce orgs.
Test Marketing Cloud Engagement Push Notifications: Test Engagement push notifications by sending them to your branded Mobile Publisher app. You can specify different configurations for production and sandbox. After you set up MobilePush in Engagement, you can enable Engagement push notifications for your Mobile Publisher apps.
Set Up the Navigation Tab Bar: In your branded Experience Cloud mobile app, the navigation tab bar is fixed at the bottom of the screen, with two pre-configured tabs: Home and User Settings. Customize the navigation tab bar by adding more tabs, and adjust the look and feel of the tabs to match your branding. And if you don't want the navigation tab bar, you can disable it.
Override Android App Links to Your Mobile Publisher App: Mobile Publisher for Experience Cloud apps support app links on Android. By default, when a user taps an app link to your Mobile Publisher app, the link opens to the page inside your app. To override the default behavior and set certain links to open outside of your app, use an Apex class and a Visualforce page. For example, if you want the link to your app’s registration page to open in a web browser.
Override iOS Universal Links to Your Mobile Publisher App: Mobile Publisher for Experience Cloud apps support universal links on iOS. By default, when a user taps a universal link to your Mobile Publisher app, the link opens to the page inside your app. To override the default behavior and set certain links to open outside of your app, use an Apex class and a Visualforce page. For example, if you want the link to your app’s registration page to open in a web browser.
App Permissions for Device Capabilities: If your app has features that need access to mobile device capabilities, your app users must explicitly grant access to these capabilities. For example, if your app supports taking photos, then your app must ask for camera permissions. Set up the permissions that your app needs in your Mobile Publisher project.
App Permissions on Android Devices: Learn the in-app user experience for Android devices when your app requests permission to a device capability.
Preview Your Mobile Experience Cloud Site with Publisher Playground (Beta): The Publisher Playground app is a non-branded version of the Mobile Publisher for Experience Cloud app. This app lets you quickly preview and evaluate the in-app experience of your Experience Cloud sites before you purchase any Mobile Publisher licenses.
Playground App for Android: There are some additional steps to get the app installed and set up for testing on Android.
Get Started with the Playground App: Before you can preview the in-app experience of your mobile Experience Cloud sites, you must download and install a managed package.
Playground App for iOS: There are some additional steps to get the app installed and set up for testing on iOS.
Show or Hide Login Bar: The Publisher Playground app lets you show a login bar so you can see when a login page is loaded within a webview. When the login into an Experience Cloud site is successful, the login bar automatically disappears.
Test How URLs Open in the Playground Publisher App: In the Playground Publisher app, use the URL Management section to test the URL management settings for your Mobile Publisher for Experience Cloud app. Use the export from the Playground Publisher app to enter your URL management settings in Setup for Mobile Publisher.
Set Policy Configurations for External Client Apps in Mobile Publisher: Policy configurations for your external client apps include lock screen policies, OAuth policies, and any custom attributes you want to add to your app. Policy configurations apply to the deployed version of the ECA. You can change policy configurations without creating a new ECA version.
Prepare Your App’s Information: Preparing your branded assets is an important part of the process of creating a Mobile Publisher for Experience Cloud app. Let’s discuss some of the branding details so you can get started with your Mobile Publisher project.
Push Notifications: Keep your users in the know with timely notifications sent to their mobile devices. Create custom push notifications using Notification Builder or use Marketing Cloud Engagement tools like Automation Studio or Journey Builder.
Marketing Cloud Engagement Push Notifications: Mobile Publisher uses the power of the Marketing Cloud Engagement tools Automation Studio and Journey Builder to send geolocation aware and rich media push notifications to your branded mobile app users.
Submit the App for Approval: After testing of the beta version of your app is complete, the next step is to submit the app to the application stores for approval.
Temporarily Remove Mobile Publisher Apps from Sale: When an app has been delisted or temporarily removed from sale, current users aren’t affected. However, new users can’t search or download the delisted app.
Test and Submit the App: Request a binary and submit for your branded app to the application stores for approval.
Test with the UI Test Automation Model (UTAM) for Your App: Testing is paramount in getting your Mobile Publisher apps working as intended. Salesforce already uses UTAM to speed up UI testing, and we want you to have the tools available to thoroughly test your apps.
Set Up a New External Client App (ECA) in Mobile Publisher: Start setting up an external client app (ECA) for your mobile app after completing the Set Up the Mobile App step in Mobile Publisher. Don’t create your external client app in the External Client App manager (accessed through Setup). Create your ECA in Mobile Publisher instead.
Briefcase Creation: Learn how to create and customize a briefcase for your mobile workforce.
Limits and Considerations: As you create and work with offline briefcases, note these considerations and limits.
Validate Briefcase Settings: Check the Run As User option on a briefcase to review how many records it generates so you can validate filtering criteria and briefcase assignments.
Briefcase Builder: Your mobile workforce can access information seamlessly while they’re offline. You can use Briefcase Builder to create a briefcase, a set of rules and filters that select records to prime for offline use. Design a mobile app that connects with a briefcase to give your users access to the most relevant records, even when there’s a network outage, spotty internet coverage, or an area without Wi-Fi.
Build a Flow to Move Your Data: Set up the triggers and actions that move data between Salesforce Suites and your connected external app.
Bulk Move Reports or Dashboards with Metadata API: You can move reports or dashboards between folders and subfolders in Lightning Experience. If you want to move reports or dashboards in bulk, use Metadata API.
Bypass Automations During Policy Execution: Allow a privacy policy to bypass automations, such as triggers and validation rules. If certain targeted records are subject to value restrictions or used to trigger flows, errors can occur during policy execution. Bypassing automations reduces these job errors and avoids further changes caused by record-triggered flows.
Actionable Telematics Framework for Connected Assets: The actionable event orchestration framework empowers companies to build sophisticated orchestrations for processing event data generated from assets and take actions in Salesforce. Design orchestration processes that respond to key asset events, such as sensor faults, high ambient temperatures, and battery failures, by setting rules and conditions. After the asset sends the event data, the framework determines the orchestration process to execute. Use these orchestrations to create and update records, including work orders, asset milestones, cases, milestones, and record alerts. Service teams monitor these records in real time and take the required actions, such as offering assistance to customers and performing on-site services.
Actionable Telematics Event Business API and Platform Events: Different methods are available to bring asset events into Salesforce and execute actions on the event. Use the Actionable Orchestration Source Event platform event to publish events or use the Orchestration Inbound Events business API to trigger events. The platform event and the business API can be easily integrated with any external system, such as telematics provider systems.
Context Definitions for Actionable Event Orchestrations for Connected Assets: When an event is triggered in an asset, the event details are sent to Actionable Event Management via the Inbound Event API or the Actionable Orchestration Source Event platform event. The event's request payload contains the event's details. Create a context definition to represent the structure of an event's request payload. Then, use the context definition to supply the required event data to the execution procedure that perform the actions for the event. The nodes and attributes of the context definition must match the event attributes in the API payload. For example, if the request payload contains parameters for asset identifier, output power, health score, and activation status for a sensor error event, create a context definition with nodes that map to these parameters.
Create an Actionable Event Orchestration for Connected Assets: An actionable event orchestration outlines the actions to be taken for events of a specific type and subtype. For example, some actionable event orchestrations are triggered for events of the Asset Health type and the Low Battery Level subtype. Create an actionable event orchestration for a specific event type and subtype, and specify the execution procedure to be launched to perform operations for an event. Specify a context definition and mapping to define the event data that can be used in the execution procedure.
Filter and Match Actionable Event Orchestrations Decision Table for Connected Assets: The Filter and Match Actionable Event Orchestrations decision table matches an event that’s sent to Salesforce from an external system to the corresponding Actionable Event Orchestration record. Each event sent to Salesforce has a type and can also have a subtype and a category. Based on the type, subtype, and category of an event, the decision table provides a context definition, a context mapping, and an execution procedure for the event. For example, if an actionable event orchestration is defined for an Environmental Condition type and High Ambient Temperature subtype, the decision table automatically matches each event of that type and subtype to the corresponding execution procedure.
Set Up Flow-Based Orchestrations for Connected Assets: Effortlessly save orchestration records as templates and directly apply expression set templates or flow templates as execution procedures for actionable event orchestrations. Additionally, templates come with related configurations—such as context definitions and flows—enabling seamless automation of key business processes such as asset registration and service appointment scheduling.
Create an Execution Procedure for Actionable Events for Connected Assets: An execution procedure outlines the set of actions to be performed for an asset event. For example, an execution procedure for an Overheating Asset event can create a Case record, an Asset Milestone of type Critical Recall, and a record alert of the type Error. Use expression sets or flows as execution procedures. Using the standard and custom elements in the expression set builder, users create a series of filters, calculation conditions, aggregation conditions, and eligibility parameters to define the type of action for a specific event. Using the elements in a Flow Builder and custom Apex actions, users can create complex business rules to trigger actions.
Create Asset Entitlement Records Flow: The Create Asset Entitlement Records flow creates Entitlement records for a given asset for an Asset Registration Event. It attempts to create two entitlement records for each event, one of the type Web Support and one of the type Phone Support, both using the same Entitlement Name passed in from the Create Records for Asset Registration flow.
Create Asset Milestone Records Flow: The Create Asset Milestone Records flow creates an Asset Milestone record for a given asset in an Asset Registration Event. Before creating, it checks whether a milestone with the same name, date, type, stage, and usage type already exists for the asset. If a duplicate record exists, no new record is created and the failure is recorded.
Create Asset Warranty Records Flow: The Create Asset Warranty Records flow creates Asset Warranty records for a given asset, and optionally its child assets, for an Asset Registration Event. It goes through the asset hierarchy up to a configurable depth and finds the applicable Product Warranty Terms, checks for existing warranties to avoid duplicates, and creates the new records in bulk in a single operation.
Create Records For Asset Registration Event: The Create Records for Asset Registration Event flow automates the post-registration lifecycle of an asset. This flow retrieves data from the AssetRegistrationCreateRecordDetails__stdctx context definition and its related mapping to identify the registered asset. It uses three subflows in sequence to create Entitlement, Asset Milestone, and Asset Warranty records associated with that asset. The flow then generates a formatted summary and sends an email to the designated recipient with the results.
Schedule Service Appointments for Actionable Events Orchestration: The Schedule Service Appointments for Actionable Events flow automates the scheduling of Service Appointments when an Actionable Event, such as a diagnostic fault or a maintenance alert, is triggered by a connected asset. This flow uses the FaultEventScheduleAppointmentDetails__stdctx context definition to extract the event data, the asset identifier, and the event's geographic location, before locating the nearest service territories based on the geographic proximity. It then invokes an orchestration action to book the service appointment.
Update Records For Asset Registration Event: The Update Records for Asset Registration Event flow automatically processes incoming Asset Registration Events in your org. Use the flow to automatically update fields of Asset Milestone, Entitlement and Asset Warranty records based on the information passed through the AssetRegistrationUpdateRecordDetails__stdctx context definition. This flow identifies the relevant Asset record through the matching Asset ID or Serial Number and uses the associated context data to update associated records.
Actionable Event Orchestration Setup for Connected Assets: Act on telematics data from assets by designing orchestration processes that perform a set of actions for different events, such as route deviation, temperature monitoring, battery status, and sensor issues. Create actionable event types and subtypes to categorize events. Set up an actionable event orchestration to define the type of actions to be performed for events with a specific type and subtype. Design execution procedures to specify the set of actions for an actionable event orchestration. Use a context definition with an actionable event orchestration to define the event data that can be used in the execution procedure.
Create Actionable Event Types and Subtypes for Connected Assets: To categorize internal and external events for assets, define types and subtypes. Based on an event's type and subtype, an orchestration process is triggered to perform a particular set of actions. For example, Technical Faults can be an event type with multiple subtypes such as Sensor Failure, Battery Issue, or Inadequate Input Power.
Actionable Event Orchestration Setup Workflow for Connected Assets: Enable connected services and related features for assets in Salesforce, and assign the required permissions to users. Work with your integrations team to connect your telematics provider with Salesforce via MuleSoft or any other service of your choice. Get access to usage-based entitlements for each connected asset. Set up actionable event orchestration. Set up eligibility rules for service processes to control which users can perform an action.
Key Components of Actionable Event Orchestration for Connected Assets: Set up a touchless process that identifies key events based on information shared from an asset, applies qualification and eligibility conditions on the event data, and performs actions in Salesforce, such as creating records.
View the Asset Health Score on a Mobile Device: The Asset Health Score dashboard uses CRM Analytics to provide an overview on the health of your assets. Mobile workers can use the asset health score to assess the asset’s performance and identify and prioritize which assets should be addressed first.
Connected Assets: Transform asset operations with real-time IoT intelligence. Automate responses to critical asset events, eliminate manual workflows, and make data-driven service decisions that maximize asset uptime and lifetime value across industries.
Data Cloud Metrics Visualization for Connected Assets: Analyze patterns and identify trends on asset operations and health by helping teams visualize the asset data stored in Data Cloud. Use predefined Flexcards to configure the data source and visualization properties based on your implementation of Data Cloud and your business needs. Add the flexcards to the required record pages and specify the properties using the Lightning App Builder.
Asset Management Starter Data Kit for Connected Assets: Get a head start in your Data Cloud implementation for Connected Assets by installing the Asset Management Starter data kit. The data kit includes preconfigured data streams and calculated insights that help you unify and analyze data related to asset revenue and services. Install the data kit in your org, deploy the data streams, and activate the calculated insights.
Connected Assets Data Model Objects: Model and store information on asset operations, operator behavior, types of faults, and other asset data in Data Cloud by using data model objects (DMOs). The Salesforce Standard Data Model SSOT package contains asset telematics data model objects that companies use to store data for assets. Use the asset data for segmentation, activation, analytics, or any other operation in Data Cloud.
Ingestion of Connected Assets Data into Data Cloud: To ingest asset data into Data Cloud, connect your external data sources to Data Cloud. For example, you can bring in data from your telematics providers to proactively asset performance and analyze asset operator performance. You can also bring in data from telematics provider systems, diagnostics systems, and systems that store sensor, machine, and production line operations data.
Set Up Data Cloud for Connected Assets: Complete the basic setup required to model, store, and use asset data in Data Cloud. You must set up Data Cloud, enable the required features, connect Data Cloud to your Salesforce CRM org, and configure the security permissions.
Connected Assets Editions: Review the supported products and editions for Connected Assets features.
Data Cloud Experiences for Connected Assets: Connect, unify, and analyze the data for your connected assets at scale by using Data Cloud. Harmonize, query, and segment asset usage and operations data in a standard data model. Ingest asset operations data from different systems such as telematics providers. Analyze multidimensional metrics for assets, such as asset lifetime value, asset case load, and critical events. Get your Data Cloud implementation up and running by installing the Asset Management Starter data kit. Visualize data that's stored in Data Cloud to improve asset uptime and identify potential faults.
Activate a Telemetry Definition Version: A telemetry definition version is created in inactive status. Activate a telemetry definition version to create telemetry action definitions.
Service Process Generation for Telemetry Action Definitions: Generate a service process from a telemetry action definition record. Review the changes to be made for the Omniscript-based intake form, update the predefined integration definition and activate the generated service process. Create a catalog and category on Unified Catalog for the service process to launch it from the Action Launcher.
Workflow for Telemetry Definition and Action Management: Admins can configure telemetry definitions, telemetry action definitions, steps, and attributes, and generate service processes to launch remote actions for a connected asset. After the service process is generated and set up in Unified Catalog, customer support reps can launch them from the Action Launcher from a record page.
Manage Telemetry Action Definitions: Telemetry action definitions help admins to configure actions based on a specific telemetry definition version. These records capture actions taken on a telemetry signal from a connected asset. These definitions use a Target Component Path to specify which part of the asset to act on, such as turning off an asset's engine to prevent overheating. Actions are carried out through a series of defined steps, each with specific attributes that determine whether the step retrieves information or executes a remote command.
Create Telemetry Action Definition Steps and Add Step Attributes: Create telemetry action definition steps within groups to specify details of the action performed in telemetry action definition for different components. The maximum limit of steps across all groups is 20.
Manage Telemetry Definitions: Admins can use telemetry definitions to create a logical structure of an asset's sensors and actuators. Create and activate telemetry definition records to define telemetry action definitions for executing remote commands.
Telemetry Definition and Action Management: Use telemetry definitions to manage the data from connected assets. These definitions create a logical structure for an asset's sensors and actuators. Enable seamless communication for a connected asset to send data from its sensors and receive commands for its actuators. Configure telemetry action definitions to perform remote operations. Automate service process generation for an efficient customer experience.
Campaign Marketplace for Partners: Offer approved campaigns, campaign resources and signup capability in an Experience Cloud site so that eligible partners can reuse marketing assets and generate demand.
Cancel a Redemption Transaction in Flows: Use the Cancel Redemption Transaction action in flows to revert a redemption transaction and credit points back to a member’s point balance. When you specify the transaction journal ID and cancellation reason, the action picks up the ledgers from the transaction journal and adds another transaction journal entry of the Redemption Cancellation journal type.
Cancel an Accrual Transaction: You can cancel an accrual transaction for various reasons such as a product return, an order cancellation, and when a member requests to cancel an accrual. After you reverse an accrual transaction, the points that were credited to the member for the transaction are debited from the member’s points balance.
Cancel an Accrual Transaction in Flows: Use the Cancel Accrual Transaction action in flows to revert an accrual transaction and deduct points from a member’s point balance. When you specify the transaction journal ID and cancellation reason, the action picks up the ledgers from the transaction journal and adds another transaction journal entry of the Accrual Cancellation journal type.
Cancel a Redemption Transaction: You can reverse a redemption transaction for various reasons, such as a product return, a canceled order, and when a member wants to cancel a redemption. After you reverse a redemption transaction, the points redeemed by the member are credited back to the member.
Change a Member Tier: You can change a member’s tier manually from the loyalty program member list view or record page. These changes happen in real-time mode.
Change Site Association: Change the Experience Cloud site association with your loyalty program using Change Site Association.
Change Your Time Zone: The Trust Status site uses your device’s location, if its location is enabled, to set the local time zone, or you can select a specific time zone.
Start a New Trial: When you sign up for Salesforce, you can choose an industry-specific template with sample data. During your trial period, you can start a new trial with a blank template. To start a new trial abandon your current trial, including all data and customizations. Only usernames are preserved.
Assign Permissions Sets: Give your admins access to Price Protection by assigning a permission set license and permission sets to them. With this license, users can access Price Protection features and objects such as Price Protection Execution Line items, Product Detected Price Changes, and Rebate Claims.
Capture Partner Reported Inventory: Capture inventory reported by partners using Partner Staged Data records. Partners can create these records through the Experience Cloud site, while a Channel Inventory Manager can create them directly in the core system. This allows for efficient tracking and management of partner inventory.
Create Partner Inventory Reconciliations Based on Partner Reported Inventory Data: The Create Partner Inventory Reconciliations data processing engine (DPE) definition creates partner inventory reconciliation and partner inventory item reconciliation records based on valid partner reported inventory in partner staged data records. After you capture partner reported inventory data in the partner staged data object, run this DPE definition to create the reconciliation records.
Design Registration: Allow partners to register designs through the vendor portal, capturing key details for better sales visibility and planning. Enable channel managers to approve design submissions, ensuring fairness and tracking contributions. Simplify the process and increase accountability for partners.
Design Registration Workflow: Understand the complete workflow for design registration, including the roles and responsibilities of Salesforce admins, channel managers, and partners.
Enable Price Protection: Turn on Price Protection in Setup to create price protection programs, define pricing terms and benefits, and process Price Protection claims.
Process Point of Sale Return Transactions for End Customer Returns: Process point of sale return transactions reported by partners when end customers return products. Use the Process Point of Sale Return Transactions for End Customer Returns data processing engine (DPE) to capture return documents, validate return data, identify eligible returns, and update partner unsold inventory and related ledger records.
Reconcile Partner Unsold Inventory and Partner Reported Inventory: Track, process, and reconcile partner-reported inventory to ensure accurate inventory visibility. Use Partner Staged Data to capture inventory, and run data processing engine (DPE) definitions to generate and update reconciliation records based on reported and unsold inventory.
Process Partner and Point-of-Sale Return Transactions: Capture and validate return transactions reported by partners—whether initiated by end customers or through direct partner returns. Automate inventory updates and ledger adjustments using data processing engines (DPEs) to streamline reconciliation and maintain accurate unsold inventory records.
Process Partner Returns Using Return Transactions: Process partner return transactions using the Create Partner Unsold Inventory Records and Create Partner Unsold Inventory Records Based on Eligible Programs data processing engine (DPE) definitions. These DPEs automate the adjustment of partner unsold inventory by debiting inventory quantities when a partner return is recorded. This integration reduces manual effort, ensures accurate channel inventory levels, and improves reconciliation between transaction journals and Partner Unsold Inventory (PUI) records.
Batch Update New Price for Price Protection: The Batch Update New Price for Price Protection flow automates the process of updating the new prices for Price Protection Execution Line Items in bulk to ensure that the latest pricing information is applied consistently across all relevant records, reducing manual effort and potential errors.
Price Protection Claim Calculation using Business Rules Engine: Create a scalable process to calculate Price Protection claim amount per line item using Business Rules Engine. Business Rules Engine is a suite of features that helps you automate complex decision-making.
Price Protection Execution Context Definition: The PriceProtectionExecContext definition allows for the execution of Price Protection rules, ensuring integration between Price Protection Executions (PPE), Price Protection Execution Line Items (PPELI), Price Protection Claims, and Rebate Claims.
Price Protection Data Model: The Price Protection data model includes objects and fields that you can use to store information about your Price Protection operations. The data model is built with industry-wide best practices, and you can adapt and extend the data model to meet your company’s unique needs.
Data Processing Engine Template for Price Protection: Price Protection has a Data Processing Engine (DPE) that helps you transform data that’s available in your Salesforce org and writes back the transformation results as new or updated records. You can transform the data for standard and custom objects using Data Processing Engine definitions. After you set up a Data Processing Engine, you can use a flow to run it. Each run can be tracked using Monitor Workflow Services.
Manage Data Processing Engine Definitions for Price Protection: Clone and use the data processing engine definitions for Price Protection as-is, extend them to meet your business needs, or create definitions from scratch. To use a definition, you must activate it.
View Rebate Claims in Partner Site: Configure and verify access to Price Protection entities within the Salesforce partner portal and enable the display of rebate claims using a customizable record list.
Price Protection: Manage Price Protection programs for partners and distributors to ensure margin stability amid price fluctuations.
Account Account Relationships: Visualize and manage multi-tier partner hierarchies using ARC to support accurate deal mapping in design registration workflows. Enable channel managers to clearly map and associate submitted designs to the correct partner accounts. Support downstream processes like deal approvals, opportunity creation, and incentive tracking by providing a structured view of partner ecosystems.
Upsert Partner Inventory Reconciliation Based on Partner Unsold Inventory Data: The Upsert Partner Inventory Reconciliations Based on Unsold Inventory data processing engine (DPE) definition matches partner unsold inventories with partner inventory reconciliations. It creates and updates partner inventory reconciliations, partner inventory item reconciliations, and partner inventory item reconciliation traceabilities based on unsold inventory details in partner unsold inventory and partner unsold inventory ledgers. For valid partner staged data records used in the process, the status is updated to Processed.
Business Rules Engine: Simplify the process of determining eligibility or qualification and automate complex decision-making to find solutions faster using Business Rules Engine.
Channel Partner Inventory Tracking: Get greater visibility into your channel partner inventory. Effectively track the inventory based on sales to partners and resale from partners to end-customers. Enhance downstream processes such as ship and debit claim processing and price protection. Calculate the partner inventory in the channel by leveraging partner point of sales and sales data.
Channel Revenue Management: Channel Revenue Management is a suite of robust features built on the Salesforce Platform that help your business elevate channel partner engagement, track channel inventory, and drive channel sales with incentives. It's a unified suite that helps you manage channel partner operations, protect margins, report market opportunities, and strengthen partner collaboration and trust.
Common Capabilities in Channel Revenue Management: Set up and manage core Channel Revenue Management features that support rebate programs, incentives, and partner-related processes. These shared capabilities are used across multiple Channel Revenue Management workflows and aren’t tied to a specific use case.
Calculate On Hold Quantity: Calculate the quantity of inventory that must be kept in reserve based on the transaction journal records created for a partner. The partner uploads their point of sale document for your perusal. Here, they mention the units that have been sold to the end-customer. However, instead of directly adjusting the remaining quantity of unsold inventory you have on record for that partner, you can place the mentioned quantity on hold, that is, keep it on reserve till you can assess and approve the transaction record.
Calculate Remaining Inventory Quantity: Compute the remaining quantity of products available with the partners using the partner unsold inventory ledger records. This quantity is based on the point of sale documents debited to the transaction record.
Create Adjustments Manually: Manually adjust inventory levels to ensure accuracy and currency of information and calculate the remaining quantity of unsold inventory.
Create a Transaction Journal: Use transaction journal records to capture information stored in sale documents such as orders, invoices, and shipments. This information is processed to update the Partner Unsold Inventory (PUI) records. A PUI record is created for each sale document, reflecting the original product quantity in the sale document.
Channel Partner Inventory Tracking Data Model: The Channel Partner Inventory Tracking Cloud data model includes objects and fields that you can use to store information about your channel partner inventory tracking operations. The data model is built with industry-wide best practices, and you can adapt and extend the data model to meet your company’s unique needs.
Data Processing Engine Templates with Channel Partner Inventory Tracking: Channel Partner Inventory Tracking has Data Processing Engine (DPE) templates that you can clone and customize. The templates help you to create partner unsold inventory records. Examples of processes are: converting sale and point of sale data into transaction journal records, validating price protection and ship-and-debit transactions, and calculating unsold inventory with partners.
Create Transaction Journals For Point of Sale Data: Partners can upload Point of Sale documents by using the Manufacturing Experience Cloud site. These documents contain data related to sales made by the partners. This data is used to create transaction journals.
Manage Channel Partner Inventory Tracking: Manage partner inventory visibility through partner unsold inventory. Protect channel partners from price fluctuations by tracking unsold inventory and utilizing price protection capabilities. Validate partner claims using the ship and debit functionality and point-of-sale documents.
Create Partner Unsold Inventory Records: Get to know the exact amount of unsold quantity of inventory available with partners by creating partner unsold inventory (PUI) records from approved transaction journals.
Create Partner Unsold Inventory Ledger Records: Create channel inventory ledger records from point of sales documents. Use these records to track the remaining quantity of unsold inventory available with the partner and also to calculate onhold quantities. In case of inaccuracies in the inventory tracking, create ledger records manually.
Set Up Channel Partner Inventory Tracking: Set up and configure the Channel Partner Inventory Tracking features to enhance downstream processes with better visibility into calculated partner inventory. Assign the permissions for Channel Partner Inventory Tracking to users who want to get inventory traceability through ledgers.
Displaying Journal Types Based on User Profile: Share records with users based on their user profile. Experience Cloud users can use sharing rules to access specific records to which they want to upload their point of sales documents.
Capabilities of Data Cloud in Channel Revenue Management: Use Data Cloud with Channel Revenue Management to process high-volume incentive data, power analytics dashboards, and run scalable calculations. Connect your rebate, channel inventory, stock rotation, and accrual data to Data Cloud to offload complex processing from your Salesforce org and give finance and operations teams visibility into financial commitments.
Channel Revenue Management Data Kit: Get your Data Cloud implementation up and running by installing and deploying the predefined Channel Revenue Management data kit. This data kit packages core components, data streams, and structural definitions to safely offload complex logic to the Data Cloud Batch Transform engine.
Channel Revenue Management Data Model Objects: Data model objects (DMOs) store unified incentive data in Data Cloud. You can access standard model objects as part of the package deployment.
Channel Revenue Management Cloud Data Streams: Data streams map data model objects in Data Cloud to objects in your Salesforce org. The Channel Revenue Management data kit contains predefined data streams for data model objects. The fields on the data model objects are mapped to the corresponding fields on the source objects. You can map other fields as required, or delete the mappings that you don't use.
Deploy the Data Streams from Channel Revenue Management Data Kit: Create a data stream to connect your Salesforce org to Data Cloud. These data streams ingest your rebate program rules, active members, and benefit parameters directly into the engine staging areas.
Data Processing Engine Definitions in Channel Revenue Management: Data Processing Engine (DPE) definitions power the calculations that drive rebate, channel inventory, stock rotation, and accrual processing in Channel Revenue Management. Some definitions were originally built for CRM Analytics and can be migrated to run on Data Cloud for improved performance and scale. Others are purpose-built for Data Cloud and require no migration.
Export the Data Processing Engine Template: Export the JSON definition file from an existing CRMA-based Data Processing Engine (DPE) so that you have the configuration to modify for Data Cloud.
Finalize and Verify the Migration: Confirm that the migrated Data Processing Engine (DPE) definition maps to Data Cloud objects, verify the Data Cloud execution badge, and activate the definition to finalize the migration.
Import the Structural Overrides: Upload the modified JSON file to the new engine container. The ingestion process parses the configuration and structures the Data Processing Engine (DPE) nodes automatically.
Initialize the New Target Engine Container: Create a baseline target Data Processing Engine (DPE) definition that runs on Data Cloud. This container receives the modified JSON configuration that you import in the next step.
Install the Channel Revenue Management Data Kit: To create the necessary Data Lake Objects (DLOs) and data model objects (DMOs) for your calculations, deploy the standard package in your org.
Migrate an Existing Data Processing Engine Template to Data Cloud: Migrating the existing Rebate Data Processing Engine (DPE) template to Data Cloud involves exporting the definition as a JSON file, modifying specific metadata tags to change the execution engine, and importing it back into the Salesforce environment as a Data Cloud-native DPE.
Modify the JSON Configuration: Update the keys in the exported Data Processing Engine (DPE) template JSON so that the definition targets Data Cloud instead of CRM Analytics.
Data Cloud for Channel Revenue Management: Connect, harmonize, and analyze high-volume incentive, member performance, and transactional data at scale by setting up Data Cloud for Channel Revenue Management. Easily start your implementation by deploying the standard Channel Revenue Management data kit that comes with predefined data streams and unified data model objects (DMOs).
Prerequisites for Data Cloud: Before you use the Channel Revenue Management data kit and the Channel Revenue Management data model objects, complete the basic setup required to work in Data Cloud. You must connect Data Cloud to your Salesforce CRM org, enable features, and configure the security permissions.
Agentforce for Channel Revenue Management: Agentforce for Channel Revenue Management simplifies the management of rebate programs and payout processes through natural language interactions. With predefined agent topics and actions, track calculations, resolve issues with payout insights, and review overall rebate program details to ensure transparency, traceability, and accurate claims.
Set Up Agentforce for Channel Revenue Management: Set up and configure features to use agent force for Channel Revenue Management. Before you create an agent using this agent template, make sure to set up Data Cloud.
Agentforce for Channel Revenue Management: Track rebate payout progress and resolve issues efficiently. View total payouts by program and period, see splits by rebate type, and identify aggregates where payouts weren’t generated due to configuration or data issues. Drill into specific periods and payout sources for traceability, and review aggregates to ensure claim accuracy.
Agent Topic: Rebate Payout Insight: Rebate administrators can use the Rebate Payout Insight agent topic to summarize rebate payouts, provide traceability for aggregates, and review payout details for program members. This agent ensures accurate tracking of rebate program activities without performing any direct updates to rebate-related records.
Agent Templates in Channel Revenue Management: Use agent templates in Channel Revenue Management to quickly deploy AI-powered agents for rebate management, payout processing, and responding to partner inquiries.
Set Up Agentforce in Channel Revenue Management: Build trusted, intelligent AI agents for your channel revenue operations with Agentforce. Create a new agent or enable an Agentforce template, define capabilities such as rebate management and payout processing, and tailor topics and actions to complete your setup.
Intelligent Document Reader: Automatically extract data from documents to create, update, or verify records by using Intelligent Document Reader. Intelligent Document Reader uses Amazon Textract for optical character recognition. Upload documents in the JPG, JPEG, PNG, or PDF format, define the types of documents that you want to extract information from, and specify objects where extracted information is stored. For example, create a document type for rebate claim invoices, upload a rebate claim invoice, and verify the extracted data against the Transaction Journal records in your org. Or, create a document type for warranty claim invoices and map the extracted information to Claim records.
Manage Channel Revenue Management Features and Feature Sets: Identify the features and feature sets available for Channel Revenue Management to understand which specific capabilities are included in each bundle and manage your configuration from one place.
Channel Revenue Management Billable Usage Types: Usage of certain Channel Revenue Management features impacts your credit consumption. For more information on how usage is billed, refer to your contract or contact your account executive.
Enhance Price Protection with Current PUI Updates: The Create, Update or Delete PPE/PPELI based on product-detected price changes DPE automatically refreshes partner inventory with every execution, using the latest PUI snapshot. This eliminates grace period delays, provides immediate updates, and helps warnings clear sooner for smoother claim processing. Additionally, the reconciliation process now includes in-transit quantities for more accurate reporting.
Transit Time in Price Protection: Transit Time tracks expected movement durations for partner inventory between locations. Price Protection calculations include in-transit inventory to ensure accurate claims and maintain financial traceability.
Actionable Relationship Center in Rebate Management: Get insights into rebate relationships using two prebuilt templates in the Actionable Relationship Center (ARC). Start from transaction journals with the Rebate Payouts Overview, or from member payouts with the Payout Explainability Overview, and track how each transaction and aggregate contributes to total payouts. ARC graphs are fully visible only when aggregate items are generated for a particular payout. Without these items, the graphs provide an incomplete view. Gain a clear understanding of the underlying data dependencies and the connections that drive overall rebate outcomes.
Discover and Set Up Channel Revenue Management Features with Salesforce Go: Explore, set up and configure, and monitor usage of Channel Revenue Management features in one streamlined setup location. Access content resources, such as videos, Trailhead, and Salesforce Help articles, to learn about features, and get help with configuration. Discover more Channel Revenue Management features and add-on licenses that are available based on your Salesforce edition. And if you’ve turned on the Your Account app, you can quickly buy add-on licenses for some products directly from Salesforce Go.
Context Definition for Stock Rotation: Use the preconfigured context definition, StockRotationExecutionContext, to provide the data structure and mapping required to identify eligible inventory and calculate stock rotation benefits. This definition allows for the execution of Stock Rotation rules, ensuring integration between Stock Rotation Executions, Stock Rotation Execution Line Items, and Stock Rotation Claims.
Add Stock Rotation Incentive Program Members: Channel Partner Managers can enroll partners to stock rotation programs by creating Rebate Program Member records. Add partners who get the stock rotation rebates to a stock rotation program as accounts.
Assign Permission Sets for Stock Rotation Incentive: Give your admins and users access to Stock Rotation by assigning the appropriate permission set licenses and permission sets. With these permissions, users can access Stock Rotation features and objects such as Stock Rotation Executions, Stock Rotation Execution Line Items, and Rebate Claims.
Capabilities of Stock Rotation Incentive: Use Stock Rotation to create a robust, scalable process that enables your partners to manage inventory levels by returning or scrapping unsold products for credit. Review the capabilities of Stock Rotation and see how you can achieve various business outcomes with it.
Capture Stock Rotation Incentive Claims in Experience Cloud: Partners can now manage the entire lifecycle of stock rotation from viewing program eligibility to submitting and tracking claims directly through their Experience Cloud site.
Set Up Stock Rotation Incentive Claim Processing: Build an end-to-end process to validate stock rotation incentive claims, verify their eligibility for benefits, and calculate payouts by using declarative process automation tools. Minimize turnaround times, improve the efficiency of stock rotation claim analysts, and reduce manual errors with automated processes. Build your own processes by using the preconfigured, scalable templates for flows and Business Rules Engine expression sets as-is or as a reference.
Configure Validity Duration for Stock Rotation Incentive: Define the Validity Duration to establish the timeframe for eligible transactions. This ensures that only inventory purchased within a specific window can be returned or scrapped.
Create a Stock Rotation Incentive Program: Rebate program managers can create a stock rotation incentive program to help partners manage inventory by offering rebates for rotating old or excess stock.
Data Processing Templates for Stock Rotation Incentive Claim Processing: Clone and use the predefined Data Processing Engine (DPE) definitions for Stock Rotation to automate inventory eligibility stamping and the creation of execution items. You can use these definitions as-is or extend them to meet specific business requirements. To use a definition, you must activate it.
Stock Rotation Eligibility Calculation for Partner Unsold Inventory: The Stock Rotation Eligibility Calculation for Partner Unsold Inventory template stamps eligibility onto eligible Partner Unsold Inventory (PUI) records. This DPE is responsible for calculating the eligibility of any invoice for stock rotation.
Stock Rotation and Execution Item Processing: Once a Partner Unsold Inventory (PUI) is stamped with the eligibility condition, the next step is to run the Stock Rotation and Execution Item Processing DPE. This DPE is responsible for creating the stock rotation and the corresponding invoices to show to the partner.
Enable Stock Rotation Incentive: Turn on Stock Rotation in Setup to create programs, define rotation methods, and process return or scrap claims. When Stock Rotation is enabled, you can use predefined templates for the Data Processing Engine, context definitions, and Business Rules Engine expression sets to automate the identification of eligible inventory and the calculation of Rebate Claims.
Experience Cloud Site Setup for Stock Rotation Incentive Members: Use Experience Cloud to give your partners access to Stock Rotation Incentive. Create an Experience Cloud site where partners can view the stock rotation incentive program and payout details and submit their claims and proof documents. You can use the predefined Manufacturing Experience Cloud template to create a site for partners. You can also use an existing site in your org, or create a site from scratch and add the Stock Rotation objects to your Experience Cloud site.
Expression Set Template for Stock Rotation: Use the preconfigured expression set template, Ready_to_Use_CalcStockRotationClaimAmount, to validate stock rotation incentive claims and calculate payouts using the Business Rules Engine. This template contains the out-of-the-box rules for processing claims, ensuring that calculations are handled automatically.
Flow Template for Stock Rotation Incentive Notifications: Use the record-triggered flow to notify the partners when a new stock rotation window opens. This ensures partner users are informed in real time and have sufficient time to review eligible inventory and submit stock rotation requests before the program deadline. Customize the out-of-the-box notification flow to meet your organization’s communication and branding requirements.
Identify Products for Stock Rotation Incentive: Use the Stock Rotation Execution (SRE) records to identify which products and invoices are eligible for rotation based on the manufacturer’s program rules. The Stock Rotation Execution record displays Partner Unsold Inventory (PUI) records that the system has automatically stamped as eligible based on validity duration, price type, and account matching.
Stock Rotation Incentive: Manage stock rotation programs to allow partners and distributors to return or scrap unsold inventory for credit, ensuring optimal stock levels and financial flexibility.
Learn About Stock Rotation Incentive: Manage stock rotation programs for partners and distributors to maintain healthy inventory levels by enabling the return or scrap of unsold products for credit. Set up flexible programs by configuring partner eligibility, stock rotation methods, and validity durations. Seamlessly manage executions by identifying eligible partner unsold inventory, automating the calculation of eligible quantities, and generating claims. Foster stronger partnerships by providing clear visibility into available inventory and claim statuses for seamless collaboration.
Manage Budgets and Allocations: Define financial limits for your incentive programs to ensure profitability and prevent over-payouts. You can create hierarchical budgets and allocate specific amounts down to the individual Rebate Program Member level.
Manage Stock Rotation Incentive Programs: Use a Stock Rotation Incentive Program to help partners manage their inventory levels by offering rebates for rotating old or excess stock. These programs allow Channel Account Managers to define specific timeframes, reference numbers, and grace periods for claim submissions. By automating the validation and calculation of these incentives, you can improve partner engagement and reduce manual processing errors.
Process and Validate Stock Rotation Incentive Claims: View pricing, payout, and processing information for stock rotation claims submitted by partners using the Stock Rotation Execution (SRE) record page. Easily track incentive amounts already claimed by program members, adjust quantities, and finalize payouts.
Resolve Stock Rotation Warnings: Stock Rotation warnings are automated flags that identify discrepancies in inventory data or ongoing processes that could impact the accuracy of a claim. These warnings must be reviewed and, in some cases, resolved before a final rebate claim can be generated.
Review Partner Claim Requests: Once a partner submits their rotation quantities, the manufacturer (Stock Rotation Program Manager or Claim Analyst) must review the request.
Review Products for Stock Rotation Incentive: Use the Stock Rotation Execution Item (SREI) record to evaluate the stock and prepare submissions. The Stock Rotation Execution Item record shows the total quantity remaining on an invoice and the eligible quantity.
Understand Scrap and Return Methods: Stock Rotation supports two distinct handling methods for unsold inventory: Return and Scrap. Each method follows a unique technical path to ensure financial accuracy and inventory reconciliation.
Set Up Stock Rotation Incentive: To create a Stock Rotation program, define the rotation methods and eligibility terms, process return or scrap claims, and enable Stock Rotation in Setup. When Stock Rotation is enabled, you can use predefined templates for the Data Processing Engine, Context Definition, and Business Rules Engine expression sets.
Simulate and Generate Stock Rotation Incentive Claims: Validate partner submissions and calculate final credit amounts before issuing financial rewards. Use the simulation feature to preview the impact of rotation requests on your budget and verify quantities before permanently generating rebate claims.
Submit Stock Rotation Incentive Claims: Partners can submit stock rotation incentive claims either directly or from the Experience Cloud site. Validate, edit and resubmit claims if there are any errors.
Track Stock Rotation Incentive Payouts and Usage: Monitor the financial impact of your stock rotation programs and track how credits are disbursed across your partner network. By using automated snapshots, you can maintain a clear audit trail of all return and scrap payouts for financial reporting and reconciliation.
Stock Rotation Incentive Workflow: Understand the complete workflow for the stock rotation incentive program, including the roles and responsibilities of Salesforce admins, stock rotation program managers, and partners.
DPE Execution Sequence for In-Transit Inventory and Price Protection: Once Transit Time and Account Lead Time records are defined, execute the following DPEs in this order to ensure accurate handling of in-transit inventory, proper ledger status updates, and correct price protection calculations.
Transit Time: Define transit durations for partner inventory by specifying source, destination, usage type, and duration. Transit Time records set expected movement between locations. If no specific Transit Time exists, the Account Lead Time of type Transit is used as the default. Transit Time impacts price protection, inventory reconciliation, manual adjustments, and end-customer returns, ensuring accurate inventory tracking, claim calculations, and financial traceability. It builds on the existing Channel Inventory functionality to track partner inventory more effectively.
Set Up Transit Time: Define expected transit durations for partner inventory between locations, link partner accounts to locations, and assign default lead times at the account level. The configuration enables accurate calculation of partner inventory availability, supports reconciliation, and provides visibility into claims processing.
Change a Contributor’s Access Role: You can change a contributor’s access role to increase or decrease the level of access. A contributor’s access role is specific to a CMS workspace, so you must change the contributor’s role in each assigned workspace. Admins can’t change their own role.
Add Contributors to a CMS Workspace: In the Digital Experiences app (previously named Salesforce CMS), add users or public groups as contributors to a specific CMS workspace by assigning them an access role. A contributor’s access role is specific to a CMS workspace.
Role-Based Access in Salesforce CMS: Use role-based access to control who does what in each CMS workspace. Contributors are users or public groups in your org that you add to your CMS workspace. Contributors can belong to more than one workspace and have specific roles in each workspace, according to the level of access they need.
Remove a Contributor from a CMS Workspace: If a contributor leaves your company or is transferred to a different team, you can remove the contributor from a CMS workspace. The user or public group is removed from the workspace but not from Salesforce.
Deploy and Set Up the CMS Base Data Kit: Deploy and configure the CMS Base data kit to support semantic and AI-powered search. Deploy the data kit in a specific data space, and then configure settings such as transform frequency and search indexes. Data 360 ingests content metadata from Salesforce CMS to power these AI-driven search experiences.
Add or Remove a Channel from a CMS Workspace: CMS channels deliver content from a CMS workspace to an audience. Content published in a CMS workspace is available to all the channels added to the workspace. To control where your content is available, you can add and remove channels.
Create and Manage CMS Channels: To deliver content from Salesforce CMS workspaces to your audience, create a CMS channel in the Digital Experience app. Select a channel type, and configure the channel’s settings, depending on your use case. Edit channel settings at any time, and when you no longer need the channel, you can delete it from your org.
Configure the Salesforce CDN for Salesforce CMS: Use the Salesforce content delivery network (CDN) to serve Salesforce CMS content on your sites, send enhanced emails, and serve custom applications. Set a cache duration for CMS content served in Salesforce CDN channels and configure a domain that links content from your public channel to the CDN.
CMS Channels: CMS channels deliver published content from your CMS workspaces to an audience. Create a CMS channel, and then associate that channel with a CMS workspace. Channels can correspond to publishing endpoints such as a website or email message. Or create custom endpoint integration with third-party sites by using Salesforce headless APIs.
Create and Manage a CMS Workspace: Get started in the Digital Experiences app with a CMS workspace or an enhanced CMS workspace. Use the guided setup process to name your CMS workspace, add channels, and set the default language. After creating a workspace, you can change its name and description details to clarify its use and make it easier to find. When you no longer need an enhanced workspace, you can delete it.
Share Content Across Enhanced CMS Workspaces: Save time and space when you share content across enhanced CMS workspaces, and reuse content between workspaces without duplicating records. Work with content shared from a source workspace to a target workspace in the Shared with Workspaces folder. After workspaces are shared, you can make copies of a shared content record and save it to a folder in a target enhanced CMS workspace.
CMS Workspaces: In the Digital Experiences app, you use CMS workspaces and enhanced CMS workspaces to create content, organize content in folders, and schedule content publication. Limit access to the content with CMS workspace contributors and roles. Manage the content translation lifecycle, and add languages to reach more people with your content. Deliver your content to global audiences when you connect your CMS workspaces to both Salesforce and external channels.
Collections in Enhanced CMS Workspaces: A collection is a set of CMS content items. Collections keep content items grouped and ready to use in your channels. You can create collections right from your enhanced CMS workspace.
Manage a Dynamic Collection: A dynamic collection continuously updates based on the conditions and available content in your channels. Tag your enhanced CMS content with taxonomy tags, and then define conditions that automatically add content items to the collection.
Manage a Manual Collection: Create manual collections that provide a curated, static grouping of up to 50 items of a single content type in enhanced CMS workspaces. To add new content to the static collection, edit the collection. You can publish, unpublish, and delete manual collections.
Create and Manage CMS Content: Create and edit content in your CMS and enhanced CMS workspaces without changing what's live in your CMS channels. In enhanced CMS workspaces, clone existing content records of any type, including the content's variants.
View CMS Content Details in Enhanced CMS Workspaces: The content detail page in enhanced CMS workspaces gives a summary of a content item. If the content item has variants, you can switch between them from the left navigation menu. In the center column, see a quick view of the content. View content details, version history, and see where the content is published or referenced. Edit, publish, or unpublish, and run content workflows for your content.
Work with Extensions in Salesforce CMS: Use extensions to add productivity tools to the content editor in an enhanced CMS workspace. Streamline your content workflow with generative AI tools, spell checkers, and translation services. Developers can build extensions for specific CMS content types.
Salesforce CMS Content Key: The Salesforce CMS content key is a unique identifier that sticks with your content through version updates and across Salesforce orgs, sites, and components. You can use the content key to copy content between orgs, such as from sandbox to production, using the Salesforce CMS export and import feature.
Publish Content to CMS Channels: In CMS workspaces, publishing a content item makes it immediately available for use in all channels added to the workspace including site channels. If you publish a new version of content that's live, the existing live content is replaced with the new version. You can publish content immediately or schedule a later publication date.
Apply Taxonomy Tags to Content: When a content taxonomist creates a content taxonomy for your org, you search for tags and add them to the content record. Tag your enhanced CMS content with taxonomy tags, and then define conditions that automatically add content items to a dynamic collection.
View Content Version History in Salesforce CMS: On the content detail page, the Version History list shows all versions of a content item, its status, and the date and time it was last modified.
Types of CMS Content: Every CMS workspace comes with standard content types. You can also create custom content types for your specific needs, like blog posts or product announcements. To create custom content types, use the Managed Content API or CMS Content Type Manager in AppExchange.
Export Content from Salesforce CMS: Export content, such as images, news, documents, or custom content types to .zip archives of JSON files and media files from a CMS workspace or an enhanced CMS workspace. Transfer content from sandbox to production, or one org to another by importing the exported .zip archive.
Create Folders in a CMS Workspace: Use folders to organize all content types in your workspace. Create a folder hierarchy with child folders up to five levels, and add content to any level.
Organize CMS Workspaces and Content With Folders: Keep your Salesforce CMS workspace tidy and your content organized with folders. Create folders with up to five levels of hierarchy, and edit, move, rename, and delete folders to easily navigate the content in your workspace. Folders are unique to each CMS workspace, and they’re shared with every user in that workspace.
Navigate the Digital Experiences Home Tab: Access your CMS workspaces and site detail pages from the Digital Experiences Home tab. Jump to CMS channels, workspaces, and sites. View existing CMS Workspaces and All Sites, or create them from the home page. Access valuable help links to important resources without leaving the app.
Work with Image Content in Salesforce CMS: Updating your Salesforce CMS content with images is easy, and there’s lots of flexibility when you work with image references in other content.
Import Content into Salesforce CMS: Import images, news, documents, or custom content types into a CMS workspace or an enhanced CMS workspace by uploading a .zip archive of JSON files. Transfer content from an external source or CMS, or mass-import images from an external digital asset manager (DAM), for product enrichment.
JSON File Format for Content in an Enhanced CMS Workspace: Understand the content details from an export, then define your content details in JSON format for import. The export and import process works differently in enhanced CMS workspaces than it does in CMS workspaces. In enhanced CMS workspaces, each content item must have its own content.json file. Optionally, to specify the content key and folder placement of each content item, include a _meta.json file for each content.json.
Export and Import Content with Salesforce CMS: Get an overview of how to add content to a CMS or enhanced CMS workspace, or transfer content from one org to another. Learn more about how to format and handle content in some common use-case scenarios.
Preview Salesforce CMS Content on Your Site: See how your CMS content looks on your Aura, LWR, or enhanced LWR site on a desktop or mobile device. You can preview image, document, news, or custom content types in any status on site channels connected to the CMS workspace.
Work with Content Publication Schedules: Content admins and content managers can manage publication schedules and statuses for the entire CMS workspace with the Publication Calendar. From the Publication Calendar, you can manage all scheduled content for the CMS workspace in one location. Or you can manage schedules for a content item on the Publication Activity tab of its content detail page. When you create and edit publication schedules, keep these considerations in mind.
Create a Content Taxonomy and Manage Terms: Each org can have one, overarching content taxonomy. Create a new taxonomy, or use Data Loader to import an existing taxonomy. Then, add, edit, delete, and view terms in a content taxonomy.
Understanding Content Taxonomy: A taxonomy is a hierarchy of terms used to classify CMS content. The terms are organized in parent and child relationships, and they describe what the content is or how the content is used.
Work with Content in the Translation Lifecycle: When your CMS workspace is set up with multiple languages, you can offer translated content and manage all versions of your content from your CMS workspace. Identify content to be translated, export it for your localization partner, import the translated content, and publish it to the destination.
Work with Enhanced CMS Content in the Translation Lifecycle: When your enhanced CMS workspace is set up with multiple languages, you can offer translated content and manage all versions of your content from your enhanced CMS workspace. Identify content to be translated, export it for your localization partner, import the translated content, and publish it to CMS channels.
Translate Salesforce CMS Content: To meet the global demands of your business, offer your content in multiple languages. First, set up your CMS workspace with the languages you require. Then manage the content through the translation lifecycle, from draft to publish.
CMS Workflows and Approvals: Your CMS workspace grows and changes with time, which makes role-based workflows useful and sometimes necessary. Workflows allow content creators to request an approval, translation, or anything else you can dream up, directly from a content item and send that request directly to the relevant user. The workflow captures a full audit trail of each assigned or completed step. With workflows, you always know where you are in the process and who’s responsible for the next step.
Use Workflows in CMS: Workflows are built on Flow Orchestration and with them you can create processes that are attached to CMS content items. From a content item, launch a ready to use flow such as an approval, a translation, or another process that you can create from scratch. Modify workflows in Flow Builder and create multiple, selectable workflows for various use cases.
Anatomy of the Basic Approval Request Workflow: Workflows and approvals are built using Flow Orchestration technology. Salesforce Flow Orchestration was created so you can quickly create sophisticated, multi-user, multi-step automated business processes without code. Enhanced CMS workspaces include a pre-existing approval workflow that you can use to get started.
Building Blocks of a CMS Workflow: CMS workflows are built on Flow Orchestrations that use common flow and orchestration elements in addition to process and step types that are unique to CMS.
Enable CMS Workflows: With workflows you can attach your approvals and other business processes directly to CMS content items. Access workflows from your content items and variants, and create a full audit trail that you can refer to later. Workflows and Approvals are automatically turned on in all CMS enhanced workspaces.
Search CMS Content in Enhanced Workspaces: Find CMS content items within your enhanced CMS workspaces and folders. Use advanced search functions, such as wildcards and logical operators, to maximize your search results. Search results consist of matches for all text fields within CMS content items, including content title, body, and metadata. Both primary content and content variants are searched.
Something Went Wrong...There’s No Help for This Custom Object: You landed on this page because you were looking for more information about a particular custom object, but your Salesforce admin didn’t create a help page for that object. Review the suggested resources. If you need information on a specific custom object, contact your administrator about creating custom help for your custom objects.
Something Went Wrong...There’s No Help for This Custom Object: You landed on this page because you were looking for more information about a particular custom object, but your Salesforce admin didn’t create a help page for that object. Review the suggested resources. If you need information on a specific custom object, contact your administrator about creating custom help for your custom objects.
Something Went Wrong...There’s No Help for This Custom Object: You landed on this page because you were looking for more information about a particular custom object, but your Salesforce admin didn’t create a help page for that object. Review the suggested resources. If you need information on a specific custom object, contact your administrator about creating custom help for your custom objects.
Set Up Debug Logging: To activate debug logging for users, Apex classes, and Apex triggers, configure trace flags and debug levels in the Developer Console or in Setup. Each trace flag includes a debug level, start time, end time, and log type. The trace flag’s log type specifies the entity you’re tracing.
Monitor Debug Logs: Set trace flags to trigger logging for users, Apex classes, and Apex triggers in the Developer Console or in Setup. Monitor the resulting logs to diagnose problems in your org.
View Debug Logs: The debug log contains information about each transaction, such as whether it was successful and how long it took. Depending on the filters set by your trace flags, the log can contain varying levels of detail about the transaction.
Follow People and Records: Follow people and records to see their updates in your feed. When you follow people, you can see their posts, comments, and likes on the feeds that you also have access to. If a person you follow posts to a group you don’t have access to, you can’t see that post. When you follow a record, you are notified about activity on the record, provided feed-tracking is enabled on the record’s type.
Follow Records: Follow records to see updates in your feed, including field changes, posts, tasks, and comments.
Change Your Profile or Group Photo: Upload a photo to your profile so people can see who you are. Upload a photo for groups that you own or manage.
Update Your Profile Page: Click your name or your profile picture to navigate to your profile page. The page offers controls for changing your avatar and updating your contact information. Your contact information is visible to everyone in your company.
Configurations: Use these configuration steps to collect health verifications to return to work.
Design Consideration: Keep these design considerations in mind when you collect health verifications to return to work.
CMS Content: Create, organize, schedule, publish, and delete digital content in CMS workspaces.
Delete Content from a CMS Workspace: As your business grows and changes, so does your content. To keep your CMS workspace tidy, delete content. Deleting a content item removes all versions and variants of the item from your workspace. The procedure to delete content from an enhanced CMS workspace differs from the procedure to delete content from a CMS workspace.
Salesforce CMS and the Digital Experiences App: Salesforce CMS is a hybrid content management system (CMS) where you can easily create and deliver content to any channel or device. Centralize workspaces, content, and channels in the Digital Experiences app.
Enable Search for Content in CMS Channels: Make finding CMS content easier for your users. Configure search within all your channels, including Experience Cloud sites, Commerce Cloud, Marketing Cloud Engagement, Heroku, LEX apps, and more.
Enable Access to the Digital Experiences App: The Digital Experiences app is where you access the Digital Experiences Home, all CMS workspaces, CMS channels, all sites, and Experience Builder.
Unpublish Content from CMS Channels: Remove content from published destinations and make it unavailable for use in CMS channels with manual unpublishing.
Manage Information About Your Company: The Company Information page shows all the important information about your company (listed here in alphabetical order). The page also includes the user and feature licenses purchased for your organization.
Complete the OAuth Flow: To verify that the external client app is operating correctly, perform an Authorize Endpoint request and a Token Endpoint request. The Token Endpoint request produces an API Access Token that can be used to access any Salesforce API.
Customer Lifecycle Analytics Base App: With the Salesforce Feedback Management Starter and Growth licenses, your Salesforce org is provisioned with five user licenses for the Customer Lifecycle Analytics Base App.
Deploy and Use Customer Lifecycle Analytics: Customer Lifecycle Analytics lets you surface survey response metrics anywhere in Salesforce and get instant insight into your customer right from where you work.
Deploy Customer Lifecycle Analytics: Before you create an app from the Customer Lifecycle Analytics template and use the dashboards, deploy Customer Lifecycle Analytics in your Salesforce org.
Use Customer Lifecycle Analytics Dashboards: You can use Customer Lifecycle Analytics Dashboards to gain actionable insights into your customers and answer key questions about your business.
In-App Dashboards: You can access the in-app dashboards through the app in CRM Analytics Studio.
Embedded Dashboards: The Customer Lifecycle Analytics app includes dashboards and scorecards that you can embed in Lightning Experience pages. These dashboards provide detailed insights into your customer satisfaction and loyalty. Salesforce admins embed these dashboards in specific Salesforce pages.
Natural Language Processing Dashboard: Use the Natural Language Processing Insights dashboard to analyze survey responses and gain comprehensive insights into customer sentiments, extracted keyphrases, and entities. Monitor changes in customer sentiments over time and analyze keyphrases and entities that frequently appear in survey responses to make data-driven decisions and enhance customer satisfaction.
Analyze Survey Responses: Gain insights into responses by using the Analyze tab in the Survey Builder to view and export response data.
How Ranking Questions Work: The average rank of an item in a ranking question is calculated based on its weight and the number of responses in which the item has the same rank.
Create Surveys and Add Questions: Create, copy, and manage surveys across versions. Add a variety of questions and define their properties.
Create and Customize Surveys: Use a wide range of question types to engage participants. Create, copy, and manage surveys across versions. Personalize survey pages and survey questions to increase participant engagement. Allow participants to view survey pages and questions based on their previous responses. Customize the look and feel of your surveys to fit your company's brand. Design surveys to personalize your participants’ experience. Gather feedback from a global audience by translating surveys.
Generative AI Surveys: Use generative AI to quickly create and translate surveys tailored for diverse needs. Specify key survey parameters, review the auto-generated questions, and add approved questions in the survey builder. Use generative AI for accurate translation of entire surveys or specific parts, enabling feedback collection from a global audience.
Customize the Order of Survey Questions and Pages: Save your survey participants a click by automatically sending them to the next page after they answer the last question on a page. Choose which questions participants view based on their responses to previous questions on the same page. Show participants the most appropriate survey page based on their responses to questions on previous pages or by using merge fields.
Configure and Personalize Survey Questions and Responses: Personalize welcome messages, survey questions, and thank you messages by inserting field values in Salesforce records, participant details, company information, and custom values. Let participants upload documents in responses to attachment questions and respond to surveys in the email invitation itself. Validate participants’ responses to short text questions.
Customize the Look and Feel of Your Surveys: Promote your company's brand and style in surveys by adding background images and your company’s logo to surveys, and changing the labels, text color, and color of buttons. You can even insert images in survey pages.
Distribute Surveys: Generate different types of survey invitations and distribute them in a way that best suits your participants' needs. You can generate individual invitations, send invitations by email, or automate the distribution process.
Share Surveys Through Chat or a Web Page: To share your survey through a chat session or within a web page, specify the domains that you trust to serve your surveys. Then, to embed the survey on a web page so that site visitors can respond to it, use an inline frame (iframe).
Embedded Dashboards with Tableau Next: The Customer Lifecycle Analytics app in Tableau Next Hub includes dashboards and scorecards that you can embed in Lightning Experience pages to understand customer satisfaction and loyalty.
Loyalty Management Home Page: Start the day with the Loyalty Management Home page. Determine what needs your attention, and make better decisions to improve member engagement.
In-App Dashboards with Tableau Next: You can access the Tableau Next in-app dashboards through the Customer Lifecycle Analytics app with Tableau Next.
Use Merge Fields to Personalize Surveys: Define and insert variables for merge fields in welcome messages, survey questions, and thank you messages. Inserted merge fields resolve to field values in Salesforce records, participant details, company information, and custom values.
Show Survey Pages Based on Responses or Merge Fields: Use page branching logic to determine the survey page that participants view next, and to allow participants to submit the survey and go to the Thank You page.
Survey Language for Participants: Understand how participants inside and outside your Salesforce org see and respond to translated surveys.
Alerts for Survey Responses: Use Record Alerts in a data map to monitor updates in records based on survey responses. For example, if a customer gives a low rating for a support agent, Record Alerts can be defined to notify the agent about the survey response immediately. You can see Record Alerts on the Alerts component in the service console.
Discover Ways to Help Improve Survey Response Rates: Personalize surveys for each participant, show only relevant pages and questions, speed participants through your survey, and increase your survey's visual appeal.
Salesforce Feedback Management: Understand customer feedback as it evolves over time by engaging customers and users with relevant, personalized surveys. Incorporate survey data into your feedback management process and gain actionable insights at every stage of the customer lifecycle.
Send Survey Invitations by Email: Email survey invitations to individual participants using their email address, or to a group of participants using a list. Use invitation templates that include the survey question or a link to the survey, customize the templates, or compose your own email invitation.
Customize the Survey Invitation Email Templates: Edit the survey invitation templates to reflect your company's voice and style, and create templates for different types of surveys or projects.
Send Survey Invitations Using Flows: Use Flow Builder to automatically email survey invitations to leads, contacts, and users in your org based on a condition, such as, when a customer support case closes.
Send Survey Invitations by Email From Record Pages: Use the Send Survey action to easily send a quick pulse or relationship survey to gauge customer or employee satisfaction. With the action, users can send survey email invitations from any object’s record pages and don’t have to go to Survey Builder to send surveys.
Use Flow Templates to Get Sentiment Insights: Feedback Management provides two Flow templates that help analyze the sentiment of survey responses. You can use them as is or customize them to suit your needs.
Set Up Salesforce Feedback Management: Enable Salesforce Feedback Management in your org and configure it based on your requirements. Give users permission to create and share surveys, to view survey records, and respond to surveys. Add related lists and Lightning components that help track surveys, survey invitations, and survey responses. Analyze survey responses with custom report types.
Share and Relate Survey Records: Enable users to view their survey invitations and responses by sharing those records. Check the users who have access to survey records. Relate Salesforce records to survey invitation records.
View Survey Response Data: View completion metrics and response data on the Analyze tab of the Survey Builder.
Feedback Management Licenses: Understand the capabilities provided in the three Salesforce Feedback Management licenses so that you get the right license for your business requirements.
Create a Flow to Activate Natural Language Processing Services: Create a flow in Flow Builder to activate Natural Language Processing Services and analyze text-based survey responses. This flow will invoke Natural Language Processing (NLP) actions when a survey is submitted.
Get Natural Language Processing (NLP) Insights: Use the Natural Language Processing Insights card to view insights into the text-based survey responses based on the configured Natural Language Processing services . Drag the Natural Language Processing Insights card to a lightning page to access the key phrases and entities identified through AWS services.
Create Custom Flows by Using Invocable Action: Use the invocable action, initiateNaturalLangProcessing, to create custom flows that initiate Natural Language Processing (NLP) operations such as Keyphrase and Entity extraction.
Analyze Survey Responses by Using Natural Language Processing (NLP) Services: Analyze the text-based survey responses efficiently based on entities and keyphrases by using Natural Language Processing (NLP) Services. AWS integration offers flexibility in selecting the services like keyphrase and entity extraction. Access results easily in the Natural Language Processing Insights card, which you can drag to any lightning page.
Encrypt Survey Fields: Protect sensitive participant data collected in Surveys with Shield Encryption and meet regulatory compliance mandates. Encrypt data from Salesforce users, including administrators.
Analyze Survey Responses in Custom Reports: Use the custom reports created with the Survey Question Score report type to view responses for every type of question except for short text and long text questions. The report can track responses by survey invitation or by survey version.
AI-Generated Summaries of Survey Responses: Create insightful summaries from survey responses with generative AI. Then use a data map to create or update records, or send custom notifications based on the generated summaries.
Timeline View for Survey Responses: Configure Timeline in a data map to get a comprehensive and chronological view of survey responses. For example, you can create timelines for the Contact object to monitor survey responses with a low net promoter score. You can enable Timeline for standard objects and custom objects.
Configure Attachment Questions: Allow participants to upload documents such as receipts for warranty claims by including attachment questions in your survey.
Configure a Client Credentials Flow: To share information between two applications without any input from a user, use the OAuth 2.0 client credentials flow. In this flow, the client app exchanges its client credentials that are defined in the external client app for an access token. For this flow, you must specify an integration user to run the integration.
Configure a Custom Attribute for External Client Apps: Create custom attributes to capture useful and unique information. With custom attributes, you can get more information about a user’s identity such as an address or job title. Configure custom attributes for your external client app in the Policies tab.
Configure a Device Flow: To integrate apps that run on devices with limited input or display capabilities, such as smart TVs, appliances, and other internet of things (IoT) devices, configure the Global OAuth Settings to include a device code, and enable the OAuth 2.0 device flow. Command-line apps can use this flow as well. Users can connect these apps to Salesforce by accessing a browser on a device with more advanced input capabilities, such as a desktop or mobile device.
Configure the External Client App’s Canvas App Settings and Policies: The Canvas plugin for an external client app enables you to integrate a third-party application in Salesforce. Configure the external client app’s Canvas app settings and policies in External Client App Manager.
Configure the External Client App’s Mobile App Settings and Policies: The mobile app plugin for an external client app enables mobile-specific features, such as screen lock upon a custom timeout value. Configure the external client app’s mobile app settings and policies in External Client App Manager.
Configure the External Client App’s Notification Settings: With the notifications plugin for an external client app, you can subscribe the mobile app to custom notification types. Enable the notifications plugin, and subscribe the mobile app to notification types in External Client App Manager.
Configure the External Client App’s Push Notification Settings and Policies for iOS: To set up push notifications for iOS versions of your mobile app, collect information from Apple App Store Connect and from your Apple Developer account. Then, configure the external client app’s push notification settings and policies in External Client App Manager.
Configure the External Client App's SAML 2.0 Settings and Policies: To integrate a service provider with your Salesforce org, you can use an external client app that implements SAML 2.0 for user authentication. Salesforce supports SAML single sign-on (SSO) when the service provider or the identity provider initiates the flow. To use this option, configure an external client app with SAML 2.0 enabled for your service provider. Define your Salesforce org as the SAML identity provider.
Configure Loyalty Program Process Aliases: Use aliases to quickly and easily specify object fields as resources. You can also use aliases for loyalty objects and fields instead of providing object-field relationships. To make loyalty aliases available as formula resources, define the formula in a rule condition.
Configure a Code and Credentials Flow: The Code and Credentials Flow is the foundation of headless login, registration, passwordless login, and guest user identity. Before setting up these features, enable the Code and Credentials Flow at an org-wide level and configure these required settings and access policies for your external client app.
Configure a JWT Bearer Flow: External client apps can support OAuth 2.0 JSON Web Token (JWT) bearer flows using the certificate field in the global OAuth settings file. A JWT flow authorizes servers to access data without interactively logging in each time the servers exchange information.
Configure Default Settings for a Packaged External Client App: External client apps include default values when packaged for distribution. These values show up in the policies tab on a distributed external client app and are edited by admins. If a developer configures custom values in the Settings tab of an external client app before packaging, those configurations don't affect the packaged policies. To change the policies values that are packaged with the app, configure the settings in the Package Default tab.
Package an External Client App: Determine whether to package and distribute your external client app or keep it local. Only packaged apps can be deployed to other orgs. You can package external client apps with first-generation or second-generation managed packages. Apps that use OAuth can be deployed with their own OAuth settings or they can reference settings on the org where the app was developed.
Configure a Web Server Flow: To integrate an external web app with the Salesforce API, configure an external client app to use the OAuth 2.0 web server flow, which implements the OAuth 2.0 authorization code grant type.
Integration Basics for Salesforce Suites: Salesforce Suites is built on a simple idea: Your business runs smoother when everything you need lives under one roof, especially your data. But what about the external apps your business relies on, like accounting and project management tools? Salesforce prebuilt integrations bridge that gap by bringing your external app data into your Suites workspace and eliminating siloed data.
Connected App Use Cases: There are four main use cases for which your org can implement connected apps. You can use a connected app to integrate external applications with the Salesforce API, such as a web-based app that pulls in order status data from your Salesforce org. You can also use connected apps to integrate service providers with your Salesforce org, and to set security policies to control what data a third-party app can access from your org. And you can configure a connected app to provide authorization for external API gateways, such as API gateways hosted on MuleSoft’s Anypoint Platform.
Configure a Connected App for the OAuth 2.0 Client Credentials Flow: With the OAuth 2.0 client credentials flow, your client app exchanges its client credentials defined in the connected app—its consumer key and consumer secret—for an access token. Before you implement the client credentials flow, configure these settings and access policies for your connected app.
Connected App IP Relaxation and Continuous IP Enforcement: For security reasons, if you relax IP restrictions for your connected app, and your org has enabled Enforce login IP ranges on every request, users can’t access the app in some circumstances. This access restriction applies to all OAuth-enabled connected apps, including mobile devices.
Create a Connected App: When you create a connected app, make sure that you understand how it’s going to be used so you can configure the appropriate settings. For example, if you’re creating a connected app to integrate an external application with your Salesforce API, configure the connected app with OAuth authorization settings. Or if you’re creating a connected app to act as a service provider in a SAML single sign-on (SSO) flow, configure SAML settings.
Enable OAuth Settings for API Integration: You can use a connected app to request access to Salesforce data on the behalf of an external application. For a connected app to request access, it must be integrated with the Salesforce API using the OAuth 2.0 protocol. OAuth 2.0 is an open protocol that authorizes secure data sharing between applications through the exchange of tokens. When developers or independent software vendors (ISV) want to integrate their app with Salesforce, they use OAuth APIs. These OAuth APIs enable a user to work in one app but see the data from another.
Expose Your Connected App as a Canvas App: You can expose your connected app as a canvas app. Canvas apps are available as apps that your org’s Salesforce admin install or as personal apps that users install across orgs. Users access a canvas personal app from the Chatter tab, and are prompted to allow the app to connect to their Salesforce data. Users can choose to make an app a canvas personal app.
Create a Custom Connected App Handler: Write a custom connected app handler in Apex to customize the behavior of a connected app. The custom handler can support new protocols or respond to user attributes in a way that benefits a business process.
Create a Connected App for Mobile App Integration: A connected app is a primary means by which a mobile app connects to Salesforce. Although not required, you can use Salesforce Mobile SDK to build mobile applications as connected apps. These connected apps can access Salesforce OAuth services and call Salesforce REST APIs.
Integrate Service Providers as Connected Apps with OpenID Connect: To integrate a service provider with your Salesforce org, you can use a connected app that implements OpenID Connect for user authentication. To use this option, the service provider must accept OpenID Connect tokens. Configure a connected app with the OpenID Connect scope for your service provider. The OpenID Connect scope passes user information in an ID token. Users can then log in to the external app with their Salesforce or Experience Cloud credentials.
Integrate Service Providers as Connected Apps with SAML 2.0: To integrate a service provider with your Salesforce org, you can use a connected app that implements SAML 2.0 for user authentication. Salesforce supports SAML single sign-on (SSO) when the service provider or the identity provider initiates the flow. To use this option, configure a connected app with SAML 2.0 enabled for your service provider. Define your Salesforce org as the SAML identity provider.
Delete a Connected App: You can delete a connected app that you created. But if you delete a connected app, you can’t restore it. Don’t delete a connected app that’s associated with an active managed package.
Add Custom Attributes to a Connected App: After you’ve created the connected app, you can add custom attributes. With custom attributes, you can get more information about a user’s identity like an address or job title. Custom attributes specify SAML metadata or specify OAuth parameters that are read at OAuth runtime.
Configure Trusted IP Ranges for a Connected App: After you create a connected app, you can specify the trusted IP ranges from which a user can log in. In addition, you can apply IP relaxation to all OAuth client apps, including apps that use OAuth and SAML for single sign-on.
Edit a Connected App: After you create a connected app, you can make changes to it’s configuration. The actions that you can perform depend on the type of connected app. Use the App Manager to get a list of apps available in your org, including connected apps. From here, you can edit, reconfigure, or delete the connected app.
Reconfigure a Connected App: You can reconfigure a connected app at any time to change the app’s description, logo, icon, or callback URL. You can update settings for OAuth, web apps, mobile apps, or canvas apps.
Issue JWT-Based Access Tokens: Enable a Salesforce external client app or connected app to issue JSON Web Token (JWT)-based access tokens instead of opaque tokens. Unlike opaque tokens, JWT-based access tokens have a transparent format, so you can introspect them without calling a Salesforce endpoint. This functionality makes them handy for use cases where you’re calling multiple external systems.
Install a Connected App: You install a connected app by installing a managed package that includes the connected app as a component. For example, ISVs package connected apps to make them available on AppExchange. You can also install an OAuth connected app from the Connected Apps OAuth Usage page. This page lists all OAuth connected apps that users in your org are connecting to currently—including apps that developers created in other Salesforce orgs.
Limit the Idle Refresh Token TTL in Connected Apps: For improved security, Salesforce requires a 30-day limit to the idle refresh token TTL (time-to-live). The idle TTL is the amount of time that an OAuth refresh token can be inactive before it expires. When a refresh token expires, the user or app must request a new access token. The idle TTL works as a sliding window: each time the token is used within the 30 day-period, its idle TTL resets. For flows that don't use refresh tokens, this control also caps the access token lifetime at 30 days from the last login date.
Manage Access to a Connected App: After a connected app is installed in your org, you can manage access to it. Configure permissions and policies for the app, explicitly defining who can use the connected app and where they can access the app from. These permissions and policies, which include user-access, IP range restrictions, and multi-factor authentication (MFA), provide extra security for your org.
Manage Other Access Settings for a Connected App: The Connected App Detail page provides an overview of access settings assigned to the connected app, including OAuth policies and session policies. From this page, you can click Edit Policies to manage access to the connected app. You can also manage profiles, permission sets, custom attributes, and custom scopes associated with the connected app.
Manage Current OAuth Connected App Sessions: The Connected Apps OAuth Usage page displays current OAuth app connections. For apps that aren't installed, it also displays usage attempts that Salesforce automatically denied due to security restrictions. From this page, you can install or uninstall third-party connected apps, revoke an app’s active sessions, and block or unblock org-wide access to the app.
Manage Access Through a Custom Connected App Handler: Write a custom connected app handler in Apex to customize how the connected app is invoked. The custom handler can support new protocols or respond to user attributes in a way that benefits a business process.
Manage Mobile Policies for a Connected App: Configure policies for mobile connected apps that enforce PIN protection. These policies include setting the length of the connected app’s PIN, and defining how long a session can be idle before requiring re-entry of the PIN.
Manage OAuth Access Policies for a Connected App: Configure OAuth access policies for OAuth-enabled connected apps. These policies include defining which users can access a connected app, what IP restrictions apply to the connected app, and how long a refresh token is valid for.
Manage Session Policies for a Connected App: Configure a connected app’s session policies to define how long a user’s session can last before reauthenticating. You can also use session policies to block user access to the connected app, or to require two-factor authentication to access the app.
Manage Start URL Settings for a Connected App: A start URL defines the page where users are directed to when they run the connected app. The start URL can be configured by the app owner during the setup process or managed later. If you don’t configure a start URL, users are sent to the app’s default start page after authorization completes. Start URL settings apply to all connected apps, except canvas apps. If your app is a canvas app, the connected app ignores the start URL fields. Instead, it uses the canvas app URL specified when the connected app was created.
Manage Third-Party Connected Apps: If your org uses third-party apps, such as those installed from the AppExchange, you can set security policies to control what data the third-party app can access from your org. You can also define who can use the third-party app. In addition to setting security policies to manage third-party apps, you can uninstall, and—when necessary—block these apps from the Salesforce org.
Disable Full Content Push Notifications: The content of mobile push notifications can be displayed outside of a connected app, such as on a mobile device’s lock screen. Full content push notifications are enabled by default for most connected apps, but you can choose to display minimal content instead. When full content push notifications are disabled, custom notification types display the notification title only.
Send Mobile Push Notifications: Mobile push notifications allow Lightning Platform mobile app developers to easily push notifications to their users’ mobile devices when business events occur in the customers’ orgs. To enable push notifications, you must use the mobile connected apps framework.
Configure Android Push Notifications: To support push notifications for Android versions of your mobile app, collect information from a Google Firebase project. Then, create a separate connected app for the Android platform.
Configure iOS Push Notifications: To support push notifications for iOS versions of your mobile app, create a separate connected app for the iOS platform.
Send Notifications to a Connected App: Keep users of your custom app up to date with timely information and reminders. With the connected app framework, you can use the Notification Builder Platform or Apex Push to send custom notifications.
Send Custom Notifications with Notification Builder Platform: Subscribe your connected apps to custom notification types to receive and display in-app and push notifications. Subscribing allows you to send custom notifications to users in your own org. Or you can package your app for distribution and the custom notifications it subscribes to along with it, including the notification types and triggers.
Connected Apps: A connected app is a framework that enables an third-party application to integrate with Salesforce by using APIs and standard protocols, such as SAML, OAuth, and OpenID Connect. Connected apps use these protocols to authenticate, authorize, and provide single sign-on (SSO) for third-party applications. The third-party applications that are integrated with Salesforce can run on the customer success platform, other platforms, other devices, or even SaaS subscriptions. For example, when you log in to your Salesforce mobile app and see your data from your Salesforce org, you’re using a connected app.
Error Messages for Push Notifications: If you get an error message while sending a push notification from the Send Test Notification page, check the following table for suggestions on how to fix the error.
Revoke All JSON Web Token (JWT)-Based Access Tokens: If necessary, you can revoke all JSON Web Token (JWT)-based access tokens issued by all external client apps and connected apps. Revoking JWT-based access tokens invalidates their signing keys, which makes the tokens unusable.
View and Rotate the Consumer Key and Consumer Secret of a Connected App: Keep your connected apps secure by periodically changing your consumer key (client ID) and consumer secret (client secret). To make sure that your existing integrations don’t break, generate staged consumer details and share them with your connected app integrations. When you're ready, apply the new consumer details.
Send Test Push Notifications to APNS: To run a quick test of your push notification setup for Apple Push Notification Service (APNS), use the Send Test Notification page.
Test Push Notifications: To run a quick test of your push notification setup, use the Send Test Notification page. Troubleshoot round-trip push notifications in a synchronous mechanism without having to configure custom notification types, Apex calls, or REST calls. You can also gain insights into what’s going on behind the scenes in the asynchronous environment of real-world push notifications.
Connected App to External Client App Migration: Create an external client app based on one of your existing connected apps. External client apps provide many of the features of connected apps while offering increased security.
Uninstall a Third-Party Connected App: You can uninstall a third-party connected app from your org. However, uninstalling an app doesn’t delete the connected app. Instead it removes the OAuth policies that you set for the app in your org. Because you’re removing the policies for apps that users can still access, you’re actually loosening your security measures. We recommend uninstalling a connected app only when the original developer deletes the app from their org. To make a connected app inaccessible to your org’s users, block the app. This action ends all current user sessions with the connected app and prevents all new sessions until you unblock the app.
User Provisioning for Connected Apps: You can use a connected app to link your users with a third-party app. User provisioning for a connected app simplifies account creation and links your Salesforce users’ accounts to their third-party accounts. After the accounts are linked, you can configure the App Launcher to display the connected app as a tile. With a single click, users get instant access to the third-party app.
Configure User Provisioning for Connected Apps: Configure a connected app to save time when provisioning users for third-party apps. Salesforce provides a wizard that guides you through the user provisioning settings for each connected app.
Manage User Provisioning Requests: After you configure user provisioning for a connected app with the User Provisioning wizard, you can manage individual provisioning requests from the User Provisioning Requests tab and from the connected app’s detail page. If you included an approval process, you can set up user provisioning request sharing rules.
Comparison of Connected Apps and External Client Apps Features: Connected apps offer a framework to provide external applications with your Salesforce data. However, there are aspects of the framework that make it impossible to define separate user roles and difficult to package connected apps. External client apps were designed to be as useful at connecting external applications with your data as connected apps while addressing these shortcomings.
Understand the Salesforce Consent Data Model: The Salesforce Consent Data Model is the standard data model for managing consent at multiple levels, from global preferences to more granular controls. This data model, the foundation of Salesforce’s long-term view of consent, considers the individual’s entire experience, not just a single contact point. Any record that relates to an individual can have related consent considered within this model, including leads, users, person accounts, and contacts. It also provides flexibility to choose which level to manage consent initially. You can then add levels of granularity as business needs evolve or regulatory requirements change for managing that consent data.
Configurations: Follow these configuration steps to use the Salesforce Consent Data Model to manage and respect consent preferences in Marketing Cloud Engagement.
Design Considerations: To take full advantage of the Salesforce Consent Data Model, keep these design considerations in mind. They’re designed to help you access and interpret privacy preferences. They also help you create a durable design that can accommodate changes to consent-related business needs and regulatory requirements.
Workflow: Learn how data flows through the configurations when you use the Salesforce Consent Data Model to manage and respect consent preferences in Marketing Cloud Engagement. For this solution kit, we consider a scenario where contact point information ties to a Contact record.
Use the Consent Event Stream: Use one stream to receive notifications about changes to consent fields or contact information on all core objects. When your users change an object, an event is emitted into the stream with information about the change. This information is available to view for 24 hours.
Consent Management: Track Customer Consent and Honor Opt-Out Requests: Track your customers’ approval for how your company interacts with them. Comply with customer requests to opt-out of sharing their personal information with third parties. To help you assess your compliance with data protection and privacy regulations, we give you examples of common customer requests. And we provide details to help you determine the best way to comply with the regulations that apply to your company.
Consent Management for Analytics: Track your customers’ approval for how your company interacts with them and honor their requests to opt-out of certain types of data-sharing. To help you assess your compliance with various data protection and privacy regulations, we give you examples of common customer requests. And we provide details to help you determine the best way to comply with the regulations that apply to your company.
Consent Management for Data Cloud: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for B2C Commerce: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Experience Cloud Sites: Honor your customer’s request to receive only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Education Cloud: Honor your constituents’ wishes when they request only specific forms of contact from your institution or opt-out of certain types of data-sharing.
Consent Management for Financial Services Cloud: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Loyalty Management: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Health Cloud: Respect your customers’ wishes when they request only specific types or hours of contact or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Heroku: Honor your customers’ wishes to receive only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Marketing Cloud Engagement: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Account Engagement: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or to opt-out of certain types of data sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for the Salesforce Platform: Respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Quip: We can help you honor your customer’s request to receive only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Sales Cloud: Honor and respect your customers’ wishes when they request only specific forms of contact from your company or opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consent Management for Service Cloud: Respect your customers’ requests to limit types and hours of contact. And honor customer wishes when they opt-out of certain types of data-sharing. We provide details to help you determine the best way to comply with the data protection and privacy regulations that apply to your company.
Consolidation of Fixed-Type, Non-Qualifying Points for Expiration: Automate the consolidation and expiry of fixed-type, non-qualifying points of members. You can consolidate members' points in the Loyalty Aggregated Point Expiration Ledger object in real time or in batches. By aggregating non-qualifying points in the Loyalty Aggregated Point Expiration Ledger object, you can decouple the points expiration process from the Loyalty Ledger records.
Control Who Sees What in Loyalty Management: Your Salesforce admin enables Loyalty Management in your org. When enabled, users have edit access to loyalty objects and records. Users can create profiles and assign permissions to access loyalty application as appropriate.
Controlled Setting Edition: What’s Different or Unavailable in Controlled Setting Edition: Controlled Setting Edition and Controlled Setting products are versions of Salesforce applications that give customers enhanced control of data flows within Salesforce. The Controlled Setting Edition restricts the use of features that require connections outside of Salesforce. Because of this isolation restriction, some features are unavailable. Controlled Setting Products also restrict the use of features that require external connections or that are turned off by default.
Control Login Access Policies: Control whether your users are prompted to grant account access to Salesforce admins, and whether users can grant access to publishers.
Create Price Protection Programs: Create and configure Price Protection programs to manage price adjustments and credits and debits through a structured, multi-step process.
Create a Batch Job to Process Transaction Journals: After setting up the flow to credit points to loyalty program members, create a batch job to process the flow. This batch job only processes transaction journal records that are in pending status.
Create a Custom Preference Center: Improve your customer relationships by synchronizing the Salesforce core Individual object with the Marketing Cloud Engagement profile center and subscription center.
Configurations: Use these configurations to create a custom preference center.
Design Considerations: Keep these design considerations in mind when you create a custom preference center.
Workflow: Learn how data flows through the configurations when you create a custom preference center.
Create a Dataset Link: A decision table can decide the outcome for object records specified as dataset links. A dataset link defines a mapping between a decision table’s input fields and fields in a source object.
Create an External Client App: Create an external client app in App Manager. Local external client apps are available only on the org where you create them. Packageable external client apps can be packaged for distribution to other orgs.
Create a Loyalty Tier: Create a loyalty tier to categorize members based on their activities in the loyalty program.
Create a Loyalty Tier Group: Create a loyalty tier group for the hierarchical grouping of the tiers in your loyalty program.
Create a Promotion: You can create loyalty promotions and use reward vouchers and loyalty points to acquire new customers or engage existing customers. You can define the type of the promotion, the loyalty program associated with the promotion, whether enrollment is required for the promotion, and the promotion’s start and end dates. You can also define how to reward the members upon fulfilling the requirement of promotion by vouchers or credit points, and the status of the promotion.
Create a Flow to Credit Points to Members: For example, admins of an airline can set up a batch job to credit points to loyalty program members based on the class of ticket purchased or promotion.
Create Benefit Action: Define the action to execute when a benefit is assigned to a member.
Send Loyalty Promotion Segments to Marketing Cloud Engagement: Use Marketing Cloud Connect or custom import or export jobs to send Loyalty Promotion Segment and Loyalty Promotion data to Marketing Cloud Engagement and send campaigns to the members.
Create Your Loyalty Member Portal: Use the Loyalty Member Portal Lightning template to create a portal for your loyalty members. You can customize the portal using out-of-the-box components provided by the Experience Cloud site. Members can use the portal to view their profile details, including recent transactions, point balance, and current tiers.
Create Member Groups: Individual and corporate members of a loyalty program can be added to a group. As part of a group, members can pool points together. Based on a member's contribution percentage towards a group, the points earned by a member are transferred to the member's groups.
Create Partner Ledgers and Update Partner Balances: The Create Partner Ledgers and Update Partner Balances job calculates and updates partner points for prepaid billing or balance amount for postpaid billing. The definition also creates credit and debit ledgers for partners.
Create Prepaid Points Pack for a Partner: Partners who opt for prepaid billing purchase points from the loyalty program in packs. These points are added to the partner’s purchased points. When a member accrues points for a partner transaction, points are deducted from the partner’s purchased points. Points from the earliest purchased pack are deducted first. If the earlier pack doesn’t have the required points for a transaction, then the points are deducted from the succeeding pack.
Create a Decision Table: Create a decision table and select the object or the custom metadata type that contains the business rules. Select the input fields from the business rules object or custom metadata type that the decision table must read. Select one or more output fields. The output fields contain the values that provide the outcomes.
Create Right to Be Forgotten Policies: Honor individual customer requests to remove or mask sensitive data by creating Right to Be Forgotten policies.
Create and Edit Divisions: Creating logical divisions for your organization helps you segment your records to make searching and reporting easier.
Credit Non-Qualifying Points to Members: The Credit Non-Qualifying Points to Members job calculates and updates a member’s points balance. This process aggregates the points for all non-qualifying currencies credited to the member since it was last run.
Credit Qualifying Points to Members: A Credit Qualifying Points to Members job calculates and credits qualifying points to members. This process credits points awarded to the member since it was last run.
Custom Login Flow Considerations: A login flow directs users through a login process before they access your Mobile Publisher for Experience Cloud app. After Salesforce authenticates a user, the login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When users complete the login flow successfully, they’re redirected to their Mobile Publisher for Experience Cloud site. If unsuccessful, the flow can log out users immediately.
Customized One-Time Password Delivery for Experience Cloud Identity Verification: For more control over identity verification for external users, use a messaging provider of your choice to send one-time passwords (OTPs) via SMS. With a custom messaging provider, you can take charge of your branding. Personalize the content of messages and the SMS short code that shows who sent the message to the user's phone number.
Create a Custom One-Time Password Delivery Apex Handler: Custom one-time password (OTP) delivery relies on an Apex handler that implements the Auth.CustomOneTimePasswordDeliveryHandler interface. Your custom OTP delivery handler calls out to your provider to send an OTP to the user via SMS. You can customize the content of the SMS message and the short code that the user sees.
Custom One-Time Password Delivery Process: If you use a custom one-time password (OTP) delivery provider instead of the Salesforce default provider, your provider sends OTP messages to end users.
Complete Prerequisites to Connect to a Custom One-Time Password Provider: To send a one-time password (OTP) via a custom provider, Salesforce calls an API that's hosted on your provider. To access this API, Salesforce must be able to make authenticated calls to your provider. Get started by retrieving authentication credentials from your provider and registering the provider's callout endpoint with Salesforce. To simplify and secure development, consider creating a named credential that stores the provider's credentials and callout endpoint in a single definition.
Configure Custom Scopes for External Client Apps: Personalize your external client apps by using OAuth custom scopes. Like with connected apps, OAuth custom scopes define the permissions of an external client app to access protected resources hosted by an external entity. External client apps support packaging these custom scopes for distribution.
Customize Deal Approval Notifications: To change notification recipients or message content, create and activate your own version of the Notify Approvers of a Deal flow.
Customize the Welcome Email for Internal Users: For more control over branding, customize the welcome email that internal users, such as employees and contractors, receive when they first access your Salesforce org. To help users meet the email verification requirement, include a verification link in your template.
Provide Maps and Location Services: Maps and location services uses Google Maps to display maps on standard address fields, enables creation of Visualforce maps, and helps users enter new addresses with autocomplete.
Autocomplete Addresses: When you enable autocomplete addresses, users of Salesforce app, Experience Cloud Aura, and Experience Cloud Lightning Web Runtime (LWR) sites can enter text in address fields and see possible matching addresses in a picklist.
Custom Record Page Settings: Customize the experience users have when working with records in Lightning Experience.
Activities View: Choose a default for how activities display on record pages in Lightning Experience. The views focus on different information and behave differently. Users can change their view preference in their personal settings.
Set the Default Activities View: You can set the default view for how users work with activities. Users can change their view preference in their personal settings.
Lightning Experience Record Page Views: Choose the default view for record pages in Lightning Experience. There are two out-of-the-box options, each with a different focus and organization. Pick the view that supports your users’ business needs and preferences.
Customize Reports and Dashboards: Set up reports and dashboards to deliver information to your users in the ways that work best for them.
Customize Report and Dashboard Email Notifications: Enable report and dashboard email notifications to allow all internal and community (portal) users specified as recipients to receive report and dashboard notifications. If this option isn’t enabled, only internal Salesforce users can receive the notifications. This option is available to Enterprise, Unlimited, and Performance Edition organizations that have a Customer Portal or partner portal set up as part of Experience Cloud.
Provide Convenience Features for Your Report and Dashboard Users: You can enable or disable several user interface features that may help your users get more out of reports and dashboards. These settings are for convenience and ease of use; they don’t affect the data returned in your reports and dashboards.
Customize the User Interface: Give your users the best working experience you can by setting up the user interface to meet their needs.
Salesforce Cosmos Theme and SLDS 2 Availability: Salesforce Cosmos is the first theme available in Salesforce Lightning Design System 2 (SLDS 2). Salesforce Cosmos was released as beta in Winter ’25 with the temporary name Enhanced Lightning User Interface (UI). It's a new design that makes Salesforce simpler to use with circular patterns, easy-to-understand icons, new colors, and better typography. Salesforce Cosmos is the default theme of Salesforce Lightning Design System 2.
User Interface Settings: Modify your org’s user interface by enabling or disabling these settings.
Create a List View: To view specific records for an object, create a custom list view. For example, create a list view of accounts in your state, leads with a specific lead source, or opportunities above a particular amount. You can also create views of contacts, leads, users, or cases to use for mass email recipient lists.
Edit List View Filters: Refine or update your list views to make sure that you’re seeing the most relevant records. To change which records display in a list view, edit the list view filters.
Create a Custom List View in Lightning Experience: To see an infinitely scrollable list of records that meet your filter criteria, create a custom list view. You can start from scratch or you can clone an existing list view and then customize it with filters.
Create a List View Chart in Lightning Experience: Create a chart to visualize list view data. There are three types of charts: vertical bar, horizontal bar, and donut. For any list view chart, you can change the data display to another type, if desired. When you create a list view chart for an object, such as Opportunities or Leads, the chart is associated with the object. The chart is available for any list view that you have permission to see for that object, except the Recently Viewed list.
Edit a List View Chart in Lightning Experience: Refine or update your custom list view charts to make sure that you’re seeing the most meaningful data visualizations. There are three types of charts: vertical bar, horizontal bar, and donut. For any list view chart, you can change the data display to another type, if desired.
Transfer Records: You can transfer record ownership in Salesforce using several methods, depending on the object and how many records you want to transfer. Who can transfer a record and which permissions are required depend on whether you’re transferring a single record or multiple records in the same operation.
Data Archive for Loyalty Management: Archiving lets you continue to store files in Salesforce without them being in a library or exposed in search results.
Data Deletion: Delete Personal Data: Get guidance on deleting personal data as you comply with various data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how to best comply with the regulations that apply to your company.
Data Deletion for Analytics: Sometimes it’s necessary to delete a customer’s personal data to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider, so you can comply with the regulations that apply to you.
Data Deletion for Data Cloud: Delete shoppers’ personal data when it's necessary to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that apply to you.
Data Deletion for B2C Commerce and Commerce Marketplace: Delete personal data when it's necessary to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that apply to you.
Data Deletion for Experience Cloud Sites: Sometimes it’s necessary to delete a customer’s personal data to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider, so you can comply with the regulations that apply to you.
Data Deletion for Education Cloud: Delete constituents’ personal data when it’s necessary to comply with various data protection and privacy regulations.
Data Deletion for Financial Services Cloud: Delete customers’ personal data when it’s necessary to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that apply to you.
Data Deletion for Health Cloud: Delete personal data when it’s necessary to comply with data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that apply to you.
Data Deletion for Heroku: Sometimes it’s necessary to delete a customer’s personal data to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider, so you can comply with the regulations that apply to you.
Data Deletion for Loyalty Management: Delete customers’ personal data when it’s necessary to comply with data protection and privacy regulations. Determine a plan of action for complying with the regulations that apply to your company.
Data Deletion for Marketing Cloud: Delete customers’ personal data when it’s necessary to comply with various data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that apply to you.
Data Deletion in Account Engagement: To comply with data protection and privacy regulations, you can delete customers’ personal data. Review these examples of common requests and things to consider. Then make a plan of action to comply with the regulations that apply to you.
Data Deletion for the Salesforce Platform: You can delete customer data to comply with data protection and privacy regulations. These common requests and tips may help you determine how you might use Salesforce Platform features to work toward compliance with the regulations that apply to you.
Data Deletion for Quip: Sometimes it’s necessary to delete a customer’s personal data to comply with data protection and privacy regulations. We give you examples of common requests and things to consider, so you can comply with the regulations that apply to you.
Data Deletion for Sales Cloud: Delete customers’ personal data when it’s necessary to comply with data protection and privacy regulations. We give you examples of common requests and things to consider. That way, you can determine a plan of action for complying with the regulations that matter to you.
Data Deletion for Service Cloud: Delete customers’ personal data collected in customer service cases and other support records to comply with data protection and privacy regulations. We give you examples of common customer requests, so you can determine a plan to comply with the regulations that matter to you.
Data Detect: Data Detect helps you identify sensitive data within your org so you can take steps to protect it. It uses native platform-native technology so that you don’t rely on third-party services or port your data outside of Salesforce. Use Data Detect to expedite data categorization by aligning data sensitivity levels and categories to actual field data.
Data Detect Considerations: Here are suggestions for improving your organization’s security posture around sensitive information handling.
Create and Run a Scan: Create a Data Detect scan policy to find sensitive data that users inadvertently enter into fields across your Salesforce Org. Run scans to detect instances of the custom patterns.
Create a Data Detect Policy and Run a Scan: Data Detect scans search for sensitive data across selected objects and fields. Create multiple policies that help you find sensitive data that users inadvertently enter into fields across your Salesforce org.
Use Custom Keywords in Data Detect Scan Policies: Use Data Detect Keywords to extend data governance capabilities in Salesforce by enabling precise, high-speed scanning for exact keywords and phrases within records. You can define dictionaries of specific terms such as proprietary internal codes, prohibited marketing terms, or foul language, identifying them across objects and fields. Use custom keywords or keyword dictionaries in addition to the provided sensitive data categories.
Use Custom Patterns in Data Detect Scan Policies: Use regular expressions to define your own custom patterns for detecting sensitive data for each Data Detect scan policy in addition to the provided sensitive data categories. Some custom patterns that you can use include organization-specific information such as student IDs, employee IDs, or contract numbers. Scan results include instances of the custom patterns detected.
Data Detect Legacy-Managed Package: Data Detect legacy-managed package helps you identify sensitive data within your org so you can take steps to protect it. It uses native platform-native technology so that you don’t rely on third-party services or port your data outside of Salesforce. Use Data Detect legacy-managed package to expedite data categorization by aligning data sensitivity levels and categories to actual field data.
Grant User Access to Data Detect: Give users access to all policy actions, such as editing policies or viewing all records related to a Data Detect job session.
Resume a Scan: Resume scans that skipped, timed out, completed with errors, or you’ve stopped. Resume the scan to finish scanning the remaining records without running a new scan and scanning records that already have results.
Act on Data Policy Scan Results: After you've reviewed the Data Detect scan policy results, use them to bolster your data security and privacy strategy, especially with specific fields that have excessively sensitive data.
View Sensitive Data Excerpts: Quickly identify the nature and exact location of sensitive data, spot false positives, and manage records. Multiple instances of sensitive data found within a single field get grouped and categorized. Users with a specific permission can trigger an asynchronous, results export, including sensitive excerpts, via a CSV file for auditing and compliance requests.
Schedule a Recurring Scan: Schedule recurring scans to eliminate manual effort and ensure continuous oversight. Data Detect scans mitigate risks and help you to meet compliance requirements with your sensitive data.
See and Act on Scan Results: You can view your results for any sensitive data that was detected. After you've reviewed the Data Detect scan policy results, use them to bolster your data security and privacy strategy, especially with specific fields that have excessively sensitive data.
Understand Data Categories Available in Data Detect: Sensitive data categories are multilevel validations used to detect sensitive data within the Salesforce org. Data Detect supports these types of sensitive data categories. A scan policy searches for any categories that you select, so only use the ones that you need.
Stop a Running Scan: Stop a scan before it finishes to run a different scan or edit the policy settings and run the updated scan policy.
Scanning Data 360 with Data Detect: Use Data Detect to scan Data 360 for sensitive data. Data 360 eliminates data silos, creating a single platform to access all of your organization data. Use Data Detect to scan and detect sensitive data in large batches within Data 360 to facilitate the correct handling of sensitive data. Selecting a DLO automatically targets all of its text fields. A single scan policy execution supports up to 100 DLOs.
Use Data 360 with Data Detect: Use a Data Detect scan policy with Data 360 to scan and detect sensitive data in large batches and to ensure it's properly handled. Use of Data Detect consumes credits used for billing in Data 360 usage types.
Data Import Wizard: You can use the Data Import Wizard to import accounts, contacts, leads, solutions, campaign members, person accounts, and custom objects. You can import up to 50,000 records at a time.
Data Loader: Data Loader is a client application for the bulk import or export of data. Use it to insert, update, delete, or export Salesforce records. When importing data, Data Loader reads, extracts, and loads data from comma-separated values (CSV) files or from a database connection. When exporting, Data Loader outputs CSV files.
Add Objects to a Data Management Policy: To define which records your Data Management Policy masks or deletes, add one or more objects. You can apply unique record filters and data transformation rules to each object on a policy.
Create a Data Management Policy: Create and save a new Data Management Policy. After your policy is created, you can give it objects to process.
Mask, Delete, or Retain Data with Data Management Policies: Data privacy laws such as the General Data Protection Regulation (GDPR) requires businesses to minimize the amount of personal data stored. For the data that businesses choose to store, they can be required to pseudo-anonymize or anonymize that data as much as possible. To stay compliant with privacy law, businesses can use the Data Management Policies feature in Privacy Center to automate how data is deleted, masked, or retained.
How to Use Data Management Policies: Use Data Management policies to remove or mask data that you no longer want to store. Common reasons to transform data include when a data subject is no longer a customer or when data has aged out of use in your system. Included are examples of how to use Data Management policies for these use cases.
Monitoring Scheduled Jobs: The All Scheduled Jobs page lists all reporting snapshots, scheduled Apex jobs, and dashboards scheduled to refresh.
Cache Lightning Platform Data: Using the Platform Cache can enable applications to run faster because they can store reusable data in memory. Applications can quickly access this data, removing the need to duplicate calculations and requests to the database on subsequent transactions.
Set Up a Platform Cache Partition with Provider Free Capacity: Salesforce provides 3 MB of free Platform Cache capacity for security-reviewed managed packages. This is made available through a capacity type called Provider Free capacity and is automatically enabled in all Developer edition orgs.
Request a Platform Cache Trial: To test performance improvements by using Platform Cache in your own org, you can request trial cache for your production org. Enterprise, Unlimited, and Performance editions come with some cache, but adding more cache often provides greater performance. When your trial request is approved, you can allocate capacity to partitions and experiment with using the cache for different scenarios. Testing the cache on a trial basis lets you make an informed decision about whether to purchase cache.
Data Access and Portability: Give Customers Their Data when They Want It: Export customer-related data when customers request it, so that you can work toward complying with various data protection and privacy regulations. We give you examples of common customer requests and things to consider when you evaluate your compliance with the regulations that apply to you.
Data Access and Export for Analytics: Export customer-related data when customers request it, so that you can work toward complying with various data protection and privacy regulations. We give you examples of common customer requests and things to consider when you evaluate your compliance with the regulations that apply to you.
Data Access and Export for Accounting Subledger: When your customers or constituents request it, prepare and pack up the data you've received from them to work toward complying with various data protection export requirements.
Data Access and Export for Data Cloud: When your customers request it, give them access to the data you’ve received from them to work toward complying with data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for B2C Commerce and Commerce Marketplace: When your customers request it, give them access to the data you’ve received from them to work toward complying with data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Experience Cloud Sites: Your customers can request a copy of the data we received from them. To work toward complying with various data protection and privacy regulations, export the data and pack it up. We’ve given you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Education Cloud: When your constituents request it, prepare and pack up the data you’ve received from them to work toward complying with various data protection and privacy regulations.
Data Access and Export for Financial Services Cloud: When your customers request it, prepare and pack up the data you’ve received from them to work toward complying with various data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Health Cloud: Your customers can request a copy of the data received from them and stored in Health Cloud. To work toward complying with various data protection and privacy regulations, export the data and pack it up.
Data Portability for Heroku: Your customers can request a copy of the data we received from them. To work toward complying with various data protection and privacy regulations, export the data and pack it up. We’ve given you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Loyalty Management: When your customers request it, prepare and pack up the data you received from them to comply with data protection and privacy regulations. Determine the best way to work toward complying with the regulations that apply to your company.
Data Access and Export for Marketing Cloud Engagement: When your customers request it, prepare and pack up the data you’ve received from them to work toward complying with various data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export in Account Engagement: When your customers request that you share the data you’ve received from them, Account Engagement offers tools to help you comply with data protection and privacy regulations. Review these examples of common customer requests and things to consider. Then determine how best to comply with the regulations that apply to your company.
Data Access and Export for the Salesforce Platform: You can use the Salesforce Platform to help you honor your customers’ requests to prepare or package their data. We give you examples of common customer requests and tips. Then you can decide how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Quip: Your customers can request a copy of the data we received from them. To work toward complying with data protection and privacy regulations, export the data and pack it up. We’ve given you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Sales Cloud: When your customers request it, give them access to the data you’ve received from them to work toward complying with data protection and privacy regulations. We give you examples of common customer requests and things to consider. That way, you can determine how best to work toward complying with the regulations that apply to your company.
Data Access and Export for Service Cloud: When requested, provide the data you’ve received from your customers on cases and work orders to comply with various data protection and privacy regulations.
Data Processing Engine Definitions for Loyalty Management: Loyalty App provides out-of-the-box templates that can process high-volume jobs. These templates help calculate the point balance, reset qualifying points, and expire points for your loyalty program members. The out-of-the-box job templates are enabled through Data Processing Engine.
Data Protection and Privacy: Work your way toward complying with data protection and privacy regulations. Here, you can find resources that describe common data security practices and regulations.
Create and Customize Retention Policies for Data and Storage: Use the Retention Policies feature to create policies that copy customer data and store it. You can also make PII anonymous in your org and in the data retention store. Or, you can delete data from your org when it copies to the retention store. Choose to anonymize fields or records by replacing them with random characters or mock data.
Data Retention Policies: Create data retention policies with the Data Retention feature. Using Heroku for data processing and storage, these policies automate how PII is stored, retained, and anonymized in Salesforce.
Satisfy Data Subject Access Requests: The Data Subject Access Request feature in Privacy Center addresses your customers’ right to obtain a copy of their personally identifiable information (PII).
Mass Update Addresses: When your data is consistent, your reports and related metrics are more accurate and easier to understand. For example, having different abbreviations for a country/territory or state can skew your data. To make your addresses consistent, you can update country/territory and state/province information in existing fields at one time.
Tips for Mass Updating Addresses: To save time and ensure that your filter settings are up-to-date, use these tips when you mass update country/territory and state/province information in existing address fields.
Database Insights: Fix expensive SOQL queries and reduce database time.
Default Field Mapping for ACT!: ACT! fields map to Salesforce account and contact import fields during an individual data import.
Default Field Mapping for Outlook: Outlook fields map to Salesforce account and contact import fields during an individual data import.
Delete an External Client App: Delete the external client app from the org where it was created. Deleting an external client app breaks all integrations that use that app.
Delete Site Association: You can delete an Experience Cloud site association with your loyalty program.
Delete Trial Data: When you sign up for Salesforce, your Salesforce org is initially populated with sample data. During your trial period, Salesforce admins can delete the sample data and all your org’s data by using the Delete All Data link.
Deploy a Local External Client App: All external client apps are created using deploy and retrieve operations in the Metadata API. After configuring the package.xml file, deploy the external client app.
Deploy External Client App Metadata Between Two Orgs: Because the settings file and global settings file are separate elements of external client apps, you can update the settings file and deploy it to another org without affecting the authorization settings.
Deploy the External Client App OAuth Plugin: After configuring the OAuth settings file and the global OAuth settings file, deploy the changes to update the external client app.
Deploy an External Client App That References the Source Org’s Global OAuth Settings File: Deploy an external client app on a new org, and have it reference the source org’s credentials. To configure this relationship, edit the OAuth link in the OAuth settings file and remove the reference to the global OAuth settings file in the package.xml manifest file of the new org.
Deploy an External Client App with a New Global OAuth Settings File: Deploy the source org’s metadata on an org with its own OAuth consumer. To configure the app, remove the OAuth link in the OAuth settings file and add a reference to the global OAuth settings file in the package.xml manifest file on the new org.
Deployment Insights: Compare org performance before and after deployment to identify regressions introduced by recent changes.
Design Registration Flow: Enable partners to submit new design registrations efficiently, while making sure that all relevant records, such as indirect deal partners and product line items, are captured accurately.
Design Web-Embedded Forms with CSS: With Preference Manager, you can embed consent and preference forms on external websites and on Salesforce-hosted pages like Visualforce, Lightning Web Components (LWC), and Experience Cloud sites. To design your forms with custom branding and layouts, use Cascading Style Sheets (CSS) and custom CSS classes. To apply custom styles, define CSS rules in your website’s global stylesheet or apply inline styles on Salesforce pages to control the appearance of specific form elements.
The System Overview Page: The system overview page shows usage data and limits for your organization, and displays messages when you reach 95% of your limit (75% of portal roles).
Device Activation for Experience Cloud Sites: To add extra verification to unfamiliar login attempts, set up device activation for your Experience Cloud site. With device activation, Salesforce challenges users to verify their identity when they log in from an unrecognized browser or device.
Device Activation for Salesforce Orgs: Device activation is a security measure that helps prevent unauthorized access to your org. Device activation works by requiring extra identity verification for unfamiliar login attempts. For employees logging in to your org, device activation is automatically enabled and can't be turned off.
Disconnect Salesforce Authenticator from a User’s Account (Salesforce Orgs): Only one Salesforce Authenticator mobile app can be connected to a user’s account at a time. If a user loses or replaces the mobile device where Salesforce Authenticator was installed, you can disconnect the app from their account. If a user’s app stops working, reset it by disconnecting the app; then ask the user to restore the app’s connection to their account by re-registering it. It’s also a good security practice to disconnect all of a user’s verification methods if they leave your company.
Get More Accurate Trend Analysis and Operational Reporting with Salesforce Discover: Using your company’s historical data, Salesforce Discover helps you forecast buying patterns, uncover sales trends, and unlock customer insights to answer key business questions and drive smarter decisions. Optimized data extraction and transformation means that you can scale efficiently without escalating costs.
Assign Licenses for Installed Packages: To give users access to a package that you installed, assign licenses in Setup. If you purchased a site license or if the managed package isn't licensed, Salesforce assigns licenses to all your users and you can’t manage licenses. Your users can use the package as long as they have the appropriate permissions.
Configure Installed Packages: Many components have an isDeployed attribute that controls whether they’re available for end users. After installation, all components are immediately available. Before making the package available to your users, make any necessary changes for your implementation.
Extend Your Org with AppExchange Packages: Extend the power of Salesforce with AppExchange solutions. You can find solutions that help employees across roles, departments, and industries do their jobs more effectively and efficiently. These solutions impact people in ways both small and large, automating tasks, consolidating information and systems, and more closely integrating systems with Salesforce.
Install a Managed Package: Installing a managed package from AppExchange in your Salesforce org is straightforward. First, install the managed package, and then configure it for your environment and users.
Respond to License Manager Requests: A license manager is a Salesforce org that tracks all Salesforce subscribers installing a particular AppExchange package.
Namespace Permission Set Licenses in Packages: If you install a managed package that has an associated namespace permission set license, you can use it to entitle users access to one or more packages in that namespace. Namespace permission set licenses function in a similar way to managed package licenses.
Manage Licenses for Installed Packages: When you install a licensed managed package from AppExchange, you purchase a certain number of licenses from the provider. You can assign each license to a user within your org. If you assign all available licenses, but want to grant licenses to additional users, you can reassign a license, or purchase more. To get more licenses, contact the provider of the managed package.
Manage Installed Packages: Manage packages installed in your Salesforce org, including assigning licenses to users, uninstalling packages, and exporting package data.
View Installed Package Details: View key details about a package installed from AppExchange, such as the number of custom apps, tabs, and objects that it uses. You can also assign licenses to users, uninstall the package, and purchase the package.
Request a Package Usage Summary: Discover whether your company is taking advantage of AppExchange packages that you installed by reviewing usage summaries. Usage summaries are available for managed packages that passed security review. Usage summaries provide a monthly aggregate view on how your users interacted with these packages. Events from sandbox, scratch, and trial orgs aren’t tracked in package usage summaries.
Import Package Data After Uninstalling a Package: When you uninstall a package, Salesforce automatically creates an export file containing the package data as well as any associated notes and attachments. If you choose to install the package again, you can import this data.
Remove Licenses for Installed Packages: If an individual or group at your company no longer needs access to a package, you can remove their licenses so they’re available for others to use.
Uninstall a Managed Package: Uninstalling a managed package removes its components and data from the org. During the uninstall process, any customizations, including custom fields or links, that you’ve made to the package are removed.
Upgrade Your Managed Package: Salesforce supports upgrades for managed packages only. Providers can publish an upgrade for a managed package and notify installers that the new version is available.
My Domain URL Formats: Your My Domain name is a subdomain used in login URL and application URLs across your Salesforce org, including sites and Visualforce pages. Understand what determines your org’s URL formats and the structure of those formats.
Update Authentication After a My Domain Change: Determine whether your My Domain change requires that you update your authentication settings. Then learn about the authentication settings that can be impacted after a My Domain change and make the required updates. If your My Domain login host name or sites host name changed when you deployed a My Domain change, update your authentication settings.
Update Your Auth Provider or OpenID Connect IdP Configuration After a Login URL Change: After you deploy a My Domain change that updates your My Domain or site login URL, OpenID Connect single sign-on (SSO) authentication stops working. OpenID Connect SSO options include Authentication Providers. To allow your users to use this SSO method again, work with your identity provider (IdP) to update your configuration.
Update Your SAML SSO IdP Configuration After a Login or Site URL Change: After you deploy a My Domain change that updates your My Domain login URL or site URL, SAML Single Sign-On (SSO) authentication stops working. To allow your users to use this SSO method again, work with your Identity Provider to update your configuration.
Update Named Credentials After a My Domain Change: To simplify the setup of authenticated callouts, you can use a named credential as the callout endpoint. When your My Domain login URL or site login URL changes, named credentials that use that URL stop working. Because DevOps Center uses named credentials, you can’t access DevOps Center environments when the org’s My Domain login URL changes. To reestablish the impacted authentication callouts, update the URL field for the affected named credentials.
Update Service Provider Endpoints After a Login or Site URL Change: When Salesforce acts as an Identity Provider, users can log in to the external service provider or relying party with credentials from your Salesforce org. For example, your users log in to a custom app with their Salesforce credentials or their Experience Cloud site credentials. When your My Domain or site login URL changes, authentication methods that rely on that URL stop working. To restore this authentication method for your users, share the updated endpoints with the third-party service providers.
Brand Your Salesforce Org’s Domains: Understand how to include your brand in the URLs used to access your Salesforce org and its data with My Domain, Experience Cloud sites, Salesforce Sites, and custom domains.
My Domain Considerations: When you deploy a change to your My Domain, it’s important to understand the impact on URLs across your Salesforce org. Review these considerations about URL changes, feature testing, and reducing the impact to your users.
Update Your Org and Test My Domain Changes: Before you deploy a change to your My Domain, work with your users to preserve their login access to your org. To test My Domain changes, deploy the change in a sandbox. If your My Domain login URL or site URL changes, update authentication. Review and make the required updates to support the new domains. Then test access to your org and your functional workflows in Salesforce. After you complete testing in a sandbox, use the same process to update your production org. Finally, update redirection behavior for your old URLs.
Salesforce Edge Network: Enhance global access, performance, and security with Salesforce Edge Network. Users access your Salesforce data from all over the world, and Salesforce Edge Network delivers them a consistent experience regardless of their location.
Route My Domain Through Salesforce Edge Network: Route your My Domain through Salesforce Edge Network to improve security and user experience. Salesforce Edge Network is required to ensure a consistent experience for your users regardless of their location.
Understand Salesforce Edge Network: Salesforce Edge Network is a network technology that improves download times for users around the globe and provides security protection to Salesforce organizations. Users get a better network experience while remaining on the Salesforce trusted infrastructure, which protects, uses, and processes data appropriately and in accordance with the law.
Enhanced Domains: Enhanced domains are the current version of My Domain that meets the latest browser requirements. With enhanced domains, all URLs across your org contain your company-specific My Domain name, including URLs for your Experience Cloud sites, Salesforce Sites, Visualforce pages, and content files. This feature changed domain suffixes (the part after the My Domain name) to meet the latest security standards. With no instance names, enhanced My Domain URLs are easier for users to remember and don’t change when your org is moved to another Salesforce instance. Because enhanced domains meet the latest browser requirements, this feature was enforced in Winter ’24.
Considerations for Enhanced Domains: Before you enable and deploy enhanced domains, understand the prerequisites. Learn about how URLs, including public-facing URLs, change across your org with enhanced domains. Review recommendations for preserving access to your org during the change, learn about redirections, and understand how enhanced domains improve your Experience Cloud sites.
Enhanced Domains Timeline: To prevent disruption for your customers and users, review the enhanced domains timeline and prepare for upcoming changes. Redirections for legacy host names stopped in production and demo orgs in Spring ’26. And in Winter ’27, Salesforce ends support for API traffic that uses an incorrect instanced URL.
Why Enhanced Domains: When you deploy enhanced domains, most of the application URLs for your Salesforce org change. Those changes require testing and impact public links, such as Experience Cloud sites. Understand why Salesforce requires that all customers adopt this new standard, and learn how enhanced domains meet the latest browser requirements.
Get Your Org Status and Upcoming Maintenance Dates with My Domain: Get information about system performance and availability from trust.salesforce.com. This trust page reports status information based on your Salesforce instance. If you don’t know your instance, use your My Domain name to look it up.
Update Your Org for My Domain Changes: When you deploy a change your My Domain, your Salesforce org’s login URL and application URLs change. URLs that are dynamically constructed—for example, URLs generated via the DomainCreator Apex class—use the new URLs automatically. However, some Salesforce functionality requires an update to work with your new URLs. Similarly, custom code, your network configuration, and third-party integrations that use the old URLs require updates. To ensure a smooth transition to your new URLs, update references to your old URLs.
My Domain Host Names: Understand the purpose of each host name that Salesforce serves for your org.
Customize Your My Domain Login Page with Your Brand: My Domain gives you a point-and-click way to brand the page that prompts users to log in to your Salesforce org. You can replace the Salesforce logo with your own and change your background and login button colors. You can also display content to the right of your login form. Branding options apply to the entire login experience, including pages for users to verify their identity and reset passwords. They also apply to login flows.
Preserve Login Access During a My Domain Login URL Change: When your My Domain or site login URL changes, two multi-factor authentication (MFA) verification methods stop working: built-in authenticators and security keys. Without those methods, single sign-on (SSO) can also stop working. To preserve admin access to Salesforce and prevent end-user frustration, verify your backup authentication methods. In preparation for your My Domain change, determine the post-deployment steps to reestablish authentication for your org, including resetting the affected verification methods for your users.
Log In to Salesforce with Code: For an extra layer of security, use your My Domain login URL to access your Salesforce org with code. Compare the benefits of your My Domain login URL versus the default Salesforce login URL. And understand why we recommend that you update the login URLs that contain your Salesforce instance.
Create an Interview-Based Login Page with My Domain Login Discovery: Configure My Domain with Login Discovery to simplify the login process for users. Login Discovery is sometimes called interview-based login because it’s a two-step process. First, users identify themselves with an email address or phone number at the login page. Next, users verify themselves depending on the identifier entered. Users can verify themselves with a password, their single sign-on (SSO) credentials, or Lightning Login. You set up Login Discovery from the My Domain Setup page after you create an Apex class that implements the MyDomainLoginDiscoveryHandler interface.
Add Identity Providers to the My Domain Login Page: Users can authenticate with alternate identity provider options from your My Domain login page. If you enabled single sign-on (SSO) and configured SAML, or if you set up external authentication providers, you can display them on the login page. Users are sent to the identity provider’s login screen to authenticate and then redirected to Salesforce.
Customize Your My Domain Login Page for Mobile Auth Methods: By default, mobile apps built with Salesforce Mobile SDK use standard authentication. With standard authentication, a user logs in and approves access to their Salesforce data within the mobile app. For improved security and better performance on mobile apps, configure advanced browser-based authentication from the My Domain Setup page. With browser based-authentication, mobile users are taken to their native browser for authentication. After they log in and approve data access, they’re redirected to the mobile app.
Move a My Domain Name to a Different Org: You can’t use an existing My Domain name in a new org, even if you own the org where that name is currently in use. To make the My Domain name available for a new org, first remove the name from the old org
My Domain: Showcase your company’s brand with a customer-specific subdomain name in your Salesforce org URLs. With My Domain, you can include your company name in your URLs, for example, https://mycompany.my.salesforce.com. With these org-specific URLs, you can set up a custom login page, set a custom login policy, offer single sign-on, and allow users to log in with a social account. My Domain also allows you to work in multiple Salesforce orgs in the same browser at the same time.
Link to Salesforce Domains in Packages: If you provide a package to Salesforce customers through AppExchange, review your code for hard-coded URLs and code that parses a known URL. The URLs that Salesforce serves for a target org vary based on the org type and configuration. Hard-coded URLs and code that assumes the format of a URL can break when a customer deploys enhanced domains, deploys partitioned domains, or changes their My Domain name. Also, URL formats vary between production orgs, sandboxes, and other non-production orgs. To ensure that your package functionality continues to work with all possible URL formats, update hard-coded URL references to relative URLs whenever possible. When a relative URL isn’t possible, use a dynamically generated host name.
Partitioned Domains: With partitioned domains, My Domain host names for your Developer Edition org, demo org, patch org, sandbox, scratch org, or Trailhead Playground include a word related to the org type. For example, partitioned domains for Developer Edition and patch orgs include the word develop. Partitioned domains allow Salesforce to maximize the availability of your orgs by gradually rolling out delivery changes. And it’s easier to identify an org by a URL when the domain is partitioned.
Partitioned Domains for Developer Edition Orgs: Review the login and application domains that Salesforce hosts for Developer Edition orgs with partitioned domains. New Developer Edition and patch orgs are partitioned by default.
Partitioned Domains for Demo Orgs: Review the login and application domains that Salesforce hosts for demo orgs with partitioned domains.
Enable Partitioned Domains: To maximize the availability of your orgs, enable and deploy partitioned domains for your My Domain in your existing Developer Edition org, demo org, patch org, sandbox, scratch org, or Trailhead Playground. Partitioned domains allow Salesforce to gradually roll out service delivery changes by org type. When a domain is partitioned, it includes a word related to the org type, which also makes it easier to identify an org by a URL.
Partitioned Domains for Patch Orgs: Review the login and application domains that Salesforce hosts for patch orgs with partitioned domains.
Partitioned Domains for Trailhead Playgrounds: Review the login and application domains that Salesforce hosts for Trailhead Playgrounds with partitioned domains. New Trailhead Playgrounds are partitioned by default.
Partitioned Domains for Sandboxes: Sandboxes with enhanced domains use the sandbox partition. Review the login and application domains that Salesforce hosts for sandboxes.
Partitioned Domains for Scratch Orgs: Review the login and application domains that Salesforce hosts for scratch orgs with partitioned domains. New scratch orgs are partitioned by default.
Plan for a My Domain Change: Whether you change your My Domain to update your brand, to adopt enhanced domains, or to enable partitioned domains, the URLs that Salesforce hosts for your org change. Those changes can have a large impact, and making the required updates can seem like a daunting project. To make the process as smooth as possible for you, your users, and your customers, review the high-level steps, the recommended practices, and how to reduce the impact on your users and customers.
Example My Domain Change Checklists: Review example checklists for a My Domain change, including a project checklist, pre-deployment checklist, and post-deployment checklist.
Notify Users and Customers About a My Domain Change: A My Domain change can impact users who log in to your Salesforce org, and it can impact external users, such as visitors to your Experience Cloud sites. Review recommendations about communicating to these groups before and after you deploy the change.
Prepare for and Schedule a My Domain Change: To prepare for a My Domain change, first gather the key information: the required updates, testing, and participants. Then review the deployment process for a My Domain change, identify your testing environment, and schedule your testing and production deployment.
Understand the My Domain Change Process: Review the high-level process to successfully deploy a change to your My Domain. The change can include a My Domain name change, enhanced domains, or partitioned domains.
Review Recommended Practices for a My Domain Change: Before you deploy a change to your My Domain, consider configuring a custom domain to serve your sites, and review your My Domain settings. Review recommendations for testing and go-live plans. Understand the steps that you can make only after you deploy a My Domain change, and follow recommendations to minimize disruption during your deployment. After you complete testing, notify users, enable redirection logging, and determine when to disable redirections.
My Domain Redirections: When you deploy a change to your My Domain, Salesforce redirects multiple host names automatically. Learn about the types of redirections, how to log redirections for the host names that Salesforce hosts for your org, and how you can control these redirections.
Log My Domain Host Name Redirections: To reduce disruption, Salesforce redirects multiple host names automatically when you deploy a change to your My Domain. To track blocked and successful redirections for your My Domain host names, enable event logging for these redirections.
Manage My Domain Redirections: Control whether to redirect users who visit your previous My Domain URLs to the current My Domain URL. To help your users adopt the new URLs after a My Domain change, optionally turn on a brief message during My Domain URL redirections. And test the end of support for incorrect instanced URLs in API traffic.
Prepare for the End of Redirections for Non-Enhanced Domains: After enhanced domains deployment, your previous non-enhanced host names were redirected. In Winter ’25, Salesforce stopped redirections for legacy (non-enhanced) My Domain URLs in Developer Edition orgs, patch orgs, scratch orgs, Trailhead Playgrounds, and existing sandboxes. Redirections for those legacy URLs stopped in Spring ’26 in all orgs, including production orgs. If your org was created before October 2020, Salesforce also stopped redirections for host names that contained your instance name but not your My Domain. And in Winter ’27, support ends for incorrect instanced URLs in API calls. Review the affected host names and how to test for the end of these redirections.
Understand Redirections for Previous My Domain Host Names: After you deploy a change to your My Domain, Salesforce redirects your previous My Domain host names. If your org was created before Summer ’22, enhanced domains were deployed in your org and some of those redirections were temporary. And if your production org or demo org was created before Summer ’20, host names that contained your Salesforce instance could be redirected. Learn more about these redirections and how to control them.
Disable or Remove Your Previous My Domain: Each time that you deploy a change to your My Domain, Salesforce redirects requests from your previous My Domain URLs to your current My Domain. Optionally, disable redirections from your previous My Domain. We recommend that you use that option when you test a My Domain change. Or, to use your previous My Domain in a different Salesforce org, remove your previous My Domain.
Change Your My Domain Details: If you don’t like your My Domain or circumstances warrant a change, you can rename it. For example, you can change the name when your company’s name or branding changes. In some orgs, the admin can also choose a different domain suffix, enable enhanced domains, and remove instance names from certain My Domain URLs.
Set the My Domain Login Policy: Manage how users and API calls access your Salesforce org. Specify whether logins to your org require your My Domain. And choose what users see when they access a bookmark or link that contains your instance-specific domain.
Configure My Domain Settings: Customize your login page with your brand and determine the user experience when they log into your Salesforce org via your My Domain.
My Domain Provisioning and Deployment: Understand the provisioning and deployment process when you deploy a change to your org’s My Domain. Learn about how each step of the process impacts your user’s access to Salesforce and why it’s important to test these changes in a sandbox.
Test My Domain Changes: Follow these guidelines to test My Domain changes and to ensure a smooth transition to the new My Domain URLs.
Deploy My Domain Changes: After you change your My Domain and Salesforce provisions those changes, deploy your org’s new My Domain. Only after you deploy your new My Domain can you test your new URLs. And your users can’t use the new My Domain URLs until you deploy the updated My Domain.
My Domain URL Format Changes with Enhanced Domains Deployment: Understand how login and application URL formats changed when enhanced domains, the latest version of My Domain, were deployed. These changes apply only to orgs created in June 2022 or earlier.
What Determines Your URL Formats: Understand how your My Domain affects the login and application URLs for your Salesforce org, and learn about enhanced domains. Review the impact of stabilizing certain URL formats when you have a My Domain.
Dynamic Parameters for Loyalty Actions: When you define an action in the Promotion Setup rules for a loyalty program process, you can create process parameters to pass the input values either dynamically or by selecting inputs from a fixed set.
How Salesforce Uses Your Data for Business Value Metrics: Salesforce is always working to improve our products. One of the ways we accomplish that goal is to analyze which products and features have the biggest impact on customer success. What we learn lets us improve your product experience to better help you and your business grow.
Getting Started: Learn how to use sales, service, and marketing features, even if you’re new to Salesforce or customer relationship management. Find and organize your imported data by searching, navigating tabs, and organizing your data. Easily keep information current with intuitive work spaces.
Salesforce Suites: Grow your business faster with our all-in-one customer relationship management suites, perfect for small and medium-sized businesses.
Choosing the Right Salesforce Suites Edition For You: Each Salesforce edition is designed to meet specific business needs, offering different levels of functionality and customization. By selecting the appropriate edition, you ensure you have access to the right tools and features to help your business connect with customers and grow your revenue.
Find Your Edition: Already using Salesforce but not sure which edition you’re using? Use the Company Information page to find your edition.
Learn More About Salesforce Suites: Explore the Salesforce Suites features and tools that help you promote your business, close more deals, solve customer issues, and accelerate growth.
Introduction to Salesforce Suites: Salesforce Suites combine sales, service, marketing, commerce, AI, and Slack functionality into one experience, enabling you to get a 360-degree view of your business and grow your revenue. Get to know customer relationship management and Salesforce Suites.
Promote My Business: Salesforce Suites bring powerful tools into one marketing experience to make the most of customer data and engage the people who follow your brand. A streamlined campaign experience brings contacts and content together, while flows enhance and automate your daily tasks.
Marketing Segments: When you target a group within your audience, we call that a segment. In email campaigns, you can easily build an audience segment with common filters or from a list of campaign members. Segments apply to campaign audiences; the List Sends feature uses Actionable Lists instead.
Close More Deals: With Salesforce Suites, your sales teams have everything they need to communicate with prospects and customers, manage sales details, and close deals.
Solve Customer Issues Faster: With Salesforce Suites, your service teams have all the data and tools they need to help customers, track and manage customer issues, and provide personalized service.
Setup Best Practices: Get your Salesforce org ready for your team, even if you’re new to Salesforce or customer relationship management. Import contacts, connect email accounts, manage sales paths, and invite new users.
Headless Identity APIs: Configure an External Client App for the Authorization Code and Credentials Flow: To integrate with Salesforce Headless Identity APIs, configure an external client app for the Authorization Code and Credentials Flow. Use the External Client App Manager in Setup. Or configure your external client app via Metadata API. External client apps support all variations of the Authorization Code and Credentials Flow, including headless login, passwordless login, registration, and guest user variations.
Limit the Idle Refresh Token TTL in External Client Apps: For improved security, Salesforce requires a 30-day limit to the idle refresh token TTL (time-to-live). The idle TTL is the amount of time that an OAuth refresh token can be inactive before it expires. When a refresh token expires, the user or app must request a new access token. The idle TTL works as a sliding window: each time the token is used within the 30 day-period, its idle TTL resets. For flows that don't use refresh tokens, this control also caps the access token lifetime at 30 days from the last login date.
Manage External Client App OAuth Credentials with AWS Secrets Manager: Maintain credential security as you stage and rotate your client secret with the Amazon Web Services (AWS) Secrets Manager. Using Secrets Manager, the external client app client secret is never exposed. Secrets Manager coordinates the rotation according to the schedule required by your security and compliance mandates.
Edit Trust Notifications: When you want to change the events and instances that you're notified about from Trust Status, edit your Trust notifications.
Edit Conversion Rates: You can manage static exchange rates between your active and inactive currencies and the corporate currency by editing the conversion rates. These exchange rates apply to all currency fields used in your organization. In addition to these conversion rates, some organizations use dated exchange rates for opportunities and opportunity products.
Data Detect: Data Detect is a crucial tool designed to help organizations identify sensitive data within their Salesforce orgs, enabling them to protect it effectively. By using native Salesforce technology, Data Detect ensures that your data remains secure within the platform, eliminating the need for third-party services or data transfers outside Salesforce. This capability significantly streamlines data classification, also by linking data sensitivity levels and categories to actual field data, ultimately empowering users to take necessary protective actions.
Install and Configure the Data Detect Legacy-Managed Package: You can install the Data Detect legacy-managed package in production and sandboxes. After you install the package, configure access controls to make sure that users can access it.
Create a Data Detect Legacy-Managed Package Policy: Data Detect legacy-managed package policies look for data patterns across fields and objects that you select. You can create multiple policies that help you find sensitive data that users inadvertently enter into fields across your org.
Review Data Detect Legacy-Managed Package Scan Logs: Data Detect legacy-managed package scan logs offer insight into whether scans completed successfully. If a scan encountered an error or aborted unexpectedly, logs contain the error message and details about the issue.
View and Classify Results with Data Detect Legacy-Managed Package: You can view the aggregate results of completed scans and see a breakdown of the results by object and field. Results also include data classification assignments, which help you better understand your organization’s data governance posture. See which fields aren’t categorized and add or adjust a field’s category based on the data detected. Data classifications are useful for reporting as well as creating Transaction Security and Shield Platform Encryption policies.
Allow Data Analysis with Einstein Data Exploration Consent: Use Einstein Data Exploration Consent to manage project and object permissions for Salesforce data scientists. With this access, Salesforce can develop and improve your Einstein features. For example, you can see the content that your customers pay attention to and find patterns to best advertise your products or services.
Exclude People’s Personal Data from Modeling and Predictions: If you use Sales Cloud Einstein, Service Cloud Einstein, or Einstein Conversation Insights, it’s easy to honor your customers’ requests to exclude their personal data from factoring into machine learning models, and to stop generating predictions based on their personal data.
Verify Email Addresses with Async Email: Send email messages to internal and external users to ensure they’re registered with a valid email address that they own. Async email messages contain a verification link (URL). Users simply click the link to verify their email address. After verifying their email address, external users can log in with one-time password (OTP) via email (passwordless login).
Considerations for DKIM Keys: Before you create DKIM keys, understand their purpose and how DKIM key rotation and domain matching work.
Create a DKIM Key: DomainKeys Identified Mail (DKIM) is a security standard that attaches a digital signature to your emails to prove that they came from you. With this signature, the receiving server can verify that the message content wasn’t altered or faked during transit. DKIM builds trust with email providers, so your messages are more likely to land in the inbox instead of the spam folder. An active DKIM key verifies your domain ownership so that Salesforce can send email for your users.
Domain-based Message Authentication, Reporting, and Conformance (DMARC): Domain-based Message Authentication, Reporting, and Conformance (DMARC) is an email authentication, policy, and reporting protocol. It’s built on top of Sender Policy Framework (SPF) and DomainKeys Identified Mail (DKIM) protocols. If neither of those authentication methods passes, the DMARC policy determines what to do with the message. Salesforce supports and recommends DMARC. It’s up to you to determine whether you implement it for your domain.
Enable Email Security Compliance: Email Security Compliance updates the envelope from address in emails sent from Salesforce. With this feature enabled, the email header from address is your email address, but the envelope from address is *.bnc.salesforce.com. Salesforce’s Sender Policy Framework (SPF) record authorizes the IPs used by our message transfer agents (MTAs) to send email from our domain. Email sent from Salesforce passes SPF checks even if you don’t have an SPF record for your email domain.
Email Security Mechanisms: Salesforce supports several email security mechanisms: Transaction Layer Security (TLS), Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM), and Domain-based Message Authentication, Reporting, and Conformance (DMARC). Each mechanism protects different aspects of an email message.
Set Up Transaction Layer Security (TLS): Transaction Layer Security (TLS) encrypts the contents of an email transaction during transmission. The sender and receiver can also use it to verify each other's identity. You can choose a TLS setting when sending email through Salesforce or through an email relay.
DomainKeys Identified Mail (DKIM) Keys: Use the DKIM key feature so Salesforce can sign outbound email sent on your company’s behalf. These signatures give recipients confidence that the email was handled in a way that’s consistent with your company. An active DKIM key also verifies your domain ownership so that Salesforce can send email for your users.
Include Salesforce in Your SPF Record: If you don’t enable Email Security Compliance, we recommend that you set up a Sender Policy Framework (SPF) record for your email domain. To pass SPF checks, include Salesforce in that record.
Sender Policy Framework (SPF): The Sender Policy Framework (SPF) email authentication method aims to reduce spam and fraud by making it harder for email senders to hide their identity. SPF detects email spoofing by providing a process to verify who is permitted to send emails on your behalf. SPF improves message deliverability, protects the credibility and reputation of your domains, and enhances user trust and confidence. Salesforce uses SPF and recommends that you do, too.
Enable Context Service: Simplify the sharing and consumption of business application data by using Context Service. Context Service is a general module that connects applications and procedures. It makes it easy to find and use data across different industry clouds at every step of the process.
Enable Data Pipelines: To create and run Data Processing Engine definitions, enable Data Pipelines. With Data Pipelines, you can query and compute the data available in your Salesforce org.
Enable Experience User: Enable a user to log in to the Loyalty Member Portal on the Experience Cloud site.
Let Users Post Dashboard Widgets in Chatter: Dashboard widget snapshots let users post static images of dashboard widgets to Chatter feeds, making the snapshot visible to all users.
Help Users Find Dashboards Quickly: Dashboard finder uses auto-complete to help users quickly find dashboards in the Dashboards tab, just by entering the first few letters of its name in the search filter.
Enable Access to History Objects for a Profile: To view the history of changes related to an object (for example, to view the history of an account or a case), include the history list field in the object’s page layout, enable field-history tracking for the object, and define object-level and field-level permissions on profiles associated with your users.
Settings for Loyalty Processes: You can set Loyalty Management to update non-qualifying points balance of members in real time. Turn on another setting to add template Data Processing Engine definitions to your org and use them to aggregate and expire members' fixed-expiration-model, non-qualifying points. Customer service representatives can engage your loyalty program members better with Loyalty Service Excellence.
Enable an OAuth Plugin: In an external client app, configurations are divided between settings and policies for each plugin. To add an external client app plugin, enable the plugin and configure the settings.
Enable Consolidation of Fixed-Type, Non-Qualifying Points of Members in Batches: You can choose to consolidate member points in batches. After points are credited to members, you can run a Data Processing Engine definition to consolidate members’ fixed-type, non-qualifying points. You can run another Data Processing Engine definition to expire members’ fixed-type, non-qualifying points. When you enable this setting, the system adds two template Data Processing Engine definitions to your org.
Enable Preference Manager Permissions: To give new users access to Preference Manager in the App Launcher, enable Preference Manager permissions. You can assign Preference Manager permissions from Profiles or Permission Sets in Setup.
Configure the Push Notification Plugin: The push notification plugin for an external client app enables a mobile app’s push notifications for an Android or iOS device.
Enable Sentiment Insights: Set up Sentiment Insights to get actionable insights on customer sentiment based on survey responses.
Member Engagement Attributes: With member engagement attributes, you can track long-term member behavior. You can create engagement attributes and track a member's progress in achieving the attribute's target. Also, you can reward members for achieving the engagement attribute target.
Create Engagement Attributes: Create Loyalty Program Engagement Attribute records to define the attributes that you want to track for your members. When defining engagement attributes, decide the members' target for the attribute and when the members' progress is reset for the attribute.
Member Engagement Attributes Workflow: Before you create engagement attributes for your loyalty program, learn about the workflow for engagement attributes.
Associate Engagement Attributes with Promotions: You can create engagement attributes that track member engagement for a specific promotion. For example, you can create an engagement attribute that tracks the number of items that members purchased during a promotion that runs every year on Cyber Monday.
Update Members' Progress for Engagement Attributes: Use actions in loyalty program process rules to update members' progress and reward members for achieving their engagement attribute target. You can also get the details of the members' engagement attribute, and then use the details for other processes.
Track Members' Progress for Engagement Attributes: You can track the progress of each member during the lifespan of an engagement attribute. Use Loyalty Program Member Attribute Value records to track members' progress for engagement attributes.
Test and Troubleshoot Your New Policy: If your transaction security policy isn't behaving as you expect, check out these testing and troubleshooting tips to diagnose the problem.
Transaction Security Actions and Notifications: When a real-time event triggers a transaction security policy, you can block a user or enforce multi-factor authentication (MFA). You can also optionally receive in-app or email notifications of the event.
Create a Transaction Security Policy That Uses Apex: Use Setup to create an transaction security policy that uses Apex. You can specify an existing Apex class or create an empty class that you then code. The Apex class must implement the TxnSecurity.EventCondition interface.
Enhanced Transaction Security Apex Testing: Writing robust tests is an engineering best practice to ensure that your code does what you expect and to find errors before your users and customers do. It’s even more important to write tests for your transaction security policy’s Apex code because it executes during critical user actions in your Salesforce org. For example, a bug in your LoginEvent policy that’s not caught during testing can result in locking your users out of your org, a situation best avoided.
Best Practices for Writing and Maintaining Transaction Security Policies: Transaction security policy management isn’t always easy, especially when you have many policies. To make sure that your policies remain functional, write and maintain them using these best practices. Well-structured and tested policies keep your employees and customers connected, productive, and secure.
Condition Builder Examples: Use these examples to help you convert your own real-world use cases into Condition Builder conditions.
Build a Transaction Security Policy with Condition Builder: Create a transaction security policy without writing a line of code. Condition Builder, available in Real-Time Event Monitoring, gives you a declarative way to create customized security policies to protect your data.
Exempt Users from Transaction Security Policies: If you have transaction security policies that work well for most users, but not all, you can assign specific users the Exempt from Transaction Security user permission. Assign this permission only when transaction security policy metering regularly blocks business-critical actions. For example, assign it to users who make bulk or automated bulk API calls. You can assign this user permission to integration users or admins responsible for transaction security policies who you don't want to get blocked.
Transaction Security Metering: Transaction Security uses resource metering to help prevent malicious or unintentional monopolization of shared, multi-tenant platform resources. Metering prevents transaction security policy evaluations from using too many resources and adversely affecting your Salesforce org.
Transaction Security: Transaction Security is a framework that intercepts real-time events and applies appropriate actions to monitor and control user activity. Each transaction security policy has conditions that evaluate events and the real-time actions that are triggered after those conditions are met. The actions are Block, Multi-Factor Authentication, and Notifications. Before you build your policies, understand the available event types, policy conditions, and common use cases. Transaction Security is included in Real-Time Event Monitoring.
ApiEvent Policies: API events monitor API transactions, such as SOQL queries and data exports.
LoginEvent Policies: Login event policies track login activity and enforce your login requirements.
ReportEvent Policies: Report event policies monitor when data is viewed or downloaded from your reports.
Why Am I Getting an Error Message?: When you’re working in Salesforce, you can occasionally get an error message. Typically, an error message appears when you try to view, edit, or delete information to which you don't have access.
Override the Escrow Date for Transactions: You can ignore or reduce the escrow period for transactions if necessary. For example, you can choose to override the escrow period for specific products or services.
Escrow Points: You can wait for a period before you credit points to members after they complete a transaction. You can also specify the number of days that you want to hold members' points in escrow and automatically release the points after the escrow period ends. Qualifying and nonqualifying points can be held in escrow.
Understand How Escrow Points Work: Before you escrow members’ points, find out more about the workflows that configure escrows for currencies and automate the process of releasing points to members' balances. Also, learn about how points are kept in escrow and correctly rolled over to the members' points balances.
Roll Over Escrow Points to Members: The Roll Over Escrow Points to Members template definition automates the process of moving members' points in escrow to the members' points balance. This definition rolls over the points for all the currencies associated with a loyalty program.
What is Salesforce Essentials?: Salesforce Essentials lets you see all of your customer information in one place. Sell smarter and faster with built-in intelligence, and provide personalized service to every customer. Build reports and dashboards to fit your needs so you can dynamically visualize your company’s vital data, such as deals won and cases closed.
Add Your Apps to Salesforce Essentials: Want to extend the functionality of your Salesforce platform? Not sure where to start? While Salesforce Essentials doesn't come with API access, our support coaches have gathered what they believe are the most essential apps to extend functionality. Check out our AppExchange to integrate some of the tools you already use and love with Salesforce.
Automate Your Business Routines: Save time by automating your business practices. Rules, Process Builder, and Flows turn your repetitive workload into automated actions that do work for you.
Understand the Basics: Get to know the foundational features in Salesforce like Accounts, Leads, and Cases. Learn how to import your data into Essentials. Take your data to the next level with custom fields, reports, and dashboards.
Learn Best Practices for B2C Businesses: If you’re running a small business that works with customers directly, you’ve definitely got a lot going on. Whether it’s stocking shelves or responding to questions, managing your business is an all-consuming task. With Essentials, you can bring email, tasks, and all your other to-dos right into Salesforce. Here are our top recommendations for getting the most out of Essentials.
Set Up Basic Case Management in Salesforce Essentials: Cases are the foundation of customer support in Salesforce. You can set up a case management system that lets you collect cases and assign them to your team with no manual oversight.
Track and Solve Customer Issues: Use cases to track customer feedback and issues. In Salesforce, all the information you need to solve the issue is right in front of you with related contact information, past cases, articles, and more. Say goodbye to jumping from tab to tab and close cases faster.
Offer Live Customer Support with Chat and Messaging: Offer your customers instant conversation with web chat and Facebook Messenger for Essentials. Chats and messages are delivered to team members alongside their other work in Salesforce, so they can handle cases, chats, messages, and everything else side by side.
Manage Your Contacts with These Best Practices: Storing and managing contact data in your CRM means that you get to know your customer and understand the timeline of your relationship with the customer. You also get a big-picture view of how all your customers benefit your business.
Know Exactly Who You’re Talking to with Contacts: Contacts are individual people you communicate with to move a business deal forward. If you work with other businesses, Contacts are associated with Accounts, or companies you’re doing business with.
How to Talk to Your Customers Like Real People: If your customers have a question or concern, they come to you for answers. Skip the customer-service speak and use phrasing that shows you care. Build trust and help them focus on solutions.
5 Easy Ways to Keep Your Customers Happy: The MVPs of successful businesses are their loyal customers. Repeat customers are more likely to buy from your business a second time as well as spread the word about it to new customers. It also costs less to retain them than it does to acquire new customers. So here are some ways to get started.
Customize Salesforce Essentials: Salesforce Essentials provides standard and customizable tools to suit your unique business needs. Need to see a to-do list when you start your day? Don’t have a full-time staff member to run your help center? Have unique metrics you’re holding your support staff to? We’ve got brainstorming questions and best practices around customizing Essentials to meet your needs.
Track Your Progress with Dashboards: Take a look at how your business is doing in a single glance with dashboards. You select the metrics that matter and Salesforce brings the data to life with graphs, charts and more.
Importing Data into Salesforce Essentials: Learn best practices for importing your customers’ data into Salesforce. You can turn your spreadsheet into Account, Contact, Lead, and Opportunity records in Salesforce using the Data Import Wizard.
Fix Data Import Errors in Salesforce Essentials: If there are errors during your data import, we tell you in the attachment in the summary email. See some of the most common errors and our best tips for fixing them.
Match Your Information to Salesforce Fields in Data Import: Matching your information to Salesforce fields helps you make sure that all the details you need get to the right place. When you match your information to fields in Salesforce, you’re telling us where to put your data during the import.
Create a Company Phone for Your Team: Create a single phone number that connects your customers to your team. Your team can take and make calls from Salesforce. Personalize conversations based on past call history, take notes, and finalize a deal or case details all within Salesforce. Align your customers’ phone experience with your company by uploading your own recorded messages and wait music.
Build an Effective Self-Service Help Center: Customer-friendly support doesn’t have to be complicated or burdensome for your team. Offer a self-service help center as an effective and cost-efficient way to grow your business. Follow these tips to get the most value out of self-service.
Turn Emails and Social Media Posts into Cases: Use Email-to-Case to turn incoming emails to your support email address into cases in Salesforce. Social Customer Service automatically creates cases for social media mentions, posts, or direct messages from your company’s Facebook, Twitter, YouTube, and Instagram pages. Set up Email-to-Case, Twitter, and Facebook with guided setup flows.
Getting Around in Salesforce Essentials: Learn how list views can help your and your team manage your customer information and be more productive. Get to know the utility bar to help your team be more productive.
Salesforce Essentials Glossary: Search for terms and brush up on your Salesforce knowledge with the Essentials glossary.
Maintain a Healthy Sales Team: Your team succeeds when you invest in fostering a positive, happy work environment where everyone can succeed together. See our best tips for maintaining a healthy sales team that’s mutually supportive and excited to make sales.
Create a Self-Service Website: Help Center lets you share Knowledge articles that answer common questions, so your customers can help themselves. You can also provide Chat or a contact button so that customers can reach out to your team for the issues that require human intervention.
Prepare for Your Help Center: Get ready to create your branded, self-service help center. Plan or write your articles and their categories, decide which topics you want to feature, and gather your branding materials.
Pre-Import Checklist: Before you import your data, run through this checklist to make sure that you’re well prepared. We guide you through getting an overview of the import process, fixing up what’s already in Salesforce, and preparing your spreadsheet for a smooth import.
Write Useful Help Articles for Your Customers and Your Team: Use Knowledge to write and share articles, so your team can leverage your communal knowledge to help customers faster. You can also surface your Knowledge base in your help center to let customers find answers on their own.
Close More Deals with Leads: Snag a business card or see some new opt-ins for your newsletter? Those are leads, or customers who are interested in your product or service.
Optimize Tasks as a Manager: As a manager, you can use tasks to align business processes and monitor productivity.
Best Practices for Marketing Teams: Marketing outreach is key to attracting new leads and retaining customers. Whether you want to send a promotion to a loyal customer or reach multiple new leads with an offer, we have tools to help.
Going Beyond the Basics: Give your team more automation and productivity by routing incoming work (like cases) to the best-fit person for the job. Use Chat and Messaging to provide instant conversation to your customers through web chat and Facebook Messenger. Use Macros to complete multi-step tasks with a single click.
Offer Customer Support in Essentials: Salesforce Essentials makes offering customer support easy. Track and solve your customers’ issues with cases, so nothing slips through the cracks. Keep your customers happy with self-service, live web chat and messaging, and phone support.
Divvy Up Work On Your Team with Routing: Use Omni-Channel to route work items (like cases, leads, chats, and messages) to the best-fit person on your team based on your team’s availability and the priority of the work. The most important work items are pushed to your team first.
Build an "All Open Tasks" Report: Create an All Open Tasks report to see how many open tasks your team must complete by a certain date, week, or month. You can compare these numbers weeks over week to see improvements or declines in productivity.
Track Your Open Deals with Opportunities: Opportunities are business deals in progress. Track progress by moving each opportunity through a series of business milestones called stages, like Prospecting, Proposal Sent, Negotiation, and Contract Signed. The goal is to “win” the opportunity, or move it to a final stage that represents a successful outcome for your business.
Build an "All Overdue Tasks" Report: Create an All Overdue Tasks report to see the volume of past due tasks. You can compare these numbers week over week to see improvements or declines in productivity.
Use a Phone in Salesforce: A phone lets your team take and make calls alongside their other work in Salesforce. You can create a phone with Salesforce using Sales Dialer or Dialer for Essentials, or you can integrate a third-party phone product.
Phone Options in Salesforce Essentials: Use Salesforce to make and log calls with Sales Dialer or Dialer for Essentials. Or, connect a third-party phone product to Salesforce using Open CTI. All of our phone options let you make and receive calls in Salesforce and log calls to related account and contact records.
Re-engage Inactive Leads and Customers: If a lead or customer hasn’t purchased or accessed your product in about 30 days, consider them inactive. This behavior doesn’t mean they’re no longer interested; it’s just time to remind them about your great products and service.
Essentials Resources: Learn more about Essentials with helpful videos and a guided journey. Or, hit the trails with our Essentials-focused modules on Trailhead.
Take Your Sales to the Next Level: An upward trend isn’t only a time to celebrate—it’s a time to refine the recipe for your team’s secret sauce. A winning streak can turn into a long-term trend when you learn what’s going well and why. Use these tips to help you keep up a winning streak.
5 Sales Secrets from Top Sales Execs at Salesforce: Closing deals is crucial to growing your business. If you don’t have tons of experience convincing customers to sign on the dotted line, don’t worry. Here are some proven techniques from our top sellers at Salesforce.
Make Selling Simple with Sales Stages: Sales stages help you organize how your business closes a deal, starting from lead creation and going all the way through closing an opportunity.
How to Troubleshoot When Your Sales Are Down: When your team’s sales aren’t on target for a particular month, it can be difficult to find a solution. Follow our troubleshooting tips to help your team reach their sales goals.
Let Your Customers Help Themselves: Give your customers the gift of self-service. When your customers can answer their own questions, your team can spend more time making deals and solving bigger customer issues. Write and organize articles with Knowledge that provide information about your business and answer common questions. Serve up your categorized articles in a help center so your customers can find exactly what they need. If they have a question that requires human intervention, they can log a case to your team. (Or if you’re feeling spiffy, you can offer live chat, too).
Set Up the Most-Used Features: Get more done in less time by setting up your sales pipeline, automatically turning incoming emails and social media posts into cases, utilizing self-service, and adding a phone.
Get Started with the Setup Assistant: Get up and running fast with the Essentials Setup Assistant. Use this to-do list to make sure you’ve completed the most important steps to grow your business.
Respond to Social Media Interactions in Salesforce Essentials: Join customer conversations on social media without monitoring your accounts in separate tabs. Connect with Twitter, Facebook, Instagram, and YouTube to respond to posts and direct messages in Salesforce. You can also create cases from social posts, so your team can provide customer service everywhere your customers are.
Manage Your Essentials Subscription: Add or subtract users, update the credit card on file, and more from the Manage Subscription page in Setup.
Sync Emails and Activities: Automatically bring your business emails and events into Salesforce with Einstein Activity Capture. Then your deals, cases, and contacts will show any related emails and events.
Reach Out to Customers After Winning an Opportunity: Our process builder recipe can automate your communication with a contact or customer from whom you won an opportunity. After winning an opportunity, you often have a reason to reach out to the contact or customer. For example, you want to thank them. Or you want to send them a survey to rate customer satisfaction. Maybe that follow-up is even an opportunity to cross-sell.
Get the Most from Tasks: Tasks are to-do list items that help you keep track of your workload and meet important business objectives. If you're an individual contributor, you can use task reminders to stay on top of upcoming deadlines. If you're a manager, you can use tasks to align business processes and monitor productivity.
Create a Process to Trigger the Email Opt Out Flow: You created a Flow to check the Email Opt Out box when leads and contacts unsubscribe. Now tell the system to launch that Flow when a new case enters the Unsubscribe Requests queue.
Keep Your Productivity Tools Handy: The utility bar is a fixed footer where you can quickly access handy utilities and common productivity tools. Your admin can also add custom options.
Asynchronous Apex Example: When executing a transaction security policy, use an asynchronous Apex process to offload time-consuming operations, such as sending a notification email to an external recipient.
BulkApiResultEventStore Policies: Bulk API Result Event policies detect when a user downloads the results of a Bulk API request.
CredentialStuffingEventStore Policies: Credential stuffing event policies monitor when a user successfully logs into Salesforce during an identified credential stuffing attack. Credential stuffing refers to large-scale automated login requests using stolen user credentials.
FileEvent Policies: File event policies detect file-related events, such as when a user downloads a file containing sensitive information.
ListViewEvent Policies: List View event policies monitor when data is viewed or downloaded from your list views using Salesforce Classic, Lightning Experience, or the API.
PermissionSetEventStore Policies: Permission set event policies monitor when users are assigned critical permissions in a permission set or a profile.
SessionHijackingEventStore Policies: Session hijacking event policies monitor when unauthorized users gain ownership of a Salesforce user’s session with a stolen session identifier.
Manage Real-Time Event Monitoring Events: Manage streaming and storage settings for Real-Time Event Monitoring events declarative with the Event Manager. You can also manage settings programmatically with the Metadata API. Real-Time Event Monitoring helps you monitor and detect standard events in Salesforce in near real-time. You can store the event data for auditing or reporting purposes. You can create transaction security policies using Condition Builder—a point-and-click tool—or Apex code.
Exclude the Confidential Information Disclaimer from Reports: By default, report footers include a disclaimer that reads “Confidential Information - Do Not Distribute”. The disclaimer reminds users to be mindful of who they share reports with, helping to ensure that third parties don’t view your reports. At your discretion, exclude the disclaimer from formatted report exorts in Lightning Experience and from run pages and printable views in Salesforce Classic.
Expanded Partner Management: With Expanded Partner Management, brands can bill partners for the liability that the loyalty program has accrued when members of the program purchase a partner product or service. Brands can set up a prepaid or a postpaid billing system for partners, review the value that the partner is bringing to the program, and track partner transaction history. Brands can also run joint promotions along with parnters to increase the program's appeal to members.
Expire Activity Based Non-Qualifying Points: An Expire Activity Based Non-Qualifying Points calculates and expires non-qualifying points based on the member’s last activity date.
Expire Fixed Non-Qualifying Points by Using Aggregated Expiration Ledgers: Use the Expire Fixed Non-Qualifying Points Using Aggregated Expiration Ledgers Data Processing Engine definition to expire members’ fixed-type, non-qualifying points. Run the definition to expire member points regardless of whether you’re consolidating member points in real time or in batches.
Expire Fixed Non-Qualifying Points: The Expire Fixed Non-Qualifying Points job calculates and expires non-qualifying points for members based on the expiration date on the ledger.
Expire Passwords for All Users: As an admin, to enforce extra security for your Salesforce orgs and Experience Cloud sites, you can expire passwords for all users. After expiring passwords, all users are prompted to reset their password the next time they log in.
Export Policies Between Sandbox and Production: You can export privacy policies directly between your sandbox and production org. Use this feature to develop, test, and troubleshoot privacy policies while quickly converting them between your Salesforce environments.
Configure Salesforce CORS Allowlist: Cross-Origin Resource Sharing (CORS) allows web browsers to request resources from other origins. For example, using CORS, the JavaScript for a web application at https://www.example.com can request a resource from https://www.salesforce.com. To allow access to supported Salesforce APIs, Apex REST resources, and Lightning Out from JavaScript code in a web browser, add the requesting origin to your Salesforce CORS allowlist. For Lightning apps that allow web browsers to make requests from their orgs, CORS allowlist prevents requests to Lightning apps unless the request comes from an approved URL. The allowlist is in effect for your My Domain URL and api.salesforce.com.
Configure OAuth Policies: OAuth policies are an important part of the external client app OAuth plugin that are generated with default values when an external client app is saved or during deployment to a subscriber org. Admins configure the OAuth policies file for their specific use case.
External Client Apps: External client apps are packageable frameworks to enable a third-party application to integrate with Salesforce using APIs and security protocols. External client apps provide single sign-on (SSO) and use SAML and OAuth protocols to authorize third-party applications. Third-party applications that are integrated with Salesforce can run on the customer success platform as well as other platforms, devices, or SaaS subscriptions.
Set Up OAuth Flows: External Client Apps support several OAuth flows. These flows allow the third-party application to access protected resources on Salesforce.
Manage Sites with Contactless Users: The contactless users feature provides flexibility and efficiency in managing your customer and partner user data. You can maintain a lightweight directory of these types of user records to preserve community licenses. And if these users need access to your site’s features and licenses, you can upgrade them to licensed users.
Create an Account for CRM Integration: One of the great things about Salesforce Customer Identity is that it’s already integrated with your customer success platform. By driving identity on the same platform that you use for managing your customers and partners, you simplify your integration requirements while providing your users a better experience.
Control User Access to Your Experience Cloud Site: Set your Experience Cloud site’s profile to control customer and partner access. The external identity profile enables single sign-on access to your site.
Example: Create a Custom Visualforce Login Page from a Github Project: When creating custom code for your login page, it’s often helpful to start out with an existing example for guidance. Salesforce Identity provides a Github custom login page project that you can modify. The project includes custom Visualforce pages and Apex controllers.
Create a Custom Login Page in Visualforce: Create your custom login page in Visualforce, and associate it with your site from the Login & Registration page of the Administration workspace. You can also create custom Visualforce pages for password, forgot password, and self-registration. You can add these login pages to your Experience Cloud site regardless of the template you used to create the site.
Brand Your Identity Pages with Dynamic URLs: With dynamic branding, you can customize the branding of your login experience depending on context, such as who the user is or where they're logging in from. For example, change which logo you display depending on whether the user is an employee or customer. Or display a particular self-registration page based on the user's country code.
Dynamic Branding for Multiple Brands: Dynamic branding is ideal for multi-brand companies. You can create a single login page that determines which brand appears at run time. All brands are served from the same login page that serves the same site.
Add Dynamic Branding to Custom Pages: For custom pages used to log in, verify identity, reset passwords, and self-register, you can implement dynamic URLs with a custom login Apex controller. Use the Apex methods getExperienceId and setExperienceId of the System.Site class to retrieve and store the expid value.
Embedded Login: With Salesforce Identity Embedded Login, you can integrate Salesforce login capabilities into your own external website. When customers access your external website, they see a login form that prompts them to enter a username and password. Depending on the use case, you can use Embedded Login as a single sign-on (SSO) alternative for your external webpages. Or use Embedded Login to add a layer of authentication to purchases by requiring customers to log in first.
Enable Embedded Login: Embedded Login is disabled by default on all new sites. To use Embedded Login, enable the option on your Experience Cloud site.
Embedded Login Advanced Features: Embedded Login takes care of authenticating users so that you can add login capabilities to a web page without worrying about the details. You can also take advantage of the advanced features that Salesforce offers.
Implement Embedded Login: Let’s add Embedded Login to a web page on your website. To do so, follow the steps outlined here.
Create an Embedded Login Client-Side Callback: To create a client-side callback, you add a web page to your website and specify a few Embedded Login meta tags inside the <head> HTML element.
Use the Configurable Self-Reg Page for Easy Sign-Up: To give visitors a simpler, mobile-centric self-registration experience, use the Configurable Self-Reg Page. With this self-registration page, users can sign up with only an email address or phone number, instead of having to create a username and password. With this lightweight sign-up process, you can limit the amount of information that you collect from the users when they sign up. On subsequent logins, you can get more information, building a member's profile through progressive profiling powered by the login flow.
Create Custom Error Messages in the Login Discovery Handler: If a user makes a mistake when trying to log in to your site, the Apex handler displays a generic error message. You can customize the error message that appears on the login page using the Auth.DiscoveryCustomErrorException exception.
Login Page Types: When you create an Experience Cloud site with a template, Salesforce takes care of the login process. You can choose from a few login page types to control the login experience for your site.
Extend the Configurable Self-Reg Handler in Apex: When you select the Configurable Self-Reg Page registration type on the Login & Registration page, Salesforce generates the AutoCreatedConfigSelfReg handler. The handler contains logic for users to register with their email address or phone number. You can modify the handler in Apex to customize self-registration. You can add logic to ensure that a new member’s email address and phone number are unique in your org.
Self-Registration Page Types: Depending on your business needs, you can choose from a few page types to implement self-registration for your site. For example, choose a self-registration page type that lets your users register with an email address or phone number.
How to Implement Embedded Login: Adding Embedded Login to a web page requires coordination between the Salesforce admin who manages the Experience Cloud site and the web developer who builds the web page.
Embedded Login in Action: Let’s see what website visitors experience when you add login capabilities to a web page with Embedded Login.
Change How to Invoke Embedded Login on the Server: You can change the default behavior of Embedded Login on the server by modifying the <script> tag inside the <head> HTML element at the top of the web page.
Customize Login, Logout, and Password Management Pages: Control the look and behavior of the pages users see when they log in to your site. Depending on the type of login page, you can further customize it with Experience Builder, Apex, and Visualforce. You can also customize the pages users see when they log out and when they manage their passwords, including Reset Password and Forgot Password Pages.
Configure Your Login Page: After you decide which login page you want to set up, configure your login page in the Administration workspace.
Replace the Embedded Login CSS with Your Own: Embedded Login comes with a default style sheet, which styles the login button and login form. If you want to replace the default CSS with your own, you have a few options.
Create an Embedded Login Server-Side Callback: Use the server-side callback instead of a client-side callback web page to avoid exposing the access token on the client. To create a server-side callback, use the OAuth 2.0 web server flow.
Step 1: Enable Resource Sharing Across Domains: Embedded Login entails making web requests outside the website boundaries, but for security reasons, web requests are restricted to the current domain. To enable a website to share resources beyond its boundaries, the Salesforce admin adds trusted website domains to Salesforce’s Cross-Origin Resource Sharing (CORS) allowlist. CORS is an industry standard that enables web browsers to make requests from origins other than their own.
Step 2: Create the Embedded Login External Client App: From your Salesforce community, create an Embedded Login external client app to connect your community with your website. The external client app handles communication between your web page and the Salesforce back end.
Step 3: Enable Embedded Login on a Web Page: On the web page where you want to add login capabilities, enter Embedded Login meta tags inside the <head> HTML element at the top of the page.
Step 4: Write Login and Logout Functions: On the web page, provide a login and optional logout JavaScript function in the body to handle onLogin and onLogout events. With these functions, you determine what happens when users log in and out successfully. You have full control over what happens.
Step 5: Handle the Embedded Login Callback: When a user logs in to a website, the Embedded Login callback URL receives the access token and uses it to retrieve user information. Both the access token and user information can be stored to local storage. Depending on your implementation, you can create a callback to handle the response on either the website (client) or the server.
Add Embedded Login Meta Tags to Your Web Page: You enter meta tags on your web page where you want to add login capabilities with Embedded Login. You specify the Salesforce site URL, what the login form looks like, and the location of the CSS style sheet.
Create Lightweight Contactless Users: Reduce the overhead of managing customers and partners by creating users without contact information. You can add contacts later if you decide that you want them—like when you upgrade to a more full-featured Identity license.
Downgrade Users with Community Licenses to Contactless Users: You can convert users with community licenses to contactless users. By converting users, you can expand your Experience Cloud site’s reach without adding to the cost. For example, you can downgrade inactive or unqualified users and then upgrade them to full-featured site users later on. You can downgrade users from Setup and through the API.
Extend Salesforce Customer Identity Sessions: Make it easy for your customers and partners to stay in your site with longer sessions and fewer logins. Allow users to remain logged in even after they close their browser. And keep them logged in for up to seven days of inactivity. To extend sessions, modify the use profile for the customers and partners in your site. You can also add more security when customers or partners log in by enabling device activation.
Upgrade a Contactless User to a Community License: Upgrade users with an External Identity license to a community license to give them more access to your site. To upgrade a user, you must first assign the user a contact.
View Your Users’ Identity Verification Methods: Salesforce maintains information about each user’s identity verification history. You can get this information from the user interface or API.
Customize the LoginDiscovery Handler: After you create a Login Discovery page, continue setting up passwordless login with an email address or phone number by modifying the autogenerated Apex LoginDiscovery handler. By customizing the handler, you control the login process while Salesforce handles verification. The handler finds users based on the identifier that they provide on the login page, such as their email address. It then checks which verification methods the user has previously registered. The controller logs in the user by whichever method is configured.
Create a Custom Identity Verification Page: You can use passwordless login to let users register and deregister a variety of verification methods, such as via email, SMS, time-based one-time password (TOTP), physical U2F security key, or Salesforce Authenticator. Users can then log in with a verification method. Create your own verification page, and customize the verification process with Apex.
Email or Phone Number Registration with Passwordless Login: You can implement passwordless login with email addresses and phone numbers. Create a Login Discovery page from Experience Workspaces. Then you can customize the LoginDiscovery handler with Apex.
Passwordless Login: To make login and registration more accessible to your users, configure passwordless login. With passwordless login, users can log in, sign up, and even register identity verification methods without the trouble of remembering usernames or passwords.
Identity Verification with Passwordless Login: Implement passwordless login to let your users register and deregister a variety of identity verification methods. After they register a verification method, they can use it to log in. Create a custom Visualforce page, and customize the identity verification process with Apex.
Prepare Your Org for Salesforce Customer Identity: Before you get started with Salesforce Customer Identity, complete administrative tasks to integrate Salesforce Customer Identity features with customer and partner business processes.
Set Up Accounts for Self-Registration: Depending on your use case, decide which account type you want new users to be saved under when they self-register.
Configure Self-Registration: After you set up an account for your new customers, configure self-registration for your site.
Create Custom Error Messages in the Configurable Self-Reg Handler: If a user makes a mistake when trying to self-register for your site, the Apex handler displays a generic error message. You can customize the error message that appears on the self-registration page and verify pages using the Auth.DiscoveryCustomErrorException exception.
Configure Person Accounts for Self-Registration: If your company uses a business-to-consumer (B2C) business model, set up person accounts for self-registration. When new users register, they're added to your site under an individual record that merges account and contact information.
Create a Business Account for Self-Registration: If you want to save your new users as part of an organization, create a business account. When users self-register, they're added as contacts to the business account associated with their company.
Test Your Self-Registration Process: When you configure self-registration, or change your self-registration process or page, test the process to make sure it works.
Self-Registration: Use self-registration to invite new visitors to join your Experience Cloud site. When new users access your site’s login page, they see a self-registration option that leads them to a page where they can sign up. Depending on your use case, you can configure self-registration for business accounts, which allows users to register themselves as contacts under an account associated with a company. Or you can configure self-registration for person accounts to support a business-to-consumer (B2C) model where users register as individuals.
Control Authorization with Custom Profiles and Roles: In identity and access management, it's important to control who is authorized to access resources. You can manage authorization by assigning your users profiles and roles. Profiles define how users access data and what they can do in Salesforce. Roles allow you to create a user hierarchy so that users can access data owned or shared by subordinates.
Select an Experience Cloud Site Template: You can create your site for customers and partners using any site template that Salesforce provides. With each template, Salesforce creates a default set of pages to handle the login experience, which includes login, self-registration, password resets, and identity verification.
Single Sign-On for Salesforce Customer Identity: With single sign-on (SSO) for Salesforce Customer Identity, users can log in to multiple applications with one set of credentials. Depending on your use case, you can configure your site as a service provider or relying party so users can log in with credentials from a third party, such as Google. Or you can set up your site as an identity provider so it can authenticate users for a third-party app. You can also set up SSO between your site and mobile apps.
Configure Your Experience Cloud Site as an Identity Provider or OpenID Provider: To let users log in to a third-party service provider with credentials from your Experience Cloud site, configure your site as an identity provider. Depending on the third party you want to integrate, you can use SAML or OpenID Connect as your authentication protocol.
Set Up SSO for Mobile Apps: If you want your users to access a mobile app from your site without logging in again, configure SSO for mobile apps.
Configure Your Experience Cloud Site as a Service Provider or Relying Party: To let users log in to your Experience Cloud site with credentials from a third-party provider, configure your site as a service provider or relying party. For single sign-on (SSO) authentication only, you can use SAML to configure your site as a service provider. Or, if you want the third party to authenticate users and authorize them to access third-party data, set up an authentication provider to configure SSO with your site as the relying party.
External Client Apps and Connected Apps: There are two options to connect your Salesforce data with third-party applications. Both connected apps and external client apps are frameworks to integrate data. External client apps are the next generation of connected apps. They’re fully metadata-compliant and include structural improvements to maintain separate user roles and allow second-generation managed packaging.
How long does it take to complete an import?: The time it takes to complete an import using the Data Import Wizard varies, depending on the amount of data you’re importing. Imports can take up to several minutes.
Can I do simultaneous imports?: The Data Import Wizard doesn’t support simultaneous—or concurrent—data import jobs, even from separate browser windows. Finish one data import before beginning the next.
What kind of objects can I import?: You can use the Data Import Wizard to import accounts, contacts, leads, solutions, campaign members, person accounts, and custom objects.
What Is My Domain?: Showcase your company’s brand with your My Domain name. That My Domain name is used as your org-specific subdomain in Salesforce login and application URLs. For example, https://mycompany.my.salesforce.com and https://mycompany.my.site.com. Learn about the benefits of My Domain, including a custom login page and user login and authentication options.
View and Display FAQ: Common questions around popup windows, buttons, links, and other display elements on Salesforce pages.
Where Does Data Import Wizard Obtain the Country for the Country Field?: The Country column is a mandatory field and if it is not provided in your comma-separated values (CSV) file, Data Import Wizard tries to derive it from other sources. This action avoids any insert issues when, for example, the CSV file has a State column but no Country column. For the value, Data Import Wizard checks to see if the Default Country/Territory is specified in the State and Country/Territory Picklists. If a country is selected from the picklist, then Data Import Wizard uses that value for the Country. If a country is not selected, then the country selected in Signup Country Code during the org sign-up is used.
Why Did My Data Disappear When I Pressed the Backspace Key While Editing a Record in Salesforce Classic?: Some versions of Internet Explorer use the Backspace key as a keyboard shortcut for the browser’s Back button. When you press the Backspace key and your cursor is not within a text field, the browser goes back to the previous page. To retrieve your data and return to the page you were working on, click your browser’s Forward button.
Can I mass upload data into Salesforce?: Group, Professional, Performance, Unlimited, Enterprise, and Developer editions allow you to mass upload data using the Data Import Wizard. From Setup, enter Data Import Wizard in the Quick Find box, then select Data Import Wizard. In addition, Performance, Unlimited, Enterprise, and Developer editions have API access to use database mass upload tools like Data Loader.
Print Records: You can print Salesforce records from most detail pages.
Salesforce Language Support: Learn about the supported languages in Salesforce, and understand the difference between fully supported, end-user, and platform-only languages. Learn which languages are available in the UI for each Salesforce cloud, and review important limitations for right-to-left (RTL) languages in Salesforce.
User Interface Language Support: Understand the available languages in the user interface (UI) for your product. If your company’s default language or the user’s personal language isn’t available in the UI, the language defaults to English (US).
Right-to-Left (RTL) Language Support: To make right-to-left (RTL) language users feel more at home, Salesforce supports Arabic and Hebrew as end-user languages and Urdu as a platform language. In Lightning Experience and Experience Builder sites, the RTL Language Layout is the default layout for right-to-left languages, with some important limitations. Salesforce Classic and Experience Cloud sites using Salesforce Tabs + Visualforce offer limited support for RTL languages for some features.
Supported Languages: Salesforce offers three levels of language support: fully supported languages, end-user languages, and platform-only languages. For fully supported languages, Salesforce features and user interface (UI) text appear in the chosen language. End-user languages allow individual users to select a language other than the company’s default language for end-user facing UI. In situations where Salesforce doesn’t provide default translations, use platform-only languages to localize apps and custom functionality that you build on the Salesforce Platform.
How many campaign members can I import?: With the Data Import Wizard, your import file can have up to 50,000 record rows. Your imports are also subject to the overall storage limits for your org.
What status is assigned to campaign members?: With the Data Import Wizard, you can map a column in your import file to the Status field. Blank or invalid status values are set to the default status.
Who can import campaign members?: Only users with the required permissions can import campaign members with the Data Import Wizard.
Can I bulk-assign records to a record type?: Yes, you can bulk-assign records to a record type using the Data Import Wizard. You choose to which record type to assign the records during the import process. This process applies to standard and custom objects.
Can Customer Support help me import my data?: Customer Support is available to assist Group, Contact Manager, Professional, Enterprise, Unlimited, and Performance Edition orgs throughout the import process.
Can I delete my imported data if I make a mistake?: From Setup, your administrator can enter Mass Delete Records in the Quick Find box, then select Mass Delete Records to perform a mass delete of accounts, contacts, leads, or solutions that you mistakenly imported.
Can I import into custom fields?: Yes. Your administrator must create the custom fields before import. For checkbox fields, records with a value of 1 in the field are imported as checked, while a value of 0 is not checked.
Can I import amounts in different currencies?: If your Group, Professional, Enterprise, Unlimited, Performance, or Developer Edition org has set up the ability to use multiple currencies, you can import amounts in different currencies using the Currency ISO Code column in your import file.
Can I import data in more than one language?: The import wizard imports one language at a time, the language of the user doing the import. If you have the same data in different languages, run an import for each additional language.
Can I import into fields that are not on my page layout?: No, except for contacts. You can import values into a field only if you have read and edit access. User permissions, page layout assignments, and field-level security settings determine field access. The page layout used is based on the running user's selected record type.
Which data can I import?: You can use the Data Import Wizard to import campaign member status, contacts and business accounts, person accounts, leads, solutions, and custom objects, depending on your Salesforce edition.
What file formats can the import wizards handle?: You can import contacts and business accounts directly from an ACT! or Outlook file, or from any CSV (comma-separated values) file, such as a GoldMine or Excel file. You can import leads, solutions, custom objects, or person accounts from any CSV file.
Can I import using external IDs?: When importing custom objects, solutions, or person accounts, you can use external IDs to prevent the import from creating duplicate records.
Can I import data into a picklist field if the values don’t match?: We recommend that you import your data into an existing picklist when that picklist accurately represents your data, even if the exact values don’t match. The import wizards warn you before importing any new picklist values. However, the wizards accept any value for a picklist field, even if the value isn’t predefined. Your administrator can later edit the picklist to include the needed values. Note that import wizards don’t allow you to import more than 100 new picklist or multi-select picklist values for any field during a single import.
Who can use the Data Import Wizard?: You can use the Data Import Wizard to import accounts, contacts, leads, solutions, person accounts, campaign members, and custom objects for multiple users at the same time.
Why is there a delay in importing my file?: To manage the volume of imports and ensure that all users receive the highest level of performance, org import files are accepted in asynchronous mode. Your file passes through a controlled queue and is imported when the system can best manage the data, however your org import doesn’t take longer than 24 hours to complete. You receive an email notification when the import is complete.
Why do date fields import incorrectly when I use the Data Loader?: Sometimes dates import incorrectly because the Data Loader converts the date specified in the imported .csv file to GMT. If your machine’s time zone isn’t GMT or if your machine’s clock adjusts for daylight savings time (DST), your dates can be off by a day.
Scalability FAQ: Find answers to frequently asked questions about scalability.
How scalable is Salesforce?: The service has the capacity to scale to the largest of teams. The architecture behind the service was designed to handle millions of users. We scale as rapidly as our customers require.
Do I see a degradation in performance as Salesforce's subscriber base grows?: No. We are very conscious of performance and have designed the service to be scalable in such a way that we can constantly stay ahead of customer demand. Our architecture lets us easily add web and application servers to accommodate more users. The system architecture also lets us add more database servers as needed to accommodate more users. In addition, the facility that houses our servers provides us with guaranteed bandwidth, which we can increase as needed.
Field Audit Trail: Field Audit Trail extends the capabilities of Field History Tracking, so you can keep field history data indefinitely. Use Field Audit Trail to maintain a comprehensive historical record of field changes (up to 200 tracked fields per object) and to ensure data integrity and compliance with industry standards. Field History Tracking data and Field Audit Trail data don’t count against your data storage limits.
Field History Explorer: With Field History Explorer, you can search for a specific record to view history changes for all tracked fields on that record. The information provides a detailed audit trail, showing who changed what and when, providing you with a built-in experience for visualizing historical changes and streamlines audit workflows. Field History Explorer is available to Field Audit Trail and Shield customers via the Shield app.
Add the Field History Explorer Lightning Component: Add the Lightning component to a record page to view the audit trail of tracked field changes, who changed what and when, without leaving the record.
Field Mapping for Importing Leads: To improve the accuracy of your import, label the columns in your import file to match the Salesforce Lead fields. When you import the leads, the Data Import Wizard maps the fields in your import file
Field Mapping for Other Data Sources and Organization Import: If you are importing accounts and contacts for an organization, or importing individual data from sources other than Outlook or ACT!, the Import Wizards map the fields as correctly as possible.
Filter Records on an Object: Specify records to process with your Data Management Policy by selecting an object and setting filter conditions. You can process records that meet any condition, all conditions, or a custom arrangement of conditions.
5 Minute Upgrades: Salesforce reserves just five minutes of scheduled maintenance time to roll out new major versions of our service. These upgrades to the next release occur three times per year.
Working with Flexcards: Create and manage Flexcards in the designer in the Omnistudio standard runtime. The designer provides the standard components for building user interfaces within Salesforce. Create Flexcards in fewer steps. With the designer, Flexcards activation is instant.
What Is Imported for Business Accounts and Contacts?: The Data Import Wizard allows you to match records in multiple ways to prevent duplicates. You can match contacts by Salesforce ID, name, email, or external ID. You can match business accounts by Salesforce ID, external ID, or by name and site. Matching by Salesforce ID is inclusive of both contacts and business accounts. If you match one by Salesforce ID, the other is also matched by Salesforce ID.
What Is Imported for Leads?: You can import data into standard lead fields and custom lead fields, even if a field is hidden or read only in your page layout or field-level security settings for leads.
Generate a Frontdoor URL to Bridge into UI Sessions: To give users uninterrupted access to Salesforce and other apps, use an existing session to automatically log users into a new UI without making them enter their credentials again. For example, redirect users from a custom app to a specific record in Salesforce. To bridge from one session to another, use Single Access UI Bridge API (UI Bridge API for short). With this API, exchange an access token for a frontdoor URL that you use to load a new session. You can also specify a redirect URI where users are sent when their new session begins.
Trigger Flows with Data Cloud Data: A flow initiated by the Data Cloud begins operating once specific criteria within a Data Model Object (DMO) or Calculated Insight Object (CIO) are satisfied.
Create Data Streams: The Service data kit includes the Service data bundle and provides the necessary data streams and data mappings for Proactive Asset Service.
Install and Deploy the Service Cloud Data Kit: The Service data kit includes the Service data bundle and provides the necessary data streams and data mappings for Proactive Asset Service.
Proactive Asset Service: Move beyond reactive repairs and embrace a predictive approach to asset maintenance. Proactive Asset Service combines the power of Data Cloud, Tableau, and Service Cloud to give your service teams actionable insights into asset health. By monitoring an asset's age, usage, and maintenance history, the solution calculates an overall health score that allows your team to anticipate issues and address them before they lead to costly downtime, improving efficiency and reducing costs.
Proactive Asset Service Setup: Use the Proactive Asset Service Setup page to walk through the steps for Data Cloud prerequisites, installation prerequisites, and then install Proactive Asset Service.
Get Started with Salesforce Feedback Management: Salesforce Feedback Management gives you insights into what your customers and users think and enables you to refine your customer feedback strategy. Understand customer feedback as it evolves and engage customers and users with relevant, personalized surveys. Explore a trial org and then learn about what’s included, what setup we recommend, and how to get ready for your implementation.
Get Started with Trailblazer: Hey Trailblazer! Let’s get you started by creating your own Trailblazer account so you can access Salesforce digital properties with a single login. It’s easy, and with it you can start blazing your own trail in no time.
Get Help with Trailblazer: Your Trailblazer account is your single identity for multiple Salesforce-related sites. So where do you get help when you need it?
Try Out Salesforce: Use a trial Salesforce org to evaluate Salesforce before you subscribe. Your trial org includes sample data and various Salesforce features, and you can use it to easily subscribe to Salesforce when you're ready.
Permissions for UI Elements, Records, and Fields: To access UI elements, records or fields in Salesforce requires specific permissions. At a minimum, you must have the “Read” permission to view a tab, record, record field, related list, button, or link. To edit a record or record field, you must have the “Edit” permission.
Considerations for Microsoft Edge and Edge Chromium: Salesforce supports the latest stable version of the Chromium version of Microsoft Edge for Salesforce Classic and Lightning Experience. Salesforce supports Microsoft Edge Chromium only on Windows. Internet Explorer Compatibility Mode in Microsoft Edge isn’t supported.
Considerations for Mozilla Firefox: Salesforce makes every effort to test and support the most recent version of Firefox. However, Lightning Experience currently doesn't support Private Browsing.
Supported Browsers and Devices for Lightning Experience: Lightning Experience is available on multiple editions and recommends using the Salesforce mobile app on mobile devices. Specific browsers and devices are supported, and there are limitations and considerations for third-party browser extensions and JavaScript libraries.
Troubleshoot Login Issues: Can’t log in? Forgot your username or password, or you’re locked out from too many login attempts? To resolve login problems, try these solutions.
Use the Correct Login URL: If you're an admin or developer, make sure that you use the correct login URL for the instance that you want to access.
Salesforce Upgrades and Maintenance: Salesforce reserves up to five minutes of service interuption for major upgrades, but you have access your data during other maintenance events, like splits and migrations.
Set Up Divisions: When setting up divisions, you must create divisions and assign records to divisions to make sure that your data is categorized effectively.
Global Consent Manager: Manage and track customer consent from a single system of record across your marketing and data processing activities.
Configure Action Consent Options: Select which Global Consent Definitions appear on the Action Consent layout, and select up to three attributes to identify each consent record.
Configure Additional Attributes: Add custom fields to consent records for business-specific data, such as product lines, division IDs, or delivery frequencies.
Review the Consent Audit Log: Look up a consent record and review the full history of how its consent status has changed.
Configure Communication Consent Options: Select which Global Consent Definitions appear on the Communication Consent layout, and select up to three attributes to identify each consent record.
Global Consent Definitions: Global Consent Definitions are reusable templates that group consent attributes for each compliance use case.
Configure Consent Export Settings: Configure where Global Consent Manager exports consent records, and enable export to your Amazon S3 bucket.
Guided Consent Management Layouts: Guided Consent Management Layouts control how consent records appear when you view and manage a data subject's consent.
Map External Attributes: Map profile and contact point attributes to their source objects so Global Consent Manager can capture point-in-time snapshots of related data.
Customize Consent Purpose Picklist Values: Define the legal or business reasons that you capture consent, such as a specific data processing action or marketing communication.
Customize Consent Status Picklist Values: Define the Consent Status picklist values that reflect your privacy states, such as Opt In, Opt Out, Seen, or Pending.
Stream Consent Data to Data 360: Stream consent records from Global Consent Manager to Data 360 to sync customer preferences.
What Happens After Loyalty Promotion Activation: When you activate a promotion that uses a loyalty promotion template, a rule is created to apply the promotions to the eligible member transactions. If you set limits for the promotion’s rewards, engagement attributes are also created for the reward limits.
Rule Configuration with Loyalty Promotion Template: Create a promotion rule by using the configuration options available on loyalty promotion templates. Use the templates to reward only the members of the loyalty program. You can’t use loyalty promotion templates if the promotion isn’t associated with a loyalty program.
Accrual Events: Use the Accrual Events promotion template to offer rewards to members of the company’s loyalty program when they complete an eligible activity. You can add granular conditions that decide the member transactions that are for eligible for rewards. For example, if members shopping from the company’s app is an eligible activity, you can add granular conditions to reward members if they buy five items or more from the app.
Engagement Trail: Use the Engagement Trail promotion template to reward loyalty members for completing activity milestones. Use the default mode to give rewards when they complete a set of activities in any sequence. Use Single Activity Mode to reward members at up to three target levels of a single activity.
What Members Get Section in the Engagement Trail Promotion Template: Select the rewards that loyalty program members earn when they complete all the milestone goals defined in the Engagement Trail promotion. Offer points, vouchers, and badges as promotion rewards to members. Specify an expiration date for each reward.
What Members Get Section in the Accrual Events Promotion Template: Select the rewards that the loyalty program members are eligible for as part of the promotion. You can offer points, vouchers, and badges as promotion rewards to the members. You can specify an expiration date and the limit for each reward.
Quick Promotions Without Global Promotions Management: Companies can run promotions without using Global Promotions Management. However, certain capabilities are unavailable when Global Promotions Management isn't enabled. Admins must evaluate the company's requirements to decide if they require Global Promotions Management.
Loyalty Management Promotion Limits: To keep promotions within budget and prevent fraud, marketing managers can set limits for both the overall promotion and individual customers on the Add Promotion Limits step of the wizard. In addition to Global Promotions Management limits, you can also add limits on the points awarded.
Run Loyalty Promotions: After loyalty program managers activate promotions that use loyalty program templates, set up a process or integrate an API to apply promotions for member transactions. Admins and system integrators can set a process or an integration to apply promotions for member transactions in real-time or in batches.
Create Data Graphs for Promotions Segment Verification: If you want promotion APIs to use Data Graphs to identify the Data Cloud segments that a customer is a part of, create data graphs by using the unmanaged package or from scratch.
Invite and Manage Users for the Salesforce Add-On for Gmail: Invite users to Salesforce and the Salesforce add-on for Gmail. Before users can access the add-on, the add-on admin must coordinate with the Google Workspace admin to ensure the add-on is installed. Once installed, the add-on admin invites users of the same domain by entering their email addresses, and invited users receive an email to accept the invitation.
Salesforce Add-On for Gmail Overview: Use the Salesforce add-on for Gmail to work with Salesforce records without leaving Gmail. From the side panel, view and edit tasks, events, and other key records, and manage who's invited to use the add-on.
Governor Limit Insights: Monitor your org's governor limit usage and address potential breaches before they affect performance.
Grant Access to Your Einstein Pilot Data for Prototyping: Use Einstein Pilot Consent to manage app and object permissions for Salesforce data scientists. With this access, Salesforce can identify patterns in your customer data and how you can best benefit from Einstein features and products.
Grant Login Access: If you need help resolving a problem, you can grant a Salesforce administrator or a support representative login access to your account.
Headless Identity for Customers and Partners: Headless identity helps you separate back-end authentication processes from front-end identity experiences. With Salesforce headless identity, use the power of Salesforce Customer Identity for authentication while maintaining control of the user experience in an off-platform app. Salesforce offers headless username-password login, passwordless login, registration, forgot password, and guest user flows. You can also link a single sign-on (SSO) provider to your headless app to create a native SSO experience.
Configure Experience Cloud Settings for Headless Identity: For headless registration, headless forgot password, and headless passwordless login, enable the flows from your Experience Cloud site and configure security and access settings.
Configure Headless Identity API Flows: After you complete your setup in Salesforce, build headless identity flows that integrate your off-platform app with Headless Identity APIs.
Complete Prerequisites for Headless Identity: Before you get started with a Headless Identity implementation for your off-platform apps, cross off these prerequisites in Salesforce.
Heroku + Heroku Connect: Privacy Center retains customer data by syncing it to Heroku storage through Heroku Connect. This synchronization leads to some key differences between data security, storage spaces, and editability.
Setting Up Heroku External Objects with Salesforce Connect: Integrate data from a Heroku Postgres database into Salesforce by using Heroku External Objects and Salesforce Connect. While the data remains in Heroku Postgres, this integration allows the data to be read from within Salesforce. Also, the data can often be written to within Salesforce.
Process and Store Customer Data with Heroku: Heroku is a container-based cloud platform that acts as a secure data store for Privacy Center’s Data Retention feature. Through its fully managed data service add-ons, Heroku Postgres and Heroku Redis, Heroku helps you move customer data into storage. The data remains in Salesforce, but other users can’t process or access it.
Heroku Storage: Data Retention Store: Privacy Center uses Heroku as a data retention store. When you choose to retain customer information, it’s placed in Heroku’s storage for safekeeping.
Hide the Omnistudio App While Using the Standard Designer: To enable better performance and faster load times for list views, hide the Omnistudio app from App Launcher and make component search the default option for your org. This way, users can search for Flexcards, Omniscripts, Integration Procedures, or Data Mappers directly, instead of searching for the Omnistudio app.
Schedule and Track Your Tasks and Events: If you have Lightning Sync or Einstein Activity Capture installed, your Outlook or Google events sync with Salesforce. Those synced events appear in the Calendar section.
Change Your Working Division: If your org uses divisions, you can change your working division from the Divisions field in the sidebar.
Track Your Sales Performance: Track your sales performance or the performance of your sales team against a customizable sales goal with the performance chart on the Home page in Lightning Experience.
Enable the ICU Locale Formats: International Components for Unicode (ICU) locale formats are available as a release update. To test the International Components for Unicode (ICU) locale formats before they’re enforced for your organization, enable a test run in the Enable ICU Locale Formats release update. Then enable the formats for the English (Canada) locale.
Differences Between JDK and ICU Locale Formats: Here are all the differences between Oracle’s Java Development Kit (JDK) locale formats and the International Components for Unicode (ICU) locale formats. The changes are listed by locale or platform-only language. By default, orgs created before Winter ’20 use the locale formats provided by Oracle’s JDK.
Adopt the ICU Locale Formats: The ICU locale format release update is available for all orgs. Review the high-level process to successfully migrate to the new International Components for Unicode (ICU) locale formats. Some of the formats differ from the ones provided by Oracle’s Java Development Kit (JDK). Understand how to determine the impact of changes on your org, and learn about the updates required to support the new formats.
Go Global with New International Locale Formats: To keep the Salesforce Platform up to date with the latest international standards, we adopted a new set of locale formats in Winter ’20. Locales control the formats for dates, times, currencies, addresses, names, and numeric values. We currently use International Components for Unicode (ICU) version 71.1, which uses the Unicode Common Locale Data Repository (CLDR) version 41. By default, orgs created before Winter ’20 use the locale formats provided by Oracle’s Java Development Kit (JDK).
Determine Whether Your Org Uses ICU or JDK Locale Formats: To prepare for the move to the International Components for Unicode (ICU) library from Oracle’s Java Development Kit (JDK) library, determine whether ICU is enabled in your org, or whether you’re using the JDK locale format. ICU is the new standard and enabled through a release update.
Identify and Resolve Failed Execution: When an execution fails, check that Heroku is properly installed and connected. Then run a report or query to identify the failed records and find possible next steps to resolve the error.
Salesforce Customer Identity: Salesforce Customer Identity is an Identity and Access Management (IAM) service that improves your engagement with your customers and partners. Create sites for your customers and partners that are customized to your needs and best represent your brand. Use various tools to customize how your users log in, register, verify their identity, and use single sign-on to access your web pages and apps.
App Launcher: The App Launcher is how users switch between apps. It displays tiles that link to a user’s available Salesforce, connected (third-party), and on-premises apps. You can determine which apps are available to which users and the order in which the apps appear. You can also make the App Launcher the default landing page when users first open Salesforce.
Make the App Launcher the Default Landing Page: Make it easy for your Salesforce Identity users to access what they need by presenting the redesigned App Launcher as the default landing page when they log in to Salesforce.
Salesforce Identity Licenses: All identity services that are built into the Salesforce Platform are included with every paid license in the Enterprise, Unlimited, Performance, and Developer Editions.
Login Access: As a Salesforce admin, you can set up your org to allow Salesforce support users, partner support users, or subscribers to log in to a Salesforce org as another user. For example, to help troubleshoot user issues, a support user can log in to a Salesforce org as the user experiencing the problem. You can also configure your org to require users to grant login access to support users or subscribers trying to log in as that user.
Monitor Access to Your Salesforce Orgs and Experience Cloud Sites: Monitor access to your Salesforce orgs and Experience Cloud sites by reviewing and managing who’s logging in and how they're verified. View SAML and OpenID Connect authentication request errors and success. And track and monitor which devices are accessing your orgs and sites.
One-Time Password (OTP) Behavior: Salesforce sends one-time passwords (OTPs) to verify identity for multiple use cases, such as passwordless login, device activation, multi-factor authentication (MFA) for Experience Cloud sites, and more. Learn about expiration time, limits, and generation behavior for OTPs for different use cases.
Identify Your Users and Manage Access: Deliver identity and access management services directly from your Salesforce org. With Salesforce identity services, you can authenticate users across your orgs, Experience Cloud sites, and digital channels to provide authorized access to your data.
Passwordless Login with Passkeys: Set up a fast, easy, and phishing-resistant login process for your employees. With passwordless login via passkeys, internal users log in by using a built-in authenticator (such as Touch ID or Windows Hello) or a security key.
Enable Passwordless Login with Passkeys: Set up passwordless login with passkeys so that your employees can log in by using a registered built-in authenticator or security key.
SAML Single Sign-On Flows: When you set up single sign-on (SSO) with Security Assertion Markup Language (SAML), you can initiate login from the service provider or the identity provider. Service provider-initiated login and identity provider-initiated login use different flows, but both result in the user being logged in to the service provider.
Enable Salesforce as a SAML Identity Provider: You can configure Salesforce as a single sign-on (SSO) SAML identity provider to external service providers. When your org acts as a SAML identity provider, users can access multiple apps with a single login. To get started with this configuration, enable Salesforce as an identity provider and share configuration information with your service provider.
Use the Identity Provider Event Log: When you're using Salesforce as an identity provider, use the identity provider event log to see information about login attempts. For example, see why login attempts failed so you can troubleshoot problems with your single sign-on (SSO) configuration. The log shows you the 50 most recent login attempts. To view more, create a custom report.
Monitor Apps with Reports: After you set up connected apps for your Identity users, you can run reports to monitor the usage of connected apps throughout your org.
Examples: Deactivate and Reactivate Users with SCIM: In Salesforce, you deactivate user objects rather than deleting them. By deactivating a user object, the user’s active status becomes false. Even though you can still query the user object, the user can’t log in to Salesforce with the deactivated account. To allow a user to log in, you can reactivate their account.
Understand the SCIM Implementation: Before provisioning and managing users with SCIM, get familiar with the Salesforce SCIM implementation. For example, see the available services and schema and learn about supported resource types, entitlements, roles, and groups.
Manage Salesforce User Identities with SCIM: You can provision and manage your Salesforce user identities across systems with the open standard System for Cross-Domain Identity Management (SCIM). The Salesforce implementation provides extensions to the SCIM 2.0 specification so that you can edit and manage Salesforce user properties using REST API operations.
SCIM and REST API Reference Sheet: To manage Salesforce user objects with SCIM, you can send REST API create, read, update, and disable (CRUD) operations to SCIM endpoints. You must supply an OAuth 2.0 access token to perform these operations.
Examples: Update Users with SCIM: After creating a user object, you can update its fields. To update a user object, send a PATCH request to the Users endpoint.
Secure Your Salesforce Org with SSO, MFA, and More Identity Features: Some user authentication and identity verification features are now available in the Secure Your Salesforce Org section of Salesforce Help. The features in the security section include multi-factor authentication (MFA), single sign-on (SSO), passwordless login with passkeys, Lightning Login, certificate-based authentication, and identity verification. These security features help you protect your org and user data.
Identity Connect: Identity Connect integrates Microsoft Active Directory (AD) user accounts with Salesforce user records. When a user account is created or updated in AD, Identity Connect pushes those updates to the Salesforce user record seamlessly and instantaneously. For example, when a user is created in AD, the Salesforce user record is created as part of the provisioning process. When deprovisioned, the user’s Salesforce session is revoked immediately. You can also use Identity Connect for single sign-on to Salesforce.
Install Identity Connect: Identity Connect is installed on a server for all your licensed users to access. Before installing Identity Connect, create an Identity Connect integration user record in Salesforce. This user record isn’t actually a user, but instead, it’s used by Identity Connect to integrate AD user account updates with Salesforce user records. We recommend using the Identity Connect integration user solely for Identity Connect integrations.
Upgrade from Identity Connect 2.1 to Identity Connect 7.1.6: Upgrade from Identity Connect 2.1 to Identity Connect 7.1.6 on Windows or Linux to implement security enhancements. Identity Connect 7.1.6 adds to the extensive security improvements introduced in Identity Connect 7.1.1. As of the Summer '23 release, you can no longer download Identity Connect 2.1 or Identity Connect 3.0.X. We recommend that you upgrade to Identity Connect 7.1.6 as soon as you’re able to.
Upgrade from Identity Connect 3.0.X to Identity Connect 7.1.6: Upgrade from Identity Connect 3.0.X to Identity Connect 7.1.6 on Windows or Linux to implement extensive security enhancements. Identity Connect 7.1.6 adds to the security improvements introduced in Identity Connect 7.1.1 As of the Summer ‘23 release, you can no longer download Identity Connect 2.1 or Identity Connect 3.0.X. We recommend that you upgrade to Identity Connect 7.1.6 as soon as you’re able to.
Ignore Errors During Policy Execution: Allow a privacy policy to ignore object processing errors. When errors are ignored, the job session proceeds to the next object on the policy instead of stopping completely. This option is useful if validations or business logic produce errors that you know are safe to ignore.
Rules for Importing Multiple Currencies: If your organization has set up the ability to use multiple currencies, you can import amounts in different currencies.
Salesforce Data Import: Salesforce offers several ways to import your data. You can import up to 50,000 records into Salesforce.
What Is Imported for Custom Objects?: The Data Import Wizard prevents creating duplicate records by matching records according to one of the following fields: custom object name, Salesforce ID, or external ID. In your import file, include a column for the field that you are using for record matching.
Import Person Accounts: With the Data Import Wizard, you can import person accounts that you own.
What Is Imported for Person Accounts?: The Data Import Wizard prevents creating duplicate person accounts by matching records according to one of the following fields: Account Name, Salesforce ID, Email, or an external ID field. In your import file, include a column for the field that you’re using for record matching.
What Is Imported for Solutions?: The Data Import Wizard prevents creating duplicate records by matching records according to one of the following fields: solution title, Salesforce ID, or external ID. In your import file, include a column for the field that you are using for record matching.
View Trust Informational Messages (Announcements): Informational messages inform customers about issues affecting cross-cloud products or services, services used by a subset of users on one or more instances, and Salesforce access due to external factors.
Install Deal Registration Reports: Install the prebuilt Deal Registration report folder in Salesforce Go to track submission volume, outcomes, and duplicate activity.
Install the Loyalty Management Content Blocks Package: To add Loyalty Management content blocks to your Marketing Cloud Engagement org, install the Loyalty Management Content Blocks package in your Engagement org.
View Your Instance’s Status: Find out if your instance has a performance degradation or service disruption, or if it’s undergoing maintenance.
Promotion Integration with Marketing Cloud Personalization: Use Marketing Cloud Personalization (formerly Interaction Studio) to provide targeted promotions to members in real time. Configure your Salesforce org and Marketing Cloud org to ensure that your promotion-related data is available in Marketing Cloud Personalization. This configuration requires you to create segments by using Data Cloud.
Add Custom Fields in the Promotion Object: The Promotion Extract, Transform, Load (ETL) jobs in Marketing Cloud Personalization (formerly Interaction Studio) require three fields that aren't available in the Promotion object. Before you send your Promotion object data to Marketing Cloud Personalization, add the required fields in the Promotion object.
Prepare Marketing Cloud Personalization to Receive Promotion Data: After you send your Promotion, Promotion Market Segment, and other Loyalty Management data to Marketing Cloud, prepare Marketing Cloud Personalization (formerly Interaction Studio) to receive the data from Marketing Cloud.
Send Promotion Data from Marketing Cloud to Marketing Cloud Personalization: After you prepare Marketing Cloud Personalization (formerly Interaction Studio) to receive Promotion, Promotion Market Segment, and other related object data, you must send the data to Marketing Cloud Personalization. Prepare a data extension that's compatible with Marketing Cloud Personalization's Promotion ETL, and then send it by using Automation Studio in Journey Builder.
Issue Vouchers to Members: You can issue a voucher for a member from the Loyalty Program Member Record page.
Learn About Journal Types and Subtypes: Journal types and subtypes help categorize transaction journals. Specifying the journal type and subtype of a transaction journal helps you to design processes that process transaction journals based on their type and subtype. For example, you create transaction journals of the type Accrual and subtype Member Enrollment to credit points to members for joining a loyalty program. Now you can design a process to credit points to new members when the member’s transaction type is Accrual and subtype is Member Enrollment.
JWT-Based Access Tokens: Salesforce supports two types of access tokens: opaque tokens and JSON Web Tokens (JWT)-based access tokens. An opaque access token is formatted as a string that you can’t decode unless you call the Salesforce User Info endpoint. A JWT-based access token is formatted as a JSON object that contains all of the information required to authorize an app. This transparent format makes JWT-based access tokens easier to use for services built outside of the Salesforce platform. You can easily parse and validate JWT-based access tokens locally on your off-platform service, without calling a Salesforce endpoint. By locally introspecting tokens, you can improve the performance and efficiency of your authorization flows.
Configure an External Client App to Issue JWT-Based Access Tokens: Enable JWT-based access tokens for an existing external client app that you either created as a developer or installed from a managed package as an admin. Use the External Client Apps Manager in Setup. Or configure your external client app via Metadata API.
Use Kanban to Work with Graphical Views of Your Records: Kanban views show records in a graphical way that helps you monitor your work and keep deals moving ahead. Kanban views are available for most objects, with exceptions such as tasks.
Set Up a Kanban View: Arrange a kanban view to show a graphical view of records in a list view. Each kanban view is based on a list view, and kanban view settings are applied separately for each list view.
Work in a Kanban View: Narrow the records you want to focus on by searching and filtering a kanban view, and view records by record type. Update records by dragging, or edit a card without leaving the kanban view. If your Salesforce admin has set up key fields and guidance, you see them in the details panel. If you’re viewing opportunities, alerts help you move deals ahead.
Key Components: Get to know the key components of loyalty processes.
Learn About Price Protection: Manage Price Protection programs for partners and distributors to ensure margin stability amid price fluctuations. Set up flexible programs by configuring partner eligibility, price type, and duration. Seamlessly manage simulations and executions by identifying impacted partners, unsold inventory available with them, and automating claims. Foster stronger partnerships by providing clear visibility into Price Protection claims for seamless collaboration.
Compare Lightning Experience and Salesforce Classic: Here are some highlights of how Lightning Experience compares with what you’re used to in Salesforce Classic. The list includes features that are available only in Lightning Experience.
What to Expect in Lightning Experience If Chatter Is Turned Off: If your organization doesn’t use Chatter, some features of the Lightning Experience interface aren’t available. Learn how Lightning Experience changes, and see if you’re losing functionality that you’d rather not live without.
Gaps Between Salesforce Classic and Lightning Experience: Learn about Salesforce Classic features that aren’t available in Lightning Experience. Because Lightning Experience re-envisions the Salesforce Classic, there are some classic features that have been implemented differently or don’t have a place in the new interface. If your users need features that aren’t in Lightning Experience, they can switch to Salesforce Classic and keep working.
Implement Lightning Experience Features: To maximize the value of moving your business operations to Lightning Experience, take advantage of the many Lightning-only features that transform how users work. You can create a user experience that improves workflow and productivity, makes jobs easier and more intuitive, even transforms your business. Start with the features that best benefit your users. Then keep iterating over time to add even more value.
Give Users Access to Lightning Experience: When you’re ready to go live with Lightning Experience, it’s not necessary to enable or otherwise turn on the interface. Instead, simply make sure that the appropriate users have access via the Lightning Experience User permission. If you’re rolling out Lightning Experience in phases, set up access for the users in your first group (and so on). If you’re doing a “big bang” rollout, set up access for everyone in your org.
Turn Off Access to Salesforce Classic: Ready for some or all of your users to go all in on Lightning Experience? Keep them in the new interface by removing the option to switch back to Salesforce Classic.
Lightning Experience Insights: Use on-demand insights to identify, analyze, and improve the performance of your custom Lightning pages and Lightning components. Lightning Experience Insights provides a high-level overview of your users’ experience, and detailed metrics to identify bottlenecks and optimize page load times. You can find this data inside the Performance Insights and Usage Insights dashboards.
Performance Insights: The Performance Insights dashboard focuses on four core metrics for page performance, which it measures and presents in different ways to provide useful insights. These four metrics appear at the top of your report.
Usage Insights: Generate Usage Insights to identify your most popular pages and evaluate their performance. This dashboard lets you pinpoint performance bottlenecks and focus on optimizing your most used pages.
Try New Features with the Lightning Extension for Chrome: Are you an early adopter of the latest and greatest technology … or do you want to become one? With the Lightning Extension for your browser, you can gain access to the latest Lightning features and try them before everyone else.
Link Grabber (Beta) FAQ: Save time every time you open a Lightning link. Makes all Lightning links open in a single browser tab.
Migrate Your Classic Knowledge Base to Lightning Knowledge: If your company uses Classic Knowledge, Lightning Experience users must switch to Salesforce Classic to do things like find or create Knowledge articles. Moving your Classic knowledge base into Lightning Knowledge gives your users a seamless experience and much better workflow. When you’re ready, the Lightning Knowledge Migration Tool does most of the heavy lifting for you.
Get Lightning Experience Adoption Insights with the Lightning Usage App: After moving users to Lightning Experience, make sure that they’re committed to working in the new interface. The Lightning Usage App lets you monitor adoption metrics, such as daily active users and the most visited pages in Lightning Experience. You can also track the number of your active licenses. These insights help you understand your users’ needs so that you can focus on the issues that really matter.
Convert Attachments and Classic Notes: Does your org use attachments and notes? In Lightning Experience, users get a better experience if you convert existing attachments to Salesforce Files and classic notes to enhanced notes. You can automate this conversion work with the handy Magic Mover for Notes and Attachments tool.
Measure the Success of Your Lightning Experience Transition: After you roll out Lightning Experience to users, monitor that you're hitting your goals, improving business, and getting traction with users. Collect user feedback to see what’s working and what’s not. Track adoption metrics, such as daily active users and number of users switching to Salesforce Classic, with the Lightning Usage App.
Adjust Your Existing Customizations: Most of your existing point-and-click and programmatic customizations work seamlessly in Lightning Experience. But some customizations aren’t useful or relevant outside of Salesforce Classic. And some aspects of your classic implementation require adjustment for best results in Lightning Experience. Here’s a look at issues to consider.
Prepare Your Org for Lightning Experience: Before giving users access to Lightning Experience, we recommend setting up key features that can boost productivity and efficiency in the new user interface. This is also the time to review and prepare your existing customizations so everything works as expected in Lightning Experience.
How to Manage the Transition to Lightning Experience: Based on our experiences and those of the thousands of Salesforce customers who have moved to Lightning Experience, we’ve defined guidelines and best practices that you can follow for a successful transition. We recommend taking an iterative, agile approach where you break up the work into several phases.
Update Visualforce Markup for Lightning Experience: Some Visualforce pages may need tweaking to work in Lightning Experience. Don’t worry if you don’t have Visualforce experience—the workarounds show you exactly what to do each step of the way. Always test your Visualforce page in Lightning Experience first—most work as-is. If the listed issue is preventing the page from working properly, follow the instructions to tweak the markup and make it work. If a Visualforce page requires significant refactoring, move it to a Lightning component.
Replace Static URLs: Lightning Experience doesn't support the use of static URLs to link to Salesforce resources. Fortunately, there's a much better alternative that future proofs your URLs. URLFOR is a function that calculates a URL based on inputs, rather than relying on something static that can't change. Use the URLFOR function with the appropriate action instead of direct URLs.
Reconfigure iframe Components: When a URL is displayed in an inline frame (iframe) on a Visualforce page, it can cause errors in Lightning Experience. Sometimes your URL looks different than you want, or maybe the whole page doesn't load in Lightning Experience. Most iframes are compatible with Visualforce in Lightning Experience. However, if you preview your Visualforce page in Lightning Experience and don't like what you see, you can usually fix it.
Apply Lightning Stylesheets to Visualforce Pages Manually: With Lightning stylesheets, it’s easy to tweak your existing Visualforce pages so they’ll display with classic styling in Salesforce Classic and Lightning styling in Lightning Experience.
Replace the window.location Method: The window.location variable is a JavaScript method used to redirect the browser to a new page. JavaScript code in a Visualforce page that sets window.location directly isn't compatible with Lightning Experience. That's the bad news. The good news is that sforce.one navigation methods do the same thing, and are compatible with Lightning Experience.
Manage Activities with the Activity Timeline: Keep track of all your activities with the activity timeline in Lightning Experience. All the key details for each task, meeting, logged call, and sent email are bundled together, and you can quickly log calls, create tasks, send emails, and more from the handy composer.
Gotchas If Users Switch Between Lightning Experience and Salesforce Classic: Switching between Lightning Experience and Salesforce Classic affects the underlying URL routing logic and can lead to some unexpected results when links are resolved. There can be snags with bookmarks and sharing links in emails or Chatter posts—especially if only a subset of your users are working in Lightning Experience.
Salesforce Classic Doesn’t Go Away When You Move Users to Lightning Experience: Saying hello to Lightning Experience doesn’t mean saying goodbye to Salesforce Classic. You and your users can easily move between the new and classic interfaces as needed. So even if Lightning Experience isn’t a perfect fit yet, there’s no risk in rolling it out. Some occasional switching is worth getting the productivity benefits from the new experience.
Transition from Salesforce Classic to Lightning Experience: Salesforce Lightning is the current generation of Salesforce, delivering an intuitive user interface (Lightning Experience), a powerful platform for fast and easy app development, and the AppExchange ecosystem for ready-to-install solutions. The Salesforce Classic user interface isn’t going away yet, but all new Salesforce innovation is available in Lightning Experience only. Get the features and functionality you’re entitled to by transitioning your org off Salesforce Classic. Check out the resources and guidance we’ve prepared to help you and your users make the change to Lightning Experience.
Reports and Dashboards: What’s Different or Not Available in the Salesforce Mobile App: Reports and dashboards have some limitations and differences in the Salesforce mobile app, such as the maximum number of rows displayed in reports, the absence of joined reports, and the inability to create, edit, or delete reports and dashboards. Dashboards have a single-column layout on phones and up to two columns on tablets, and report charts are only available after drilling into a dashboard component's report.
What’s Different or Not Available in the Salesforce Mobile App: The Salesforce mobile app doesn’t include all the functionality that’s available in Lightning Experience on desktop. Learn about the Salesforce features that aren’t available, that have functional gaps from what you’re used to in Lightning Experience on desktop, or that work differently.
Customize Your Data View: Create customized list views to display records that meet your own criteria. You determine which records display by setting filters. All records that meet your filter criteria appear in your list view.
How Does Live Data Work in Quip?: Learn about the different live data integrations you can add to your documents, spreadsheets, and templates.
Locate Your Email Address and Username: Every user account has both an email address and a username that’s formatted to look like an email address. It can be confusing to keep track of these values, but you can look them up in your account settings.
Log In with Your Email Address: Enter your email address instead of your username to access your Salesforce user account. If you have more than one user account, each is shown. Select the account to log in to, and complete the authentication process.
Log In as Another User: To help troubleshoot user issues, admins can log in to a Salesforce org or Experience Cloud site as the employee user experiencing the problem. Depending on your org settings, the individual user can be prompted to grant login access to an admin.
Restrict Login IP Addresses in Profiles: To control login access at the user level, specify the ranges of allowed IP addresses on a user’s profile. When you define IP address restrictions for a profile, a login from any other IP address is denied.
How Loyalty Management Consolidates Subcurrency Point Balances: When members transact, Loyalty Management uses Loyalty Aggregated Point Expiration Ledger records to consolidate point balances based on currency, subcurrency, and expiration date. The system performs real-time aggregation for all subtypes regardless of the settings on the Loyalty Management Settings page.
Run Data Processing Engine Definitions: After you create currencies that use the Activity With Mixed Subcurrencies expiration model, run the Data Processing Engine definitions required to expire currencies and roll over escrow points.
Set Up Loyalty Program Processes and Actions: After you create currencies and their subtypes, create loyalty program processes or use invocable actions to credit and debit subcurrency points.
Activity-Based Currencies with Mixed-Expiration Subcurrencies: Optimize financial liability and drive member engagement by creating currencies that use the Activity with Mixed Subcurrencies expiration model. This model provides members with long-term value from their activity-based expiration points while encouraging the timely redemption of fixed-expiration points. It also provides liability control across partners and promotions by using point traceability.
Track Redemptions and Associated Accruals with Traceability: Trace consumed points to their originating source by using traceability loyalty ledger records. Traceability records map target debit ledgers to source Loyalty Aggregated Point Expiration Ledger records. If a single debit ledger consumes points from multiple aggregate ledgers, Loyalty Management creates a dedicated traceability record for each aggregate ledger from which points are consumed.
Agentforce for Loyalty Management: Marketing managers can leverage the power of Agentforce to efficiently manage everyday tasks related to the company's loyalty programs and promotions. Customers can use Agentforce to self-serve and resolve their promotion-related queries without contacting a customer service representative.
Set Up Agentforce: Admins must set up Einstein Generative AI and Agentforce to enable marketing managers and other users to work with the standard Agentforce assets provided by Loyalty Management.
Subagent: Promotion With Loyalty Accrual Rule: Marketing managers can use the Promotion With Loyalty Accrual Rule subagent to create and update promotions that reward loyalty program members for completing eligible accrual activities. They can also draft loyalty promotion emails for effective communication.
Subagents for Loyalty Management: Marketing managers can use Agentforce to efficiently create and update promotions with Accrual and Spend X templates. Agentforce in self-service channels empowers customers to easily retrieve details about their profile and eligibility for loyalty promotions. The subagents are available in the Agentforce (Default) agent.
Impact of Asynchronous Point Tracing on Loyalty Processes: Based on the data volume and currency-type, turn on asynchronous point tracing. When you turn on asynchronous tracing, pending traceability records are created in real time and processed asynchronously. Review how pending traceability records affect various processes, such as point expiration, redemptions, and transfers.
Set Up Traceability: To link redemption transactions directly to source accrual transactions, turn on traceability for redeemable currencies. Set up Data Processing Engine definitions and invocable actions to process trace records and expire points.
Loyalty Management on Hyperforce: Loyalty Management is available on Hyperforce. With the Hyperforce architecture, you can store your Loyalty Management data locally by using Salesforce's public cloud partners.
Benefits: Use benefits to reward and motivate loyalty customers when they increase their engagement with the loyalty program.
Loyalty Events: When you purchase a Loyalty Management license, event entitlements are granted upon contract activation. You can use these granted events according to the contract length, without any daily or monthly limits.
Add Benefits and Promotions: After you configure the eligibility criteria of the club, you can add the benefits that your club offers, and the promotions that are exclusive to your club members. You can create promotions for club members or offer the company’s already running promotions.
Add a Club Member: After you set up a club and activate it, you can add club members.
Clubs Data Model: Clubs are interest-based membership initiatives designed to provide exclusive benefits and privileges to customers.
Design a Club: To design a club, enter the basic information about your club, define various membership plans, and establish clear eligibility criteria.
Define Club Eligibility: After you create a club, add membership plans and configure eligibility criteria for customers to enroll.
Enable Clubs: Enable a setting to design and manage clubs for customers with similar interests and affinities. Create clubs that engage club members with personalized benefits and promotions.
Key Roles in Clubs: Understand the key positions that drive the operations and engagement within clubs.
Manage Clubs: Clubs are interest-based membership initiatives designed to provide customers with exclusive benefits and privileges. Customers can join a club through a subscription model or based on their current loyalty program tier. By offering unique benefits and exclusive promotions, clubs can enhance customer loyalty.
Club Management: Managing clubs involves a range of tasks, such as enrolling new members and leveraging business APIs for streamlined operations.
Enter Primary Information: To get started with your club, enter the basic details, including the name, description, and the start and end dates.
Club Setup: Learn about the necessary prerequisites for clubs and the audience of clubs.
Considerations to Disable Traceability: Learn how to manage unprocessed redemption records and understand the impact of disabling traceability on existing records.
Enable Tracing and Create Currency Subtypes to Control Liability: After you enable traceability settings, for each currency for which you want to create trace records, enable ledger tracing. If necessary, create currency subtypes to categorize points. Use these subtypes to specify which points are accrued from a transaction or a promotion, define the consumption order for redemptions, and restrict usage based on transaction types.
Create a Digital Pass Template: Create a digital pass template to connect the static designs on Google's console and the dynamic data stored in Salesforce. This template defines the static design and layout of the pass.
Create a Loyalty Program Using Record Pages: The Loyalty Management app lets you create and set up loyalty programs for your Salesforce organization. You can configure each component of your loyalty program from the respective record page.
Create a Loyalty Program by Using Simplified Setup: Configure and activate your loyalty program in a few easy steps. The simplified setup enables program managers to create a loyalty program, and add redeemable currencies, define tier groups and tiers, map benefits, and track eligible activities.
How Currency Subtypes Are Debited: Use the Debit Points action in a loyalty program process or flow to debit member points. To process redemption transactions, define the sequence in which currency subtypes are used.
Data Cloud for Loyalty Management: Gather insights about your company's loyalty program and its members with Data Cloud. A prepacked data bundle enables admins to set up the connection that sends data from Loyalty Management to Data Cloud. To create targeted member segments, users must be assigned the Data Cloud Activation Specialist permission set.
Loyalty Management Data Kit Components: The Loyalty Management data kit consists of a set of data stream bundles that enable your company to send data from Loyalty Management objects to Data Cloud. Along with the data stream bundles, the data kit consists of data model objects (DMOs). The data kits also add field mappings to data lake objects (DLOs) and associate the DLOs with their corresponding DMOs for objects that are available with your Loyalty Management license.
Data Protection and Privacy for Loyalty Management: When companies use Loyalty Management to run their loyalty programs, they must comply with local and global data protection and privacy regulations. As part of your company’s loyalty program strategy, decide how you want to delete, export, archive, restrict access, manage consent, and restrict the processing of customer data stored as part of the loyalty programs.
Developer Resources for Loyalty Management: Developers can take advantage of Loyalty Management developer resources to create loyalty programs and automate program processes.
Compare Segment Verification Methods: Compare the three available methods for verifying a member's Data Cloud segments to determine which best fits your business requirements.
Enable Traceability Settings: To link redemption transactions directly to source accrual transactions, turn on traceability for redeemable currencies with the fixed-duration expiration, activity-based expiration, or both.
Enrollment Behavior for Predictive AI Model Promotions: When a member enrolls, Salesforce copies predicted target values from the output data model object to the member's Promotion Party Usage record. Enrollment fails if no prediction record exists, and target values are locked after the member enrolls.
Events in Loyalty Management: A loyalty event constitutes any member activity that creates a transaction journal. For example, member purchases, social media posts, app downloads, voucher redemptions are all tracked and processed in Loyalty Management as events. Loyalty events also include events performed by automated processes or service reps and not directly performed by members like point expiration, qualifying points, and manual points adjustment.
Expire Fixed Non-Qualifying Points by Using Aggregation Ledgers and Traceable Ledgers: Use the Expire Fixed Non-Qualifying Points Using Aggregation Ledgers and Traceable Ledgers Data Processing Engine definition to expire fixed-type, non-qualifying points for members and currencies without pending traceability ledgers. Run the definition to expire member points regardless of whether you’re consolidating member points in real time or in batches.
Define Activities That Extend Activity-Based Points Validity: Define the activities that update members’ last activity date to extend the expiration date of activity-based, redeemable points. Then, clone and use the Data Processing Engine template, Identify and Update Activity Dates for Loyalty Program Members, to update the last activity date of loyalty program members.
Offer Games to Members: Brands can keep its customers and loyalty program members engaged by offering them games as rewards. Use games to reward purchase-specific activities such as placing an order and non-purchase activities such as completing a survey.
Workflow for Offering Games to Members: After a program manager creates a game and adds its rewards, the game can be offered to customers in several ways. Admins can use Business APIs to enable customers to play games on external systems such as mobile apps or shopping sites. Program managers can also set up processes that assign games to members based on their loyalty activities. Customer service reps can assign games to customers and members as part of service recovery actions.
Create Games and Add Rewards: Program managers can create games such as spin the wheel and scratchcard, and decide the rewards that customers receive after they play the games.
Einstein for Loyalty Management: Reduce the amount of time that various departments across your company spend to manage and run your company's loyalty programs with Einstein for Loyalty Management.
Enable Einstein for Loyalty Management: The Einstein Summary component uses the power of Einstein generative AI to summarize loyalty programs and loyalty promotions from data that reside across multiple objects.
Einstein Summary Components for Loyalty Management: After admins turn on Einstein for Loyalty Management, the Einstein Summary component is automatically added to the Loyalty Program record page and the Promotion record page. Users can use Einstein Summary to securely generate summaries for their loyalty programs and loyalty promotions.
Create JSON Web Token (JWT) External Credentials: The external credential represents the details of how Salesforce authenticates to an external system via an authentication protocol. To use named credentials, you must first configure an external credential.
Cross-Platform Setup: To successfully issue digital passes, you must complete specific configuration tasks across both the Google Cloud and Salesforce environments.
Digital Pass Template Setup and Dynamic Pass Generation: A loyalty program manager can design loyalty classes on the Google Pay and Wallet Console. When the program manager creates digital pass templates, they can fetch the classes created to generate the digital pass.
Integration Prerequisites and Setup: Integrate Loyalty Management with Google Wallet, allowing a loyalty program to generate digital passes and provide real-time membership updates to your members.
Create Named Credentials: Named credentials offer a declarative and secure way to store and manage the credentials needed for HTTP callouts so that Salesforce can authenticate with external APIs.
Create Principals for JWT: After you create an external credential that uses JWT authentication, create principals for it. Use the principal to grant access to your external credential.
Generate and Upload Java Keystore (JKS) Certificate: Use the Java Development Kit to generate a Java Keystore (JKS) Certificate. You need a service account key in the form of a JSON file (.jks) to generate a JKS certificate. Import your certificates and private keys from a keystore to Salesforce.
Automate Promotions Data Sync in Marketing Cloud Engagement for Loyalty Management: Global Promotions Management relies on the Marketing Cloud Connect managed package to send data from the Global Promotions Management org to a Marketing Cloud Engagement instance. The marketing journeys that are created in the connected Engagement org for activated promotions use the Global Promotions Management data to send out promotion launch emails. So install and set up Marketing Cloud Connect in the Global Promotions Management org and in the connected Engagement instance. After setting up Marketing Cloud Connect, create Synchronized Data Sources for Global Promotions Management objects in the Engagement instance.
Configure Rule Libraries for Promotion Context Definitions in Loyalty Management: Global Promotions Management uses rule libraries to let marketing managers use context definition tags in promotion rule eligibility criteria. When creating custom tag mappings for promotions, create additional Loyalty Management mappings based on promotion requirements.
Quick Promotion Wizard in Loyalty Management: After admins turn on Global Promotions Management, the Quick Promotion wizard is enhanced to include Global Promotions Management templates and capabilities.
Create Context Definitions for Global Promotions Management in Loyalty Management: Global Promotions Management uses the capabilities of Context Service to enable marketing managers to design pricing promotions tailored to each company's unique requirements. A standard context definition is used to design pricing promotions for most use cases. You can also create custom context definitions for your company’s promotions. If you’re creating a custom context definition for promotions, create additional Loyalty Management nodes based on your business needs.
Define Promotion Eligibility: Loyalty Management Considerations: On the Define Promotion Eligibility step in the Quick Promotion guided flow, marketing managers decide the products, channels, customer groups, and customer events that are eligible for the promotion. For loyalty promotions, you have additional options in the various sections of this step.
Design Promotions for Loyalty Management: Run two types of promotions by using Global Promotions Management with Loyalty Management: promotions within loyalty programs and promotions for your entire customer base outside the programs. Marketing managers use the Promotion Console app to design both these promotion types and perform day-to-day operational tasks. Loyalty program managers and marketing managers can also build loyalty-specific promotions from the Loyalty Management app.
Enter Primary Information: Loyalty Management Considerations: On the first step of the Quick Promotion wizard, marketing managers enter the promotion’s name, duration, code, and business unit. For loyalty promotions, you can select the loyalty program that the promotion belongs to.
Map Loyalty Promotion Requirements to Global Promotions Management Features: In addition to standard capabilities, Global Promotions Management supports specific requirements for loyalty programs. Use this mapping to identify the features that help you meet your loyalty program business requirements.
Quick Promotions with Loyalty Management: With Global Promotions Management, loyalty program managers can design both pricing and non-pricing promotions. They can design the promotions to run as part of the company’s loyalty program or outside the loyalty program as part of the company’s 360-degree marketing strategy.
Considerations to Use Quick Promotions Wizard in Loyalty Management: Each step of the Quick Promotion wizard provides marketing managers a set of options to design promotions based on your company’s marketing strategy. Here are the loyalty-specific considerations to use the various steps of the wizard.
Select Promotion Template: Loyalty Management Considerations: The Select Promotion Template step in the guided flow lists the templates that marketing managers and loyalty program managers use to create the promotion’s rules. When using Global Promotions Management templates on this step, you can also offer loyalty-specific rewards. In addition, you also have access to loyalty-specific templates.
View the Name of a Group Member: The Member Name field of the Loyalty Program Group Member Relationship object stores the contact or account name of a group's Individual or Corporate member. Admins must provide access to users to view the Member Name field; by default, users don’t have the permission to view this field.
Update the Layout of Loyalty Program Member Record Page: The page layout for Individual, Corporate, and Group type Loyalty Program Member records are the same. But, some of the related lists on this page layout don't apply to Individual and Corporate members, or to groups. Customize the layout to ensure that the most relevant related lists appear for each member type.
Learn How a Group’s Point Balances Are Managed: Loyalty Management automates the process that manages group balances. Here’s a summary of how you can use Loyalty Management to manage a group’s point balances.
How Accrual Cancellations Are Processed: When an accrual transaction is canceled, the member’s balance must be debited with the points they accrued. So, accrual transactions are canceled only if there’s sufficient balance, including the negative point balance.
How Currency Subtypes Are Credited: Use the Credit Points action in a loyalty program process or flow to credit members with points for currency subtypes. Select the currency subtype associated with a traceable non-qualifying currency. When an accrual transaction journal is processed, the Credit Points action credits the member’s points balance. Track the details of the currency subtype and points credited in the related loyalty ledger.
How Redemption Cancellations Are Processed: When you cancel a redemption, the member’s point balance is credited with the number of points initially redeemed. So, a corresponding credit-type ledger is created for the canceled redemption. At the same time, all debit ledger traces are removed from the Traceability Loyalty Ledger object.
Individual Segments: Use individual segments when you need to target customers based on contact or profile attributes without requiring loyalty program context.
Integrate Loyalty Management With Google Wallet: Drive customer engagement by integrating your loyalty program with Google Wallet. This integration allows loyalty program managers to issue and manage dynamic digital passes, such as loyalty cards and vouchers, directly within customers' Google Wallets.
How Personalized Promotions Work in Loyalty Management: Personalized Promotions replace a single fixed target with individualized Easy, Moderate, and Hard targets for each of your program members. Sourced from a predictive AI model or an external model, personalized targets determine how members enroll in, qualify for, and earn rewards from a promotion.
Loyalty Management Limits and Considerations: Loyalty Management provides a set of features and capabilities that enable companies to manage and run business processes related to their loyalty programs. Each of your business processes can use features such as Promotion Setup and Salesforce Flows, and different services such as business APIs, Data Processing Engine, and Business Rules Engine. When planning your implementation of Loyalty Management, make sure that you account for the Loyalty Management limits and considerations.
Loyalty Management Feature Limits: Learn about the limits that loyalty program managers, marketing managers, and sales reps come across while using Loyalty Management.
Limits Framework in Loyalty Management: To handle high-volume, concurrent events, Loyalty Management provides a framework for enforcing limits on points and vouchers.
Loyalty Management Standard Object Access: The Loyalty Management data model comes with a set of objects and fields to manage information related to loyalty programs, rewards, members, and member activities. The objects and fields available in your org depend on the features included with your Loyalty Management license. Most of the objects can be customized and extended based on your company's requirements but there are a few objects that either can't be customized have restricted customization options.
Link Partners by Using Loyalty Management: The loyalty program member and partner must belong to the same loyalty program. A loyalty program manager or a customer service representative can initiate the linking. Make sure that you initiate linking within the linkage window that the partner allows.
Link Partners With Loyalty Program Membership: Members can link their membership with partner accounts or partner loyalty memberships to seamlessly access co-branded rewards, such as bonus rewards or free upgrades to a higher tier. The loyalty program member and partner must belong to the same loyalty program. Linking memberships provides members with additional benefits in the home loyalty program. For example, a member staying at a hotel can get a discount on a car rental of a partner brand during the stay.
Link and Unlink Partners by Using APIs: A loyalty program member or a customer service representative can link and unlink partners. The partner linking process begins when a customer initiates a linkage from either a partner app or the loyalty ecosystem.
Manage Loyalty Programs: A loyalty program is your starting point for setting up Loyalty Management in your Salesforce org. It helps to design, organize, and customize the loyalty building blocks with loyalty programs.
Loyalty Management for Partners: Loyalty Management helps partners create personalized programs that recognize, reward, and retain customers. Design and manage B2B or B2C loyalty programs, track member activity, and offer points, vouchers, and promotions. Build a network of participating brands with Loyalty Program Partners to expand benefits and increase engagement. Give members an easy way to track their rewards and benefits through the Loyalty Member Portal.
Personalized Promotions in Loyalty Management: Increase engagement and maximize revenue by using predictive AI to set unique targets for each loyalty program member instead of one fixed target.
Member Groups: You create groups and add members to the groups. Members can contribute a percentage of their own points to a group. A member can be a part of multiple groups and can also decide the percentage of points to contribute to each group.
Transfer Member Points to Groups: If the Transfer Points to Member Group Automatically setting is turned on, the points are transferred automatically. If the setting is turned off, use the Transfer Member Points to Groups action to transfer members' redeemable points to their associated groups.
Launch Your Loyalty Member Portal: Keep your loyalty members engaged by letting them track their own progress in the program with the Loyalty Member Portal. Members can view their profile details, loyalty program details, membership details, recent transactions, points balance, and current tiers. Members can also view the program currencies that members hold, the credited vouchers, promotions, and the benefits.
Loyalty Member Portal Workflow: Here's a quick summary of all the steps an admin must complete to set up a loyalty member portal.
View Member Information from Any Salesforce Application: Use Loyalty Member Profile component to display loyalty member information on the Contact or Account records. Or use them on any other records that have a lookup relationship with the Contact or the Account object, for example, Case records.
Allow Members to Join and Leave Loyalty Program and Promotions from Experience Cloud Site: Give contacts, accounts, and person accounts in your company the permission to join or leave your loyalty program from the loyalty program’s Experience Cloud site. You can also give loyalty program members the permission to join or opt out of promotions from the Experience Cloud site.
Select Members for Tier Upgrade Automatically: You can select members automatically for tier upgrade when their qualifying point balance changes. The setting helps you avoid setting up a custom process to find the members eligible for tier upgrade assessment. In your tier upgrade process, you can assess and upgrade the tier of members who have been automatically selected for tier upgrade assessment.
Negative Points: Members can now use more points than their current balance for redemptions. You can enable a negative balance for the required non-qualifying currencies, and define the negative balance limit for each tier. Enable a negative points balance in a loyalty program to increase member engagement, boost sales, and enhance customer loyalty.
Enable Negative Point Balance for Non-Qualifying Currencies: Enable currencies to accommodate negative points balance for members. Turn on the negative point balance setting in Salesforce. When you enable negative point balance, members can redeem points beyond their existing points balance.
Reduce Storage with Just-in-Time Member Currency Record Creation: Create loyalty member currency records when members first earn points, not automatically at enrollment. If you turn on negative point balances, Loyalty Management creates records on the first debit if a member currency record doesn’t exist. These changes reduce the number of unused records stored in your org.
Get Started with Loyalty Management: Loyalty Management helps organizations design and run loyalty programs that recognize, reward, and engage your customers. Run B2B and B2C loyalty programs tailored to your industry’s requirements. Explore a trial org and then learn about what’s included, what setup we recommend, and how to get ready for your implementation.
Experience Cloud Site Access for Partners: Partners often require access to view the details of a loyalty program and its rewards and members. In some cases, partners need access to update the information in the loyalty program. For example, you can provide partners access to view the active promotions that they’re part of and to create transactions where members have purchased a partner product. Based on the requirements of your partners, you can provide them with access to Loyalty Management objects from your Experience Cloud site.
Permission Set License for Loyalty Management: Each type of Loyalty Management license provides a specific number of Loyalty Management permission set licenses. When you assign a Loyalty Management permission set to a user, the number of Loyalty Management permission set licenses that are available in your org reduces by one.
Loyalty Management Permission Sets: Give users in your org the required access to Loyalty Management features. Use the permission sets provided by Salesforce, or clone the default permission sets to create role-based custom permission sets for the users.
Personalized Promotion Wizard in Loyalty Management: The Personalized Promotion Wizard follows the same flow as the Quick Promotion Wizard, with one extra step and personalized target values instead of hard-coded values.
Training and Scoring Options for Personalized Loyalty Promotions: Reference the configuration options for setting up data, defining model parameters, and configuring debug settings when creating a Scoring Framework template configuration for Personalized Promotions.
Points Accounting with Traceability and Currency Subtypes: To manage liability for redeemable points across partners and promotions, automatically link redemption transactions to source accrual transactions by using traceability. After you turn on traceability, use subtypes to define how different types of points are accrued and redeemed, and the order in which they’re redeemed. Track the link between redemption transactions and source accrual transactions by using Traceability Loyalty Ledger records.
Loyalty Management Point of Sale API: Integrate Loyalty Management with a Point of Sale system to manage customer loyalty programs and transactions with ease. You can integrate Loyalty Management with a POS system through Loyalty Management POS API Unlocked Package or through a combination of the unlocked package and Loyalty Management POS API Powered by MuleSoft. A Point of Sale (POS) system unifies in-store and online operations and provides the best experience for an existing or new member by using secure API requests. Use the APIs to get member profile details, enroll individual members in a loyalty program, manage vouchers, and create accrual and redemption orders.
What to Expect from Loyalty Management Point of Sale API: This scenario study explains what you can achieve with the Loyalty Management with POS integration through an unlocked package or through a combination of MuleSoft and unlocked package.
Define Eligibility Conditions for a Process: Define the conditions that determine the transaction journals that are eligible for a process. The process eligibility conditions that you define filter ineligible transactions before the transactions are processed by the rules of the process. Process eligibility conditions help ensure that the conditions that are applicable for all rules of the process, are defined at the process-level and not at the rule-level. For example, you can add eligibility conditions to filter out inactive member transactions that are less than a particular amount. Or, you can set a transaction value limit beyond which transaction journals aren’t processed to ensure fraudulent activities aren’t rewarded.
Create a Rule: Define a business scenario to process transaction journals in a rule. You can associate a rule with a promotion to ensure that transaction journals are only processed by the rule during the promotion period. A rule contains conditions and actions that help you design your business scenario.
Loyalty Program Currencies: Loyalty Program Currencies refer to qualifying and non-qualifying currencies associated with the program. Qualifying currency refers to the engagement of a member with the program and is associated with a tier group. Qualifying currency is used for a member’s tier evaluation. Non-qualifying currency refers to the points that the member earns for redemption.
Loyalty Program Home Page: The loyalty program home page allows you to view the primary details of a loyalty program and manage the day-to-day activities such as creating promotions, and managing games, vouchers, partners and processes with a single click.
Loyalty Program Member Segments: Use loyalty program member segments when you want to target customers based on loyalty-specific attributes such as tier, points, or membership status.
Loyalty Program Members: Loyalty program members are the members enrolled in a loyalty program that you create. A member can be part of multiple loyalty programs in an organization.
Manage Loyalty Program Partners: Loyalty Management enables the onboarding and managing of cross-industry program partners to increase member engagement with the loyalty program. Partnerships give your members more options to engage members and help them earn and redeem points for complementary products or services.
Create a Loyalty Program Process: A loyalty program can have multiple program processes. A program process can process either Accrual or Redemption-type transaction journals. You can also filter transaction journals further by specifying the subtype of transaction journals that you want to process.
Get a List of Promotions Applicable for a Member: Use the Get Loyalty Promotions for Data Cloud action to determine the promotions applicable to a member based on the member's Data Cloud market segment. The action provides a list of promotions that are associated with the market segment a member belongs to.
Update Member's Progress Toward Attaining a Cumulative Promotion: Members who achieve a specific target can avail a cumulative promotion. Members can achieve the target across multiple transactions. Use the Update Progress For Cumulative Promotion Usage action to update a member’s progress toward attaining a cumulative promotion.
Get Members' Active Segments: Use the Get Member's Active Segments action in flows to get the list of active Data Cloud segments to which members belong. You can use this action in flows that reward members based on their segment.
Get a List of Promotions Applicable for a Transaction: The Get Loyalty Promotions for Transactions action lists promotions that you can offer for a transaction. The action uses predefined filter criteria to decide eligible promotions.
Open the Promotion Calendar: Use the promotion calendar to view all your promotions in one place. You can also view all your events in the promotion calendar.
Clone Promotions: Loyalty program managers can clone their seasonal or repetitive promotions. Instead of creating a promotion from scratch, loyalty program managers can clone a similar promotion, edit the cloned promotion if necessary, and activate the new promotion. Loyalty program managers can clone promotions that are created either using the standard Promotion page layout or using the Quick Promotion guided flow.
Flow Actions for Promotions: Use the three Flow actions to find eligible promotions for members and track members' progress toward availing cumulative promotions.
Manage and Work with Promotions: Promotions are a way to engage loyalty program members by providing them valuable offers at a specific time, often tied to a seasonal sales cycle. Promotions can play a significant role in increasing product sales and generating business revenues. Promotions help loyalty program members get a better return on their investment with attractive offers in the form of vouchers or loyalty points.
Promotion Calendar: Loyalty program managers can visualize all promotions of a loyalty program on the promotion calendar. The promotion calendar lists events, so program managers can check whether promotions are planned during company and social events. On the calendar, program managers can select a date range and view the active and inactive promotions available during the period. Program managers can view promotions in groups or filter promotions to easily find the promotions that they’re looking for. The promotion calendar helps program managers easily find white spaces where new promotions can be added. And, view the details of multiple promotions in a single view helping you identify duplicates.
Loyalty Promotions Data Kit: The Loyalty Promotions data kit consists of a set of data stream bundles that enable your company to send promotions data from Loyalty Management objects to Data Cloud. Along with the data stream bundles, the data kit consists of promotion-related data model objects (DMOs). The data kit also adds field mappings to data lake objects (DLOs) and associates the DLOs with their corresponding DMOs. Loyalty Management dashboards, such as Promotion Performance Dashboard, use these Data Cloud components as the data source.
Manage Limits for Record-Based Promotions: Restrict the total number of vouchers issued and points credited per promotion. When transaction journals are processed, Loyalty Management checks usage in real time to make sure that limits are strictly enforced.
Decide Eligible Promotion Audience by Using Actionable Segmentation: Actionable Segmentation provides your company an easy-to-configure lightweight solution to find loyalty program members who are eligible for promotions. Program managers provide admins the criteria to filter the eligible loyalty program members for promotions. Admins create an actionable segmentation list definition based on the requirements. Program managers create the eligible members actionable list from the definition and associate the actionable list to the promotion the actionable list belongs to.
Record Alerts in Loyalty Management: Notify your customer service reps whenever you want the reps to act on a change in a member’s profile or on a new transaction journal. For example, you can alert a rep to issue a voucher on a member’s birthday or to validate a transaction that’s above the average transaction value for a member.
Enable Processes and Rules to Inherit Status in Target Orgs: Deploy loyalty program processes and their rules in the same status as defined in the LoyaltyProgramSetup metadata type. This means that if a process and its rules are active in the source org, they are in active status in the target org. Transferring processes and rules between orgs in their original status reduces post-deployment effort.
Explore and Set Up Customer Loyalty Features With Salesforce Go: Explore, set up and configure, and monitor usage of customer loyalty features in one streamlined setup location. Access content resources, such as videos, online tours, Trailhead, and Salesforce Help articles, to learn about features, and get help with configuration. Discover more loyalty features and add-on licenses that are available based on your Salesforce edition. And if you’ve turned on the Your Account app, you can quickly buy add-on licenses for some products directly from Salesforce Go.
Segment Creation Methods: Multiple approaches are available for segment creation. Choose the method that best fits your use case.
Set Up Data Cloud for Loyalty Management: Enable the flow of near real-time data about loyalty programs and its members from Loyalty Management to Data Cloud with preconfigured data streams. The data streams automatically map the data to Loyalty Management data model objects (DMOs) and their corresponding data lake objects (DLOs) in Data Cloud.
Enable Verification of Member Segments: After you complete the prerequisites to verify members segments, turn on the setting that automatically verifies members' segments for loyalty process rules and the Promotion Eligibility component.
Ways to Verify a Member's Segments: Based on your company's requirements, choose how loyalty process rules and the Promotion Eligibility component verify a member's Data Cloud segments. By default, the system uses Query API for Multiple Data Spaces.
Select Personalization Configuration: Loyalty Management Considerations: On the Select Personalization Configuration step of the Quick Promotion wizard, marketing managers choose which values to personalize and select the predictive AI source that generates the values. For Loyalty Management, you can select Salesforce’s Predictive AI Models or External Model.
Loyalty Service Excellence: Use the Identity Verification flows and the service console for Loyalty Program Members so that your customer service representatives (CSRs) can engage loyalty program members better. CSRs can use Identity Verification flows to verify the identity of your loyalty program members or their authorized member representatives. Then, CSRs can use the service console to resolve issues, clarify questions, manage requests, and more of loyalty program members or authorized member representatives.
Set Up Personalized Promotion Target Generation: Enable Scoring Framework and configure the required permissions and data settings before generating personalized promotion targets by using Predictive AI in Salesforce.
Set Up Points Extension and Reinstatement: To provide customers more time to redeem their points and to define reinstatement periods for currencies with the activity-based expiration model, create Loyalty Program Currency Extension Periods records. Then, configure Data Processing Engine definition runs to extend expiration, and run the Reinstate Points invocable action to reinstate points.
Configure a Tier Assessment Process: Loyalty program managers can define the minimum point balance that members require to be eligible for each tier in a tier group. A loyalty program process is automatically created based on the eligible point balance that the loyalty program manager has specified for each tier. The loyalty program process assesses and changes member tier based on the current qualifying point balance of members. If a member’s tier expiration date has passed, the process reassigns the member to the applicable tier based on their current point balance.
Tableau Next Analytics for Loyalty Management: Use Tableau Next dashboards to gain insights that help your users improve operational efficiency and fine-tune your loyalty program processes.
In-App Dashboards for Loyalty Management in Tableau Next: Loyalty Management in-app dashboards are standalone data visualizations that are typically accessed from dedicated analytics pages. Loyalty program managers use these dashboards as centralized hubs to analyze large datasets and monitor high-level performance metrics.
Embedded Dashboards for Loyalty Management in Tableau Next: Loyalty Management embedded dashboards are data visualizations integrated directly into record pages, with each dashboard designed to be added only to specific, relevant pages. They surface contextual, filtered insights alongside daily operational tasks without requiring navigation to a separate analytics hub.
Fraud Analytics Dashboard in Tableau Next: Detect potential loyalty fraud by monitoring accruals, redemptions, and manual adjustments against thresholds that you select on the dashboard. Filter global views by program, location, tier group, and duration to isolate specific datasets. Then use dedicated tabs for accruals, redemptions, members, and agents to analyze transaction patterns across touchpoints and users.
Loyalty Program Performance Dashboard: Track critical loyalty metrics, including points, revenue, and tiers. Measure the financial impact of accrued, redeemed, and expired non-qualifying points (NQPs) and monitor the overall points balance. Filter the view by program, tier group, currency, and activity date to isolate specific data sets. Gain targeted insights into key performance indicators for member acquisitions, member engagement, partners and products, and locations.
Member Preferences Embedded in Tableau Next: Learn about members' preferred partners and products for redeeming non-qualifying points. Filter performance views by duration and non-qualifying currency to isolate specific datasets. Analyze redemption activity to compare non-qualifying points redeemed against transaction volumes.
Loyalty Member Service Dashboard in Tableau Next: Analyze service representative activity and its impact on member point balances. Filter performance views by duration, currency name, and program to isolate specific datasets. Track key indicators including members with modifications, credited points, accrual reversals, and redemption reversals. Examine point modification breakdowns by action type and category. Evaluate how these adjustments affect qualifying and non-qualifying points over time.
Loyalty Member Service Team Performance in Tableau Next: Evaluate member service team efficiency, activity across establishments, and point adjustments. Filter performance views by duration, currency name, and program to isolate specific datasets. Compare establishment-level performance across two metrics such as point adjustments and member assistance. Track key performance metrics along with stacked modification type breakdowns. Analyze monthly performance trends of the selected metrics over time.
Member Services Manager Home in Tableau Next: Track the performance of your service representatives based on the number of members assisted, customer satisfaction scores, and modifications. Filter performance views by duration, currency name, and program to isolate specific datasets.
Member Summary in Tableau Next: Use the Member Summary tab to evaluate individual member loyalty engagement and financial activity. Assess member ranking using percentile baselines, track total revenue and transaction volumes over time, and compare monthly accrued versus redeemed reward points. Use the Service Summary tab to monitor service-driven point adjustments.
Program Manager with Member Services Home in Tableau Next: Evaluate member growth, loyalty program engagement, and point performance. Filter dashboard views by duration, currency name, and program to isolate specific datasets. Track new member acquisitions and examine tier breakdowns across membership levels. Analyze monthly activity trends by comparing overall transaction volume against active transacting members. Monitor key financial indicators, including total points balance to date, revenue, and accrued, redeemed, and expired point totals.
Promotion Performance Dashboard in Tableau Next: Evaluate promotional campaign effectiveness, user engagement, and financial liabilities. Filter performance views by program name, promotion name, and duration to isolate specific datasets. Access a tabular view to inspect detailed campaign metrics, including start and end dates, participant engagement, current liabilities, and promotion revenue.
Promotion Performance Left Embedded Dashboard in Tableau Next: Evaluate promotional product sales impact and engagement by tracking key performance metrics, including total revenue, transaction volume, member participation, and customer participation. Use the Product Leaderboard to compare individual products across revenue generated, transaction counts, and participant breakdowns.
Promotion Performance Right Embedded Dashboard in Tableau Next: Track a promotion’s performance, duration, and financial liability. Toggle views to analyze the performance by revenue, transaction, and order metrics. Monitor campaign duration and elapsed time across the promotion’s active dates.
Loyalty Tier Groups: Loyalty tier groups help you define tiers and the associated tier model for member recognition.
Loyalty Tiers: Tiers categorize loyalty program members based on their loyalty activities. As members engage more with the program, they’re recognized to higher tiers and get more exclusive benefits.
How to Set Up Actions and Trace Points: Define rules for crediting or debiting members' balances with currency subtypes, and track the associations for debit, credits, cancellations, and transfers.
Track Member Progress in Engagement Trails: You can reduce your data storage requirements by using the Promotion Party Usage object to track members' progress towards achieving milestones for Engagement Trail promotions. The Promotion Party Usage object uses fewer records to store attributes compared to engagement attributes. When you enable this setting, the attributes for Engagement Trail promotions are automatically stored in Promotion Party Usage records JSON format. You can use the Member Engagement Trail API to retrieve the record details.
Reduce Event Consumption with Efficient Transaction Journal Creation: Turn on the Transaction Journal Creation for Reward or Write Activities Only setting to create transaction journals only when transactions result in record updates or promotion rewards. This setting applies to real-time processing through the Transaction Journal Execution API when transaction details are provided in the payload. It doesn't impact batch processing, member functionality, or API requests that include a transaction journal ID in the payload.
Automatically Transfer Points to a Member Group: Automate the process of transferring points from members to their associated membership groups in real-time when points are credited to them. The automation calculates and transfers points to each group based on the member’s contribution percentage for each group. This automation ensures that there is no duplication in the transfer of points.
Transfer Member Points to Other Members: To ensure effective use of member points, members can transfer their redeemable points to other members of the loyalty program or to a group they are associated with. Service representatives can help transfer by using the Transfer Points action in a new or existing flow.
Unified Individual Segments: Use unified individual segments to create the most accurate, deduplicated view of your customers across all channels and data sources.
Unlink Partners by Using Loyalty Management: Unlinking a partner marks the linkage status as Inactive and stops the cross-program benefits. When you link the same partner back, the system considers it as new linkage and creates new records.
Validate Loyalty Ledger Traceability Records: Use the Validate Loyalty Traceability Ledgers Data Processing Engine template. It validates the Loyalty Ledger Traceability records for each active, fixed-duration, and redeemable currencies in the loyalty program. It calculates member balances and checks for redeemed expired points, mismatched debit and credit points, and overconsumed points.
Validate Loyalty Program Data Integrity After Import: After you import or migrate data to Loyalty Management, use Data Processing Engine definitions to data validation. Use the definitions to validate member point balances, and to validate loyalty ledger traceability records for active, redeemable currencies with a fixed-duration expiry model.
Validate Member Points Balances: Use the Validate Member Currency Balances for Loyalty Programs Data Processing Engine template. It checks whether the sum of the actual member and escrow balances matches the ledger and aggregated ledger totals. If the sum of the balances doesn’t match the totals, it creates error records in the Data Validation Errors analytics dataset.
Video Resources for Loyalty Management: Watch these videos to learn about the key capabilities of Loyalty Management and to learn how to use the capabilities.
Ways to Cancel Vouchers: There are scenarios where issued vouchers must be canceled. For example, vouchers that are issued after members place an order must be revoked if members cancel or return their order. In other scenarios, duplicate vouchers or incorrectly issued vouchers must be canceled.
Add Your Company’s Voucher Definitions: Voucher definitions are templates that are used to issue vouchers. You set up a voucher definition one time and then use the voucher definition to issue vouchers on demand or by configuring flows and loyalty program rules. Based on your requirements, createas many voucher definitions as needed and use each of them for different purposes.
Developer Resources for Vouchers: Developers can manage and integrate vouchers with external systems such as point of sales (POS) and order management systems. Learn about the API resources that are available to developers to manage vouchers across their lifecycle.
Automated Voucher Expiration: The status of unredeemed or partially redeemed vouchers changes to Expired after the vouchers pass the expiration date. Loyalty Management automatically changes the status of up to 2 million vouchers to Expired hourly.
Vouchers: Vouchers are offered to customers and loyalty program members as rewards for engaging with the brand and as compensation for service recovery actions. Your company and its loyalty programs can offer different types of vouchers based on your business requirements. You can also choose from a range of different options for how vouchers are issued to customers and members.
Issue Vouchers as a Reward: There are various ways in which you can issue vouchers as a reward to customers and members of your loyalty program. For example, vouchers are issued to customers and loyalty program members for completing a purchase or an experiential activity. Either loyalty program managers or admins can set up automated processes that check for a customer's or a loyalty program member's eligibility for a voucher and issue it to them. Vouchers can also be issued to contacts, accounts, and loyalty program members as a promotion reward.
Issue Vouchers for Externally Managed Processes with Process Template: If vouchers have to be issued to loyalty program members for business processes that are managed outside Salesforce, program managers can use the Issue Voucher process template. After program managers activate a process that's created using the template, system integrators can integrate the process with external systems via a business API. For example, the business API can be integrated with an external order management system and the process can be run every time an order is delayed.
Issue Vouchers for Eligible Customer and Member Activities with Flow Builder: Your company can issue vouchers to contacts, person accounts, and loyalty program members as part of automated business flows that the admin has already set up for your company. For example, the Issue Voucher action can be added to a flow that processes customer orders or to a flow that creates transaction journals for activities completed by loyalty program members. The flows can be configured to verify whether customers or members are eligible for a voucher and then use the Issue Voucher action to issue the voucher that’s relevant to them.
Issue Vouchers as Promotion Reward with Quick Promotion Guided Setup: Vouchers are a common reward option for pricing and loyalty promotions. In the Quick Promotion guided setup to create a promotion, marketing managers and loyalty program managers choose the voucher definition to issue vouchers. For example, a marketing manager can set up a promotion to issue customers a 10% discount voucher whenever customers buy Level X shoes. Or loyalty program managers can create a promotion that issues vouchers to members when they shop for US $50 or more during their birthday week.
Issue Vouchers for Transactions and Promotions with Promotion Setup: A loyalty program can issue vouchers to its members for completing activities that are eligible for a reward. For example, members can be issued a voucher for shopping on their membership anniversary or for posting about your company on their social media handles. When setting up a loyalty program rule, program managers can use the Issue Voucher action to automate the process of issuing vouchers to members whenever they meet the eligibility conditions for a voucher.
Offer Vouchers as a Service Recovery Action: Vouchers are a great way to gratify customers who have had a negative experience while engaging with your company or the loyalty program. When interacting with members or while working on a member's case, service reps can issue vouchers to members. In case members don’t receive their eligible vouchers, service reps, and loyalty program managers can issue the vouchers to the impacted members.
Ways to Reserve and Redeem Vouchers: On most commerce and shopping sites, members redeem vouchers either when adding products to the cart or when checking out a cart during payment. Often, customers abandon their carts or their orders aren't successfully placed. In these scenarios, you can lock the vouchers that customers want to redeem until customers have successfully placed their order. In retail scenarios, vouchers can be reserved until orders are fulfilled or until the order return period is over.
Automated Management of Vouchers Issued for Transactions: Loyalty program members are issued vouchers when they complete a purchase or nonpurchase activities. For purchase-related activities, there are scenarios where members aren't eligible to redeem an already issued voucher. For example, members aren't eligible to use a voucher that was issued for an order that is canceled. Loyalty Management automatically takes care of changing the status of vouchers status based on the status of their related transaction journals.
Ways to View Issued Vouchers: Customer and loyalty program members often reach out to customer support to learn about the vouchers that are available to them. Program managers also want to understand how issued vouchers are being used and are performing.
Loyalty Management: Loyalty Management, built on the Salesforce platform, helps organizations deliver innovative programs for customer recognition, reward, and retention. Loyalty Management is a unified, cross-industry solution that offers a host of features that enable you to plan and design loyalty programs, manage members, and partners. You can also track members’ activities, reward members, and manage promotions.
Actions: Configure actions by using flows, OmniScripts, or quick actions so that your customer service representatives can use Action Launcher to quickly find and run service actions, such as issuing a voucher, and changing member’s tiers, and resolve queries.
Alerts: Show alerts on the Loyalty Program Member page so that your customer service representatives, loyalty program admins, and the program managers can stay on top of changes related to your loyalty program members. For example, show alerts on a member's expiring points or vouchers so that the members can take immediate action and avoid issues. You can also alert customer service representatives. You can create alerts manually or automatically.
Cases: Create cases for loyalty program members and associate the cases with the respective loyalty program member records. Manage cases in the service console for loyalty program members.
Identity Verification: Customer service representatives verify the identity of loyalty program members or authorized member representatives by using the prebuilt Verify Customer Identity or the Verify Identity of Loyalty Program Member flows. The Verify Identity of Loyalty Program Member flow is a customized flow that’s provided by Loyalty Management. You can also create custom flows in Flow Builder by using the Verify Customer Identity Flow template.
Loyalty Member Lifecycle: Use the Loyalty Membership Lifecycle component to track a member’s change of status. You can track changes, such as the duration of a purchased subscription and the status of the subscription. If your loyalty program has paid tiers, then you can track the duration for which members are required to be part of the paid tier.
Loyalty Member Timeline: Timeline provides a comprehensive, chronological, and interactive view of member-related activities in one place. For example, when a member calls in about their points balance, the customer service representative can create an engagement interaction that gets included in the Timeline, making the interaction viewable for other service representatives.
Member Activity Details: Show relevant details of loyalty program members’ activity in your service console so that your customer service representatives (CSRs) can quickly view the details and assist members efficiently. You can show four tabs out of the seven options in any order: Overview, Transactions, Promotions, Vouchers, Benefits, Badges, and Associated Groups.
Member Profile Card: Customer service representatives can view a loyalty program member’s basic information in the Member Profile card. A member is an individual represented by a contact in your organization.
Manage Design Registration: Streamline multi-partner design registrations by capturing submissions, managing approvals at line-item level, and ensuring accurate partner tracking. Enhance transparency, improve resource allocation, and safeguard partner interests, ultimately driving revenue growth and effective collaboration across your channel ecosystem.
Manage and View Transaction Journals: View transaction journals to track member activities, member behaviors, and make manual adjustments to points. Transactions happen when members accrue points, redeem points, adjust points manually, and reverse redemptions.
Manage the Start URL for External Client Apps: A start URL defines the page where users end up when they run an external client app. The admin of an external client app sets an OAuth-specific start URL or a custom start URL from the Policies tab of the External Client App Manager.
Manage External Client App OAuth Usage: The External Client Apps OAuth Usage page displays information about external client apps for the current org, all users for a specific external client app, and all tokens for a specific user. These apps have an active access or refresh token. From this page, you can revoke a specific token, all tokens for a user of a specific external client app, or all tokens of a specific external client app.
Manage External Client Apps: After creating an external client app and configuring its distribution state, define its specific characteristics.
Manage How Customer Data Is Retained: Under data privacy law, your customers have a right to be forgotten from your org or for data to be restricted from processing. This means that you must delete, archive, or de-identify the data subject’s PII in your org within 30 days of their request. Always work with your legal team to ensure that you collaborate on policy creations and meet requirements set by your company. With Privacy Center, you can obfuscate a customer's PII, move it to storage, or delete it.
Manage Loyalty Program Members: You can manage and view the program details of members, the tier that members belong to, the program currencies that members hold, member transactions, and benefits.
Manage Partner Points for Prepaid Billing (Example): This example shows how loyalty program managers create a loyalty program partner with prepaid billing and how admins set up a process to manage partner points.
Configurations: Use these configurations to manage vaccine communications with Marketing Cloud Engagement.
Design Considerations: Keep these design considerations in mind when you manage vaccine communications with Marketing Cloud Engagement.
Workflow: Learn how data flows through the configurations when you manage vaccine communications with Marketing Cloud Engagement.
Managing Your Pro Suite Compliance: If you’re using Pro Suite, you’re responsible for your Health Insurance Portability and Accountability Act (HIPAA) compliance. Manage your compliance by enabling only HIPAA-ready Salesforce services and features and disabling those that aren’t covered by the Business Associate Addendum (BAA).
Market with Partner Cloud: Use market development funds, ready-to-use campaigns, co-branded emails, and Campaign Analytics to reach customers and grow your business.
Mask or Delete Records on an Object: Define how an object’s records are masked or deleted from your org, and determine how related files and attachments are handled.
Member Badges: Assign badges to members based on members’ interaction with your loyalty program. You can assign badges to recognize member milestones or other specific activities.
Assign Badges to Members: Use actions in loyalty program process rules to assign badges to members and to check whether a badge is assigned to a member.
Create Loyalty Program Badges: Create Loyalty Program Badge records to define badges to assign to members based on your company’s requirements. For example, you can create badges for each of the tiers in your loyalty program or to recognize the top contributors on the program’s community.
Member Badge Workflow: Before you start creating badges for your loyalty program and assigning the badges to members, learn the complete workflow to create, assign, and track member badges.
Member Enrollment Bonus: To increase the engagement with the loyalty program, you can define an enrollment bonus for all the members who join the loyalty program of your organization. You can also reward points to members for referring members to your organization. The work flow for enrollment bonus is defined using Flows.
View Promotions Categorized by Member’s Eligibility: Loyalty program managers and customer service reps can use the Promotion Eligibility component on Loyalty Program Member records to view members’ eligibility for promotions. The component categorizes promotions that members are enrolled in, are eligible for but not enrolled in, and are ineligible for. The component also provides users access to list views that users can use to enroll members in eligible promotions.
Show the Promotion Eligibility Component on Contact and Account Records: The Promotion Eligibility component is embedded in the Loyalty Member Profile component that can be added on Contact and Account records. Admins can turn on the visibility of the Promotion Eligibility component within the Loyalty Member Profile component. By using the component, customer service reps can view a member’s promotion eligibility on Contact and Account records and avoid navigating to the member’s Loyalty Program Member record.
Member Referral Code: Members can use referral codes to invite their friends and family to join the loyalty program. When a member joins the loyalty program, you can automatically generate a referral code for the member or specify a referral code for the member when they join the loyalty program.
Referral Codes Generation for Members: Generate referral codes for existing members who don’t have a referral code or regenerate referral codes based on your requirements.
Referral Codes Generation Using Flow: The Generate Member Referral Code flow action allows admins to set up a process to generate referral codes for members. Admins can set up a one-time process to generate referral codes for members who don’t have a referral code. Or, set up a process to regenerate referral codes either based on a customer request or based on the program’s requirements.
Add Referral Code during Member Enrollment: When a customer joins your loyalty program, you can allow the member to specify a referral code or allow Loyalty Management to automatically generate a referral code for the member.
Membership Change Tracking: Create Loyalty Membership Lifecycle records to track membership change events. For example, you can track the duration and the validity of subscriptions or tiers that members have purchased.
Merge and Unmerge Memberships: You can merge the memberships of two active loyalty program memberships. For example, you can merge duplicate memberships that are created by mistake or two or more memberships of an existing member. If two memberships are merged by mistake or if a member wants to separate their merged memberships, you can unmerge the memberships.
Points to Consider Before Merging or Unmerging Memberships: Loyalty Program Member records can be merged and unmerged only when the records match a set of predefined conditions. Review the conditions before you use actions in Flow Builder to automate membership merging and unmerging.
Set Up a Quick Action to Merge Memberships By Using a Template Flow: The Merge Loyalty Program Membership screen flow automates the process of merging memberships and assigning eligible benefits to the target membership. To enable customer service representatives to merge memberships easily, add the flow to Loyalty Program Member records as a quick action.
Merge Memberships: Use the Merge Loyalty Program Memberships action in Flow Builder to merge a source membership and a target membership. After the merge is completed, the status of the source membership changes to Merged while the status of the target membership remains active.
Unmerge Memberships: Use the Unmerge Loyalty Program Memberships action in Flow Builder to unmerge a loyalty program membership. The action unmerges memberships that are in the Merged status from the membership that it was previously merged with. After a membership is unmerged, the membership is returned the tier, points, and vouchers, transaction journals, and ledgers that belonged to the membership before the merge.
Configure an External Client App for OAuth 2.0 Client Credentials Flow: Use the OAuth 2.0 client credentials flow to share information between two applications without any input from a user. In this flow, the client app exchanges its client credentials defined in the external client app—its consumer key and consumer secret—for an access token. This flow requires you to specify an integration user to run the integration.
Configure an OAuth 2.0 Device Flow for External Client Apps: Configure the Global OAuth Settings to include a device code, and enable the OAuth 2.0 device flow. OAuth 2.0 device flows integrate apps that run on devices with limited input or display capabilities, such as smart TVs, appliances, and other internet of things (IoT) devices. Command-line apps can also use this flow. Users can connect these apps to Salesforce by accessing a browser on a device with more advanced input capabilities, such as a desktop or mobile device.
Configure External Client App Policies: Salesforce admins can set the policies that control the external client app. All changes are made through the metadata API.
Configure OAuth 2.0 JWT Bearer Flow for External Client Apps: External client apps can support OAuth 2.0 JSON Web Token (JWT) bearer flows using the certificate field in the global OAuth settings file. A JWT flow authorizes servers to access data without interactively logging in each time the servers exchange information.
Configure Packageable External Client Apps: External client apps are an excellent solution when created and used locally. However, they were designed with managed packaging in mind. Packaged apps can be deployed to other orgs. Determine whether to package your app or keep it local. Packaged apps that include an OAuth plugin can be deployed to generate their own unique OAuth settings or they can reference the settings of the org where the app was developed.
Custom Attributes for External Client Apps: Use custom attributes to configure unique settings for an external client app. Create new attributes in the settings file, and they show up as developer defaults in the policies file when the app is deployed.
Enable or Disable External Client App Plugins: Salesforce admins can disable an external client app or its plugins on their external client apps. All changes are made through the configurable policies file in the metadata API.
OAuth Plugin Enablement with Metadata API: In an external client app, the package.xml manifest file references the settings and policies files for each plugin. To enable external client app plugins, configure the settings files and reference the plugin in the manifest file.
External Client App OAuth Policies Configuration: The OAuth policies file is an important part of the external client app OAuth plugin that is generated with default values during deployment. Admins for the subscriber org configure the OAuth policies file for their specific use case.
External Client App OAuth Usage: Get External Client App OAuth usage information and revoke tokens through the Connect REST API. The Connect API returns information about the external client apps that users in your org are connecting to, a list of all OAuth users for an app, or the tokens for a given app and user. If you want to revoke access to an external client app, use the Connect API usage resources to revoke a specific token, all tokens associated with an app, or the tokens associated with a specific user.
Integrate a SAML SSO Service Provider as an External Client App: To use Salesforce as a SAML single sign-on (SSO) identity provider for a third-party service provider, integrate your service provider by using the external client apps framework. Create a SAML-enabled external client app and specify configuration information from your service provider. You can configure a SAML-enabled external client app via Metadata API only. External client apps with SAML configurations can’t be packaged or distributed.
External Client Apps Creation with Metadata API: Developers can create external client apps in Salesforce Setup or programmatically using Metadata API. After downloading an external client app, admins can configure Policies specific to the needs of their org.
OAuth Client Credentials Rotation for External Client Apps: One way to maintain the security of your external client apps is to change the OAuth consumer key or secret. Use Connect API to stage, rotate, and delete OAuth credentials.
Resolve MFA Access Issues for Your Users (Salesforce Orgs): As a Salesforce admin, part of your role is managing and maintaining user access. With multi-factor authentication (MFA) in effect for your org, it’s important to know how to resolve MFA-related access issues that users can encounter. There are three likely scenarios. A user doesn’t have access to their MFA verification method and can’t log in. A user loses or replaces a verification method and must register a new one. And the connection between a user’s registered verification method and their Salesforce account stops working. Use temporary verification codes to allow users to regain access immediately. When dealing with a broken connection or a missing verification method, revoke the connection and help the user set up a new method.
Complete MFA Challenges for Automation Users: Salesforce requires multi-factor authentication (MFA) for all UI logins, including logins from automation users. For automation use cases such as Robotic Process Automation (RPA), you can programmatically complete MFA using third-party authenticator apps that generate time-based one-time passwords (TOTPs).
Configure the MFA Verification Methods Available to Your Users for Salesforce Orgs: Salesforce supports four identity verification methods for multi-factor authentication (MFA) and device activation: built-in authenticators, physical security keys, Salesforce Authenticator, and third-party authenticator apps. As a security best practice, require users to use phishing-resistant methods: built-in authenticators or security keys. In orgs created before Summer ’25, Salesforce Authenticator and third-party apps are automatically available to users, but a Salesforce admin must enable the options to use passkeys (built-in authenticators and physical security keys). In orgs created in Summer ’25 and later, all verification methods are allowed by default. For external users only, you can allow the use of one-time passcodes delivered via SMS text messages.
Enable MFA for External Experience Cloud Site Users (or Specific Internal Users): Salesforce doesn’t require multi-factor authentication (MFA) for external users but you can certainly include this class of users in your MFA implementation. To enable MFA for external users who log in directly to your company’s Experience Cloud sites, employee communities, or other types of community portals, apply the Multi-Factor Authentication for User Interface Logins user permission. You can also use the MFA user permission to enable MFA for specific internal users. When MFA is turned on, users logging in directly with their username and password must also provide an identity verification method such as an authenticator app or security key.
MFA for Direct Salesforce Logins: Salesforce requires MFA for all internal users who access production orgs and sandboxes. Salesforce provides MFA functionality with several supported verification methods: passkeys (built-in authenticators and security keys), Salesforce Authenticator, and third-party authenticator apps such as Google Authenticator. For most users, you can control which verification methods are available. For internal users with privileged access, passkeys are the only supported method that satisfies the phishing-resistant MFA requirement.
Determine Business and User Needs for MFA: Even though multi-factor authentication (MFA) is required to access production orgs and sandboxes, we recommend that you look for ways to optimize the experience for your users. If your company accesses Salesforce via single sign-on (SSO), understanding your business and user needs gives you insights to help define your MFA implementation. To help determine the most suitable MFA verification methods for your users, review potential requirements and important considerations.
Multi-Factor Authentication (MFA) for Single Sign-On (SSO): With single sign-on (SSO), users log in to Salesforce from another site, like Google (the SSO provider). To secure these logins, Salesforce requires users to prove their identity with multi-factor authentication (MFA). You can satisfy MFA requirements by using your SSO provider's MFA service, provided that your SSO provider sends the right authentication signals to Salesforce. Alternatively, you can use the MFA functionality provided by Salesforce.
Multi-Factor Authentication Glossary: Familiarize yourself with common terminology related to multi-factor authentication (MFA) and the contractual MFA requirement.
Learn What MFA Is and Why It's So Important: As security threats grow more common, it's increasingly important to implement strong measures to protect your Salesforce data, your business, and ultimately, your customers. Usernames and passwords alone are no longer sufficient for guarding against unauthorized account access. Multi-factor authentication (MFA) is one of the simplest, most effective ways to enhance the security of your login process because it requires multiple pieces of evidence to prove a user is who they say they are. Salesforce requires MFA for all internal users, such as employees, who access your Salesforce org. Users with privileged access to Salesforce, such as admins, are required to use phishing-resistant verification methods to complete MFA.
Monitor Salesforce Logins with the Lightning Usage App: Use the Login Metrics tab in the Lightning Usage App to monitor logins in your org. See how many users are logging in with your org’s various identity services, including multi-factor authentication (MFA) and single sign-on (SSO).
Monitor MFA Usage in Your Salesforce Org: Monitor multi-factor authentication (MFA) usage patterns and metrics to get a good understanding of your users’ experiences. There are several tools for monitoring and reporting on MFA usage patterns in your org. Options include the Lightning Usage App, MFA list views and the Identity Verification Methods report, and an MFA dashboard from Salesforce Labs.
Experience Cloud Passkey Prompts: When an internal user accesses an Experience Cloud site, multi-factor authentication (MFA) is always required. Salesforce doesn't require MFA for external users to access Experience Cloud sites, but you can choose to enable it. Both internal and external users can see prompts to set up a passkey when they log in to an Experience Cloud site, but the prompts are slightly different.
Set Up Passkeys for Partner Admin Shared Logins: To set up passkeys across devices for Partner Admin Shared Logins, use a synced passkey stored in a password manager. All Partner Admins can use the synced passkey when they’re logged in to the password manager on their devices.
Troubleshoot Issues with Passkey Prompts and Single Sign-On: A user logs in through a single sign-on (SSO) identity provider, such as Okta or Microsoft Entra ID, and completes multi-factor authentication. Before the user can access Salesforce, another prompt asks them to create a passkey. Troubleshoot the authentication signals that cause this issue. This guide includes troubleshooting steps for both Security Assertion Markup Language (SAML) and OpenID Connect.
Passkeys for MFA: Multi-factor authentication (MFA) verification is easy with a passkey (formerly known as built-in authenticator) service such as Windows Hello, Touch ID or Face ID, or a password manager. Users can quickly verify their identity with a fingerprint, iris, or facial recognition scan (or in some cases, with a PIN or password that the user sets up in their device's operating system). Passkeys provide secure, fast, easy login. They satisfy the phishing-resistant MFA requirement for privileged users.
Manage Passkeys and Security Keys: Manage passkeys, including security keys, that you use to log in with multi-factor authentication (MFA). View your registered passkeys, create passkeys, and disconnect existing passkeys that you no longer use. Passkeys are also known as built-in authenticators.
Recognize Passkey Creation Prompt Behavior: Users see prompts to create a passkey in several situations, including after a sandbox refresh. The “Waive Multi-Factor Authentication for Exempt Users” permission applies only to customers with an active temporary extension for multi-factor authentication (MFA) enforcement.
Phishing-Resistant MFA Requirement for Privileged Users: Salesforce requires multi-factor authentication (MFA) for all employee logins to Salesforce products. For internal user accounts that have a higher level of access, such as admin accounts, Salesforce requires extra security: users must complete MFA using a phishing-resistant method, such as a passkey or security key. This requirement applies to direct and single sign-on (SSO) logins for active production and sandbox orgs.
Prepare Your Users for MFA: Most people these days are familiar with some form of multi-factor authentication (MFA). But don't assume your users are going to intuitively appreciate the value of MFA, or feel comfortable completing MFA registration when they log in, without some advance awareness and preparation. Whether you're launching a new production org where MFA is on by default, turning on MFA in an org that didn't previously use it, or adding MFA to your single sign-on (SSO) process, ensure that your users are trained for MFA ahead of time. A simple change management plan goes a long way in delivering a smooth onboarding experience.
Refine the MFA User Experience for Salesforce Orgs: Plan periodic reviews of your multi-factor authentication (MFA) implementation to verify it’s meeting your users’ needs. Consider enhancing the MFA user experience by enabling Lightning Login.
Register for Multi-Factor Authentication (or Get a Little More Time If You Need It): To protect your account against cyberthreats, logins now require multi-factor authentication (MFA) in addition to your username and password. To finish logging in, register a verification method that proves your identity. Not ready for MFA? You can skip it during a small grace period. After that, MFA is required for every login unless a Salesforce admin turns it off temporarily.
Register for Multi-Factor Authentication (or Get a Little More Time If You Need It): To protect your account against cyberthreats, logins now require multi-factor authentication (MFA) in addition to your username and password. To finish logging in, register a verification method that proves your identity. A Salesforce admin can temporarily disable MFA if users need more time to get ready.
MFA Verification Method Tiers: The multi-factor authentication (MFA) login process requires users to provide an identity verification method in addition to their username and password. Salesforce supports several types of verification methods, including passkeys (built-in authenticators and security keys) and authenticator apps. Some verification methods are stronger than others. Salesforce requires users with privileged permissions, such as admins, to use more secure methods.
Use Salesforce MFA for SSO (Salesforce Orgs): To help prevent unauthorized access to your account, Salesforce requires multi-factor authentication (MFA) when users log in via single sign-on (SSO). You can use the MFA service included in the Salesforce platform to satisfy this requirement. With this approach, when users log in to Salesforce, they're prompted to provide an MFA verification method to confirm their identity.
MFA with an SSO Identity Provider: With single sign-on (SSO), users log in to Salesforce from another site, like Google (the SSO identity provider). To help prevent unauthorized access to Salesforce accounts, you're required to use multi-factor authentication (MFA) when logging in via SSO. You can set up an SSO flow where users log in to the identity provider and complete MFA before they're redirected to Salesforce. To use this option, Salesforce requires your identity provider to send specific authentication signals that indicate the MFA method.
Set Up MFA with an SSO Identity Provider: With single sign-on (SSO), users log in to Salesforce from another site, like Google (the SSO identity provider). Salesforce requires multi-factor authentication (MFA) when logging in via SSO. Here's how you can use your SSO identity provider's MFA service to satisfy the requirement. With this SSO flow, users log in to the identity provider and complete MFA before they're redirected to Salesforce.
Support Your Multi-Factor Authentication Implementation for Salesforce Orgs: After multi-factor authentication (MFA) is enabled, it introduces some new admin responsibilities to support users and maintain operations. Common tasks involve helping users solve verification method or authentication issues, including account lockouts. It’s also valuable to monitor MFA usage patterns over time for insights such as the most and least used verification methods, or recurring login problems. And consider MFA optimizations that can improve the user experience. Need help? You can assign MFA management permissions to trusted users.
Products That Support MFA: All products that are built on the Salesforce Platform provide multi-factor authentication (MFA) functionality at no additional cost. If you aren’t sure, use this topic to verify that your product is built on the Salesforce Platform.
MFA Verification Methods for Direct Salesforce Login: The multi-factor authentication (MFA) login process requires users to provide an identity verification method in addition to their username and password. Salesforce MFA functionality supports several types of verification methods, including passkeys (built-in authenticators and security keys) and authenticator apps. You can control which methods are available to your users.
Troubleshoot Passkey Issues: When employee users log in and register for multi-factor authentication (MFA), passkeys are the default option. Identify and resolve issues with passkey prompts, setup, login, and more.
Security Keys (Passkeys) for MFA: Security keys are physical passkeys. They're small, USB or NFC devices that are easy to use for multi-factor authentication (MFA) logins because there's nothing to install and no codes to enter. This type of method is a great option if users don't have a mobile device or if phones aren't allowed where your users work (such as a PCI-compliant service center). Security keys require a supported browser to act as an intermediary between the key and your Salesforce product. Popular security keys include the YubiKey from Yubico and the Titan Security Key from Google. Security keys satisfy the phishing-resistant MFA requirement for privileged users.
Salesforce Authenticator for MFA: The Salesforce Authenticator mobile app is a verification method that can be used as a second factor for multi-factor authentication (MFA) logins. The app is free and simple to use.
Third-Party Authenticator Apps for MFA: Salesforce multi-factor authentication (MFA) supports the use of third-party authenticator apps that generate time-based one-time password (TOTP) codes. There are many mobile, desktop, and browser extension apps available, including free versions. Some popular options include Google Authenticator, Microsoft Authenticator, Authy, and password managers such as LastPass and 1Password. Third-party authenticator apps are considered standard-strength verification methods, so they can satisfy the MFA requirement for non-privileged users.
Test Your MFA Implementation for Salesforce Orgs: If you test MFA ahead of time, you gain experience with the MFA registration process and can assist users with login issues. Even if Salesforce automatically enabled MFA for your existing org, it’s beneficial to evaluate how things work in a test environment.
Understand MFA Requirements: To protect users from security threats such as phishing, credential stuffing, and account takeovers, Salesforce requires multi-factor authentication (MFA) for all employee logins to Salesforce products. Understand MFA requirements based on the type of org, the type of user, and the user's level of access.
Resolve Issues with Passkeys Across Devices: Each passkey is either device-bound or available for cross-device use. If you have a device-bound passkey and use multiple devices to log in, you have two options. Disconnect the passkey and set up a cross-device passkey, or set up a separate device-bound passkey on each device.
Multi-Framework Insights (Beta): Use Multi-Framework Insights (Beta) to measure and improve the performance of your most-used Multi-Framework apps. The dashboard identifies up to ten apps with the highest total page views over the last seven days. You can drill down into each app to see more detailed analytics and visualizations.
Migrate a Local Connected App to an External Client App: Use the automated process to create a local external client app that replaces your existing local connected app. After migration, the old connected app remains as a read-only version in App Manager. External client apps created through migration are secure.
Frequently Asked Questions: Have questions? We’ve compiled answers to frequently asked questions about Essentials retirement and upgrade to Pro Suite.
Essentials Migration Guide: Salesforce is retiring our Essentials edition to help our small and medium-sized businesses get more value from our products. Before the retirement date, you can upgrade to Pro Suite edition and keep your current pricing (for as long as you continue your Salesforce subscription). You’ll gain access to advanced features and customization tools that will help you accelerate growth and deepen customer relationships.
Migrating to Pro Suite: Before you can use Pro Suite, you must consent to the upgrade, turn on Pro Suite settings, and enable Marketing and Commerce.
Benefits of Pro Suite: Take advantage of Pro Suite’s advanced features, such as Agentforce, Slack integration, enhanced customizations and automation, Quick Settings, Forecasting, and more!
The Migration Timeline: Please review these critical milestones and dates related to Essentials end of life and migration to Pro Suite.
What to Expect: We know that changing Salesforce editions can feel like a significant shift, but we’ve designed this guide to walk you through every step of the process—from initial consent to a successful launch—so you can transition with confidence and start taking advantage of the advanced features waiting for you on the other side.
Add a Data Source to a Screen: Define the records you want available on a screen, including the object, filters, sort order, and how many records to retrieve.
Analyze App Data: Use the Analyze tab to track adoption and app health after publication.
Available add-ons: Each add-on defines its valid entry points and user device permissions.
Bind a Component to a Field: Connect a single component, such as a text component, to a field from a data source so that it shows one field value.
Bind Components to Data: Connect your app's components to live Salesforce data in two phases. First add a data source to a screen, then bind components to the fields in that source.
Bind a Dynamic Component to Repeat Across Records: Use a dynamic component, such as a list, row, or carousel, to repeat its content across every record in a data source instead of showing only the first record.
Build Your App's Skeleton: Describe an app in plain language and Agentforce creates the first version.
Set Up Your Android App: Provide the Google Play account details and app icon required for binary distribution.
Set Up Your iOS App: Provide the Apple account details and app icon required for binary distribution.
Work with Screens: Use the screens panel to manage screens and their components.
Mobile SDK for Loyalty Management: Enhance brand engagement by providing Loyalty Management features on your iOS and Android mobile devices. Use the iOS and Android Mobile Software Development Kit (SDK) for Loyalty Management to build custom mobile applications with immersive member experiences. Elevate member experience and loyalty by providing personalized offers, rewards, and checkouts on mobile devices.
Mobile Application Security: Mobile application security addresses any concerns you may have when evaluating Salesforce mobile apps for your organization.
Permissions: Learn more about user and device permissions for the Salesforce mobile app.
Mobile Application Authentication: All components of Salesforce mobile applications require user authentication at the point and time of access.
Certificates and Keys: Salesforce certificates and key pairs are used for signatures that verify a request is coming from a customer org. They’re used for authenticated SSL communications with an external website, or when using a customer org as an Identity Provider.
Communication Security: The Salesforce mobile app always uses highest level of secure communications and encryption to safeguard your data.
Inactivity Lock: Upon initial activation, Salesforce prompts the user to create an arbitrary passcode (if required by the org admin). The passcode is used to unlock the app after reboot, or an admin defined period of inactivity (1, 5, 10, or 30 minutes).
Local Data Protection: The data stored locally on the device is saved in the device’s embedded memory and never on an external memory card.
Install the Salesforce Connected Apps (Optional): This step is required if your org is new and there are no connected apps installed yet. Alternatively, you can log into your org using the Salesforce mobile app to trigger an installation of the required connected apps.
Enable Enhanced Mobile App Security: Before you can configure mobile app security policies, there are a couple steps to get Enhanced Mobile App Security enabled.
What Your Users See: Users with the Enforce Enhanced Mobile App Security user permission see a dedicated user interface in the Salesforce mobile app.
Mobile Device Management (MDM): The Salesforce mobile app provides an extra level of security compliance through interoperation with the most popular MDM (mobile device management) suites.
Additional Security Enhancements: You can add an extra layer of security for your iOS users by clearing the contents of their clipboard whenever the mobile app is in the background.
Prerequisites for Android: There are prerequisites to implement enhanced security for the Salesforce mobile app for Android.
Certificate-Based Authentication: Using certificates to authenticate simplifies provisioning your mobile users, and your day-to-day mobile administration tasks by eliminating usernames and passwords.
Automatic Custom Host Provisioning: You can now push custom login host settings to your mobile users. This spares your mobile users from having to manually type long URLs for login hosts—typically a frustrating and error-prone activity.
Sample Property List and JSON Configurations: One method of setting key-value pair assignments is through an XML property list, or plist. The plist contains the key-value pair assignments that an MDM provider sends to a mobile app to enforce security configurations. Another method of setting key-value pair assignments is through JSON.
Best Practices and Troubleshooting: This information helps you implement best practices and troubleshoot when configuring mobile app security.
OAuth Pairing for Mobile Applications: Salesforce uses OAuth2.0 for mobile application authentication through username and password or SSO (single sign-on) credentials.
Identity Providers and Service Providers: An identity provider is a trusted provider that enables a customer to use single sign-on to access other websites. A service provider is a website that hosts apps. Customers can enable Salesforce as an identity provider, then define one or more service providers, so their users can access other apps directly from Salesforce using single sign-on. This can be a great help to users: instead of having to remember many passwords, they only have to remember one.
Remote Wipe: An org admin can restrict access to minimize the risk of information loss when a mobile device is compromised.
Restrict Device Platforms: Admins can restrict Salesforce app access through the admin console by blocking the Salesforce Connected App for either platform (iOS or Android).
Session Cookie: Session cookie is only used for Visualforce pages.
Single Sign On (SSO) for Mobile Applications: Single sign-on is a process that allows network mobile application users to access all authorized network resources without having to log in separately to each resource.
Application Data Storage: A mobile device may be lost or stolen at any time. Since mobile devices are small and designed to be highly portable, they may not remain under the physical control of a trusted person. Therefore, Salesforce provides methods to secure the device data if it passes out of control of the user or the user’s organization.
Monitor App Security on the Insights Page: Use the Insights page to check whether your org's connected apps and external client apps comply with Salesforce's required OAuth and proof-of-possession controls. For apps that you develop, turn on the missing controls to come into compliance with Salesforce requirements. For apps developed elsewhere, contact the app developer and consider disabling the app until the developer updates the security controls. These controls are critical to protecting your org and data from known cyber threats.
Monitor Your Organization: Salesforce provides a variety of ways to keep tabs on org activity so that you can make sure you're moving in the right direction.
Monitor Bulk Data Load Jobs: Process a set of records by creating a job that contains data that will be processed asynchronously. The job specifies which object is being processed and what type of operation is being used.
View Bulk Data Load Job Details: When you create update, or delete a large volume of records with the Bulk API or Bulk API 2.0, each job has a Job Detail page where you can monitor the progress of the job.
Manage Bulk Data Load Jobs: You can create update, or delete a large volume of records with the Bulk API, which is optimized for processing large sets of data. It makes it simple to load, update, or delete data from a few thousand to millions of records.
Monitor Background Jobs: You can monitor background jobs in your organization, such as when parallel sharing recalculation is running.
Monitor Training History: As an administrator, you want to know that your team is learning how to use Salesforce effectively. The Training Class History shows you all of the Salesforce training classes your users have taken.
Learn About an Event: Find detailed information about an event that has affected or is scheduled to affect one of your Salesforce tenants. Possible events include incidents, maintenance/releases, and patch releases.
Review Ongoing and Upcoming Maintenance: Learn about the ongoing events affecting your products and services and the maintenance scheduled for them in the next 90 days.
Salesforce My Trust Center: Use the Salesforce My Trust Center site to find crucial updates and communications about the availability of your Salesforce products, services, and tenants.
Learn About an Upcoming Patch Release: See the bug fixes and minor enhancements planned for an upcoming patch release. If the fixes and enhancements are related to customer cases or known issues, view the patch’s release notes when they’re available.
Subscribe to Salesforce My Trust Center Messages and Notifications: You can subscribe to My Trust Center informational messages and notifications. For general announcements about cross-cloud Salesforce products or services, and external issues affecting your ability to access your Salesforce products or services, subscribe to My Trust Center informational messages. To get notified when an incident, maintenance/release, or patch release affects your Salesforce tenant, subscribe to My Trust Center notifications.
View a Tenant's Events: View all past, current, and scheduled events impacting one of your Salesforce tenants. Possible events include but aren’t limited to incidents, maintenance/releases, patch releases.
View Your Tenants: See all tenants associated with your Trailblazer account.
Give Users Visibility into Salesforce My Trust Center Without a Full License: To give users view-only access to a tenant in Salesforce My Trust Center without a full license, assign them the Unified Employee license. Users with this license can view Salesforce My Trust Center for the tenant but can't access Salesforce itself.
Named Credentials: Intended to secure and simplify authenticated API callouts to external systems, a named credential specifies the URL of a callout endpoint and its required authentication parameters in one definition. To streamline your Apex code and simplify the setup of authenticated callouts, specify a named credential as the callout endpoint.
Define a Legacy Named Credential: Create a legacy named credential to specify the URL of a callout endpoint and its required authentication parameters in one definition. You can then specify the legacy named credential as a callout endpoint to let Salesforce handle all authentication. You can also skip remote site settings, which are otherwise required for callouts to external sites, for the site defined in the legacy named credential.
Understand Legacy Named Credentials: A legacy named credential specifies the URL of a callout endpoint and its required authentication parameters in one definition. Legacy named credentials are deprecated and are unsupported in future releases.
Grant Access to Authentication Settings for Legacy Named Credentials: For legacy named credentials that use per-user authentication, grant access to users through permission sets and profiles. Doing so lets users set up and manage their own authentication settings for accessing the external system.
Authentication Protocols for Named Credentials: Your connections between Salesforce and external systems use an authentication protocol to confirm secure communication between the two systems. Choose the authentication protocol that matches the configuration of the external system that you connect to. When you do, keep the strengths and considerations of each authentication protocol in mind.
What are Named Credentials?: Using HTTP callouts with Apex, you can integrate Salesforce with external systems via SOAP and REST APIs. Named credentials offer a declarative and secure way to store and manage the credentials needed for HTTP callouts so that Salesforce can authenticate with external APIs.
Create or Edit an External Auth Identity Provider: If you plan to create named and external credentials that use OAuth2.0 authentication, first create an external auth identity provider. External auth identity providers obtain OAuth tokens for outbound callouts to external systems.
Create or Edit an External Credential: To use named credentials, you must first configure an external credential. The external credential represents the details of how Salesforce authenticates to an external system via an authentication protocol.
Create or Edit a JWT External Credential: To manage your authentication into the external system with a JSON Web Token (JWT), create an external credential that uses the JWT authentication protocol. The JWT authentication protocol supports server-to-server integration.
Create or Edit a Named Credential: Configure a named credential to specify the URL of a callout endpoint. To specify the required authentication parameters for the callout, connect the named credential to an external credential.
Create or Edit an OAuth External Credential with the Browser Flow: With an OAuth 2.0 external credential that uses the Browser Flow, one or more users logs into the remote system via a web browser to trigger a callback that includes access tokens. The returned tokens authenticate calls to the endpoint defined in the named credential.
Create or Edit an OAuth External Credential with the Client Credentials with Client Secret Flow: An OAuth 2.0 external credential that uses the Client Credentials with Client Secret Flow exchanges a client identifier and a client secret for an access token. The returned tokens authenticate calls to the endpoint defined in the named credential. Use the Client Credentials with Client Secret Flow when Salesforce is a client application of another external system that has its own login credentials. Instead of managing access to the external system on a per-user basis, you can set up service-level access for your Salesforce org.
Create or Edit an OAuth External Credential with the JWT Bearer Flow: An OAuth 2.0 external credential that uses the JWT Bearer Flow sends a JWT (JSON Web Token) to an authorization provider in exchange for a token. The returned tokens authenticate calls to the endpoint defined in the named credential.
Use Custom Headers with Credentials: Add custom headers to external credentials to cover more use cases and security requirements. With custom headers, you can set your own parameters for authentication.
Use Cases for Custom Headers with Named Credentials: Custom headers are most often used for security or authentication purposes. The HTTP standard includes a commonly used, dedicated Authorization header. However, many use cases require something else. Two common use cases are per-user callouts and API keys.
Use API Keys in Custom Headers with Named Credentials: Web services often define their own authentication protocols using custom headers. For those cases, you can create a custom header for a named or external credential and use API keys as a password.
Enable External Credential Principals: Principals link an external credential to permission sets or user profiles so that users can make callouts using the named credential. At run time, Salesforce ensures that the user has the permission set before accessing the remote system.
Named Credential Example Configurations: Explore scenarios for configuring named credentials to make callouts to various external systems. The examples cover the entire named credential configuration for different authentication protocols and principal types.
Named Credential Example: OAuth 2.0 Browser Flow with a Named Principal: In this example, configure a named credential with the OAuth 2.0 Browser Flow to make authenticated callouts to GitHub. This example uses the Named Principal identity type, meaning that a Salesforce admin authenticates to GitHub on behalf of all users in the org.
Get Started with Named Credentials: Understand the basics of named credentials, including the named credential schema and the authentication protocols that Salesforce supports.
Named Credentials Glossary: To better understand named credentials, get familiar with these common terms.
Create Named Credentials and External Credentials: To simplify the setup of authenticated callouts, create an external credential to specify an authentication protocol and then specify a named credential as the callout endpoint. Add custom headers to cover more use cases and security requirements. Use a permission set or profile to grant access so that users can make authenticated callouts. You can create and configure named credentials programmatically or through the Salesforce UI.
Named Credentials Schema: Named credentials and external credentials simplify and enable greater reuse of setup for secure and authenticated callouts.
Resources for Named Credentials: Learn about considerations, troubleshooting tips, and more so that named credentials work the way you intend.
Troubleshooting for Named Credentials: Review the potential causes and troubleshooting steps for common issues that you can encounter when you set up or use named credentials.
Understand the Authentication Status for External Credentials: The Authentication Status field tells you when you’ve completed all of the required steps to configure an external credential. If your external credential shows a Not Configured status, there’s more work to do before you can use your external credential to make authenticated callouts with a named credential. Learn how to reach a Configured status for each authentication protocol.
Enable User External Credentials: Tokens for named credential callouts are encrypted and stored in the User External Credential object. Any user performing an authenticated callout needs profile- or permission set-based access to user external credentials. Most standard permission sets and profiles have access to the User External Credentials object by default. For the guest user profile, and for some custom permission sets and profiles, you must assign User External Credentials object permissions manually.
Permission Concepts for User External Credentials: As a Salesforce admin, you must pay careful attention to security and permissions settings in your org. We recommend that you limit data access to the lowest level possible, while still allowing everyone to do their jobs. This strategy is known as the principle of least privilege. Whether you enable user external credentials via permission sets or profiles, follow this guidance to grant the appropriate access for each authentication protocol.
Note and Attachment Fields: There are a number of useful fields available for notes and attachments in Salesforce. There are different fields available for notes taken with Notes, our enhanced note-taking tool, and notes taken with the old note-taking tool.
Working with Omniscripts: Use the Omniscript Builder to create and manage guided, interactive processes. Retrieve, update, and add data to a variety of sources with elements for Data Mappers, Integration Procedures, REST APIs, and Apex. Or allow users to add or modify data with input fields. Drag Omnscript elements to the canvas and edit properties without changing tabs. Omniscript activation is instant.
Check for Ongoing Incidents or Maintenance: Check the current status of ongoing incidents or maintenance events from the Trust Status home page. The incidents and maintenance events on the home page are for all Salesforce instances and services.
Orchestration of Loyalty Processes: You can use batch jobs and data processing engine jobs that appear as invocable actions in the Flow and connect all the loyalty processes (Accrual, Redemption, Point Balance, Qualifying Point Reset, Point of Expiry) together. And you can schedule them to run at regular intervals.
Manage Org Responsibilities: The Org Responsibilities page in Setup lists your org's Security Contact, Primary Admin Contact, and, if applicable, Partner of Record. Salesforce uses this information for org- or account-level communications such as security notifications and product or success plan updates.
Integration Procedures on Agentforce: Integration Procedures in Omnistudio are powerful tools used to automate data integration and transfer between systems. They enable the creation of complex workflows, data transformations, and business logic execution, all within a single, unified environment. Agentforce is Salesforce’s agent-focused workspace, designed to streamline customer service operations by providing a centralized platform for case management, customer interaction, and system integration.
Access Actions in a Lightning Page with the Power Launcher Component (Managed Package): For the managed package runtime, access all the available Actions in a Lightning Page using the Power Launcher component's typeahead functionality. Enable Lightning Record Pages and Lightning App Pages to use the Power Launcher component by adding the Power Launcher Lightning Web Component to a Lightning Page.
Access Flexcard Data JSON with Merge Fields (Managed Package): For the managed package runtime, enable Flexcard element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. Merge field syntax requires you to wrap a full JSON path with a curly bracket on both ends, such as {FirstName}. For example, if a JSON node is "FirstName": "John", then the merge field {FirstName} returns John.
Access Integration Procedure Data JSON with Merge Fields (Managed Package): For the managed package runtime, enable Integration Procedure elements and element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. For example, if a JSON node is "FirstName": "John", then the merge field %FirstName% returns John.
Access Integration Procedure Data JSON with Merge Fields: Enable Integration Procedure elements and element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. For example, if a JSON node is "FirstName": "John", then the merge field %FirstName% returns John.
Access Omniscript Data JSON with Merge Fields (Managed Package): For the managed package runtime, enable Omniscript elements and element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. For example, if a JSON node is "FirstName": "John", then the merge field %FirstName% returns John.
Access Omniscript Data JSON with Merge Fields: Enable Omniscript elements and element properties to access data JSON using merge fields. A merge field is a variable that references the value of a JSON node. For example, if a JSON node is "FirstName": "John", then the merge field %FirstName% returns John.
Access Omnistudio Designer Components from the List View: View your Flexcards, Omniscripts, Integration Procedures, and Data Mappers on the list view pages, and open them in the standard designer. The list view page for the standard designer offers an enhanced user experience and better performance, when compared to the managed package designer.
Access the ContextId of a Flexcard on an Experience Site (Managed Package): For the managed package runtime, on an Experience site, to view record data on a Flexcard that uses the {recordId} context variable in an Input Map to pass a ContextId to an Apex Remote, Omnistudio Data Mapper, or Integration Procedure data source, you must add and configure a recordId property. Add the recordId property in your Flexcard's configuration file, then configure the property on the Experience page.
Access the ContextId of a Flexcard on an Experience Site: Most Flexcards use a ContextId, represented by the {recordId} context variable in an Input Map, to retrieve data from an Apex Remote, Omnistudio Data Mapper, or Integration Procedure data source. For a Flexcard to use the {recordId} context variable on an Experience site, you must add and configure a RecordId property. Add this property to your Flexcard's configuration, then configure the property on the Experience page.
Access the Data JSON (Managed Package): For the managed package runtime, use existing data JSON in an element property by indicating the use of a merge field.
Accessing the Context Id of an LWC Card on a Community Page (Managed Package): For the managed package runtime, on a Community page, to view record data on an LWC Card that uses the {{params.id}} context variable in an Input Map to pass a context Id to an Apex Remote, Omnistudio Data Mapper, or Integration Procedure data source, you must add and configure a recordId property. Add the recordId property in your LWC Card's configuration file, then configure the property on the Community page.
Action Block (Managed Package): For the managed package runtime, run multiple Omniscript Actions asynchronously by grouping them in an Action Block. Actions within the Action Block run in parallel and inherit the Action Block's settings.
Run Multiple Actions in an Action Block: Run multiple Omniscript Actions asynchronously by grouping them in an Action Block. Actions within the Action Block run in parallel and inherit the Action Block's settings.
Activate a Flexcard (Managed Package): For the managed package runtime, activate a Flexcard to generate an LWC and publish it to a Lightning page or Experience Builder site. After you activate a Flexcard, you can’t edit it or add elements to it.
Activate a Flexcard: Activate a Flexcard to generate an LWC and publish it to a Lightning page or Experience Builder site. Activating a Flexcard disables editing capabilities. You can’t add or edit elements on an active Flexcard.
Activate and Launch Omniscripts: Make Omniscripts available to Experience Sites, Lightning Pages, custom LWCs, and Lightning tabs by activating and launching the Omniscript. If an error occurs during deployment, the Omniscript is deactivated.
Activate the Story-SLDS Component (Managed Package): For the managed package runtime, to display a Customer Story on a Lightning or Community page, the story-slds component must be active. The story-slds component displays a timeline of all interactions with a customer in a single, chronological feed.
Activate and Publish a Flexcard: After you confirm that the Flexcard is ready, activate it. After activation, add the Flexcard to a Lightning page or to a page in an Experience Builder site.
Activating Omniscripts (Managed Package): For the managed package runtime, to activate a script for production deployment, edit the script and, in the Script Configuration section, click Activate Version.
Add a Business Event to the Example Card (Managed Package): For the managed package runtime, you can't define complex JSON structures in a Flexcard. However, you can specify key/value pairs in Setup in the Custom Fields section. After creating the tracking configuration and adding event types, you can use merge fields to add the values to a complex JSON structure.
Add a Chart to a Flexcard (Managed Package): For the managed package runtime, display data on a Flexcard as a chart with the Chart element. Select from bar, pie, donut, line, and radar chart types.
Add a Chart to a Flexcard: Display data on a Flexcard as a chart by using available types such as bar, pie, donut, and more. Configure settings such as the aspect ratio or dimensions to fit your company or institution’s style.
Add a Checkbox Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Checkbox input element on a Flexcard to enable users to select or unselect a checkbox. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Child Flexcard to Itself Recursively (Managed Package): For the managed package runtime, when a child Flexcard has hierarchical data, it can call itself recursively. When the Flexcard element is embedded in a child Flexcard, use the Is Recursive feature to display the children and grand-children of parent objects. The child Flexcard can add itself to itself again and again, each time passing the same child data field (also called a data node) available in each level of the data JSON, until that data field no longer exists or is empty.
Add a Currency Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Currency Input element on a Flexcard to enable users to enter a currency amount based on the locale and currency type you specify. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Custom Component SVG Icon to a Flexcard (Managed Package): For the managed package runtime, add an SVG resource as the custom icon for your generated LWC to easily identify it in the Lightning App Builder and the Experience Builder. Use the Publish Options feature on an activated Flexcard to update the default icon with a custom SVG resource.
Add a Custom Component SVG Icon to a Flexcard: Add an SVG resource as the custom icon for your generated LWC to easily identify it in the Lightning App Builder and the Experience Builder. Use the Publish Options feature on an activated Flexcard to update the default icon with a custom SVG resource.
Add a Customer Story to a Page as a Visualforce Component (Managed Package): For the managed package runtime, add a Customer Story to an Account, Contact, Household, or Opportunity page layout using a Visualforce component. Display a timeline of all interactions with a customer in a single, chronological feed.
Add a Customer Story to a Page with the Story-SLDS Component (Managed Package): For the managed package runtime, add a Customer Story to an Account, Contact, Household, or Opportunity page layout with the story-slds component. Display a timeline of all interactions with a customer in a single, chronological feed.
Show Data in a Table on a Flexcard: At times, a sortable table is most suited to represent your data. You can show data retrieved from a data source in a table on Flexcards. For example, show account cases as a sortable table.
Add a Date Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Date Input element on a Flexcard to enable users to select a formatted date from a calendar widget. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Date/Time Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Date/Time Input element on a Flexcard to enable users to select a formatted date from a calendar widget and a formatted time from a list of time intervals. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Field to a Flexcard (Managed Package): For the managed package runtime, display data fields returned from a data source on a Flexcard. For example, display Policy information for an Account.
Add a Display Field to a Flexcard: Display data fields returned from a data source on a Flexcard. For example, display Policy information for an Account.
Add a File or Image to Omniscript (Managed Package): For the managed package runtime, add and configure a File or Image element to enable the upload of files and images. Files and images upload to Content Documents by default.
Add a Flexcard LWC to OmniOut (Managed Package): For the managed package runtime, download and configure a Flexcard to use it off-platform in your OmniOut project. Download your Flexcard LWC from the Flexcard Designer, add the component folder to the OmniOut project, and configure files for HTML and CSS.
Add a Flexcard to a Lightning Page (Managed Package): For the managed package runtime, after creating and activating your Flexcard, publish the generated component to a Lightning page from the Lightning App Builder.
Add a Flexcard to an Experience Page (Managed Package): For the managed package runtime, after creating and activating your Flexcard, publish the generated component to an Experience page from the Experience Builder.
Add a Flexcard to an Experience Cloud Page: After creating and activating your Flexcard, publish the generated component to an Experience Cloud page from the Experience Builder.
Add a Menu to a Flexcard (Managed Package): For the managed package runtime, create a menu from a list of actions on a Flexcard. Style the menu button, and each action in the menu's dropdown. Add any action type available in the Flexcard Designer.
Group Actions in a Menu on a Flexcard: Create a menu from a list of actions on a Flexcard. Style the menu button, and each action in the menu's dropdown.
Add a Multi-Select Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Multi-Select Input element on a Flexcard to enable users to select from multiple options. You can display options as images, checkboxes, buttons, or a dropdown list. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a New Object to the Customer Story (Managed Package): For the managed package runtime, the Customer Story includes default customer activities depending on your org's industry. You can also add new story objects to the timeline. Use the Story List Page Limit custom setting to set the maximum number of records returned per story object.
Add a New Object to the Story-SLDS Component (Managed Package): For the managed package runtime, clone and modify the story-slds card layout to add a new story object to the Customer Story timeline. The Vlocity Customer Story displays a timeline of all interactions with a customer in a single, chronological feed. Update the maximum number of records returned per story object with the pageSize parameter.
Add a Number Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Number Input element on a Flexcard to enable users to enter a numeric value. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Radio Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Radio input element on a Flexcard to enable users to select an item from one or more options. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Range Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Number Input element on a Flexcard to enable users to select from a range of numbers you specify. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Reload Action to a Flexcard (Managed Package): For the managed package runtime, with a Card Action, create an action that reloads a Flexcard. For example, create a FLexCard that listens for an event from another Flexcard and reloads itself when the event is fired.
Add a Remove Card Action to a Flexcard (Managed Package): For the managed package runtime, remove a specific record on a Flexcard or remove the entire Flexcard with a remove card action. The data record is only removed from the Flexcard and not from the database it's pulled from. The Flexcard is only removed from the page it's viewed from, and not permanently deleted.
Add a Select Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Select Input element on a Flexcard to enable users to select an item from a dropdown list. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a State to a Flexcard (Managed Package): For the managed package runtime, add a state to a Flexcard to present different interactions and layouts based on specified conditions. Each Flexcard has a default state that cannot be deleted. Add a State element to the canvas of a Flexcard, or clone a state already on the canvas.
Add a Telephone Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Telephone Input element on a Flexcard to enable users to enter a valid phone number. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Text Area Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Text Area Input element on a Flexcard to enable users to enter multiple lines of plain text. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Text Element to a Flexcard (Managed Package): For the managed package runtime, combine plain text and merge fields inside a rich text editor with the Text element in the Flexcard Designer. Enter a merge field, such as data fields, or context variables, such as session variables.
Display Text on a Flexcard: Keep your user informed by displaying text that combines plain text and merge fields. Format the final rendering by using a rich text editor.
Add a Text Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Text Input element on a Flexcard to enable users to enter one line of plain text. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Time Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Time Input element on a Flexcard to enable users to select a formatted time from a list of time intervals. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Typeahead Input Element to a Flexcard (Managed Package): For the managed package runtime, add a Typeahead Input element on a Flexcard to enable users to click into a search field, which provides hints or a list of possible options based on the text the user enters. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add a Vlocity Action to a Flexcard (Managed Package): For the managed package runtime, add a reusable action to a Flexcard with a Vlocity Action element. Vlocity Actions launch Omniscripts, components, web pages, or external applications.
Add Aggregation Steps (Managed Package): For the managed package runtime, if the input to the calculation procedure is an array—for example, multiple family members are applying for insurance and want to view the total premium—the calculation procedure runs for each input. Using an aggregation step, you can aggregate the procedure results and execute additional calculations on the aggregated result.
Add an Action Message (Managed Package): For the managed package runtime, display an action message beneath the loading spinner while the action is running.Beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, LWC Omniscripts support custom Action messages.
Add Actions to a Flexcard (Managed Package): For the managed package runtime, add up to six actions to a Flexcard to launch or update an Omniscript, navigate to a web page or application, display a flyout, fire an event, or update data field values. For example, add an action on an account Flexcard that when clicked, displays the contact information for the account.
Set Up Actions on a Flexcard: Configure actions that users can complete on Flexcards to improve the self-service experience, and save time on manual tasks. Add actions to supported elements or add an action element to a Flexcard, and then configure the action settings. For example, you want to have a button that opens a URL for additional information. To do so, add an action to an existing image or add an action element for which you select an image. You can also set up sequential actions and configure each action’s trigger.
Add an Action to Update Field Values on a Flexcard (Managed Package): For the managed package runtime, with a Card Action, create an action that updates specific field values on a Flexcard. For example, allow your customer service reps to update the status of a case to closed when the case is resolved.
Add an Apex Class Permissions Checker (Managed Package): For the managed package runtime, enable specific access to the VlocityOpenInterface Apex class used by remote action APIs for each user or profile, permission set, or permission set group. Use the Apex class check setting to enable users with permission sets or permission set groups to call allowlisted Apex classes remotely. Configure an Apex class permissions checker to ensure that users require explicit access to the Apex class that administers the remote action called from an Omniscript, Integration Procedure, Flexcard, Classic Card, or REST API.
Set Up Access to Remote Action APIs: Configure access to Apex classes used by the remote actions (Vlocity Open Interface Apex classes) called from an Omniscript, Flexcard, Classic Card, or REST API, by profiles.
Add an Email Input Element to a Flexcard (Managed Package): For the managed package runtime, add an Email Input element on a Flexcard to enable users to enter a valid email address. From the Properties panel, configure properties and custom attributes, add an action, and add conditions.
Add an Event Listener to a Flexcard (Managed Package): For the managed package runtime, add an event listener that listens for an event fired from a component and performs an action in response. With a Pubsub Event, listen for an event from another component, such as another Flexcard on the same Lightning page. With a Custom event, listen for an event fired from a child Flexcard or from an element on the card.
Add an Icon to a Flexcard (Managed Package): For the managed package runtime, display an SVG Icon on a Flexcard. Select from a Salesforce SVG icon or a custom action. You can also link the icon to an action.
Add an Icon or an Image to a Flexcard: Add icons or images to a Flexcard from an existing library or use your own. Then, add actions, CSS classes, and configure their dimensions to fit your company or institution.
Add an Image to a Flexcard (Managed Package): For the managed package runtime, add an image to a Flexcard in the Flexcard Designer. With the Image element, upload an image from your computer, use an image from a Salesforce library, enter a URL, or use a merge field from a data source. Link the image to an action, add classes, and adjust the size of the image relative to the canvas size.
Add an Omniscript Lightning Web Component to OmniOut (Managed Package): For the managed package runtime, download and configure an Omniscript to use it off-platform in OmniOut. Download your Omniscript LWC from the LWC Omniscript Designer, add the component folder to the OmniOut project, and configure files for HTML and CSS.
Add Conditional Styles to a Flexcard Element (Managed Package): For the managed package runtime, conditionally apply styles to a Flexcard element. Change style features such as text color, background image, and responsiveness when a condition based on the value of a data field is met. For example, add a red border around a billing Flexcard when the bill status is past due.
Add Conditions to a Flexcard Element (Managed Package): For the managed package runtime, display or hide data based on the value of a data field. For example, display an alert icon or supplemental text for escalated Cases. Apply conditions to any element listed in the Build panel of the Flexcard Designer.
Set Up Conditions to a Flexcard Element: Apply conditions to Flexcards elements to show only relevant information to your users based on data field values. For example, on a Flexcard that summarizes the terms of a contract, only show reminder text when the contract renewal date is within a defined range.
Add Conditions to a Flexcard State (Managed Package): For the managed package runtime, Flexcard states enable the presentation of different CRM interactions for each state. Set conditions to determine if, when, and how data displays on a Flexcard.
Set Up Conditions Based on Flexcard States: Flexcard states determine the fields and actions available to the user. When you create a Flexcard, Omnistudio assigns a default state. You can create more as needed to offer different information and interactions based on conditions that you define. For example, include an empty state when no data is available, or visual cues when a user action is required such as a payment or an acknowledgment. Or add different buttons based on a support case status such as Reopen for closed cases and View for escalated cases.
Add Custom Labels to Supported Fields on a Flexcard (Managed Package): For the managed package runtime, add custom labels to supported Flexcard element fields with the {Label} merge field. Custom labels are custom text values that can be accessed from Apex classes, Visualforce pages, or Lightning components. Add custom labels if your Flexcard supports multiple languages. The values can be translated into any language Salesforce supports.
Add Custom Style Sheets to Your OmniOut Application (Managed Package): For the managed package runtime, include custom styling in your OmniOut project by using style sheets. Custom stylesheets aren’t included in the Omniscript or Flexcard off-platform download metadata. You must add them to your application before building the dist folder.
Add Data to the Generate Receipt Step (Managed Package): For the managed package runtime, the Messaging Framework of the Generate Receipt step stores the data format for the selected device. For the example, only the DeviceName is a merge field. The remaining values are hard-coded.
Add Data to the Provide Payment Step (Managed Package): For the managed package runtime, the Messaging Framework of the Provide Payment step stores the data format for the selected device. For the example, only the DeviceName is a merge field. The remaining values are hard-coded.
Add Data to the Review Cart and Shipping Address Steps (Managed Package): For the managed package runtime, the Messaging Framework of the Review Cart and Shipping Address steps stores the data format for the selected device. For the example, only the DeviceName is a merge field. The remaining values are hard-coded.
Add Data to the Script Setup (Managed Package): For the managed package runtime, the Messaging Framework of the Script Setup stores the master list of product impressions sent to Google Analytics Ecommerce.
Add Data to the Select Device Step (Managed Package): For the managed package runtime, the Messaging Framework of the Select Device step stores the master list of product impressions sent to Google Analytics Ecommerce.
Add Data to the View Quote and View Cart Steps (Managed Package): For the managed package runtime, the Messaging Framework of the View Quote and View Cart steps stores the data format for the selected device. For the example, only the DeviceName is a merge field. The remaining values are hard-coded.
Add Debugging Data to Test Procedure Event Tracking: When you run a Test Procedure in the Preview tab, JSON data for debugging is included in the Errors/Debug Output pane. To include this debugging data in VlocityTrackingEntry__c object records under the StepDebugInfo JSON node, you can set the value of the OmniAnalyticsTrackingDebug custom setting to True.
Add Debugging Data to Test Procedure Event Tracking (Vlocity) (Managed Package): For the managed package runtime, when you run a Test Procedure in the Preview tab, JSON data for debugging is included in the Errors/Debug Output pane. To include this debugging data in VlocityTrackingEntry__c object records under the StepDebugInfo JSON node, you can set the value of the OmniAnalyticsTrackingDebug custom setting to True.
Add Elements to a Flexcard (Managed Package): For the managed package runtime, add data fields, states, actions, and other elements to your Flexcard. Style an element and configure its properties in the Flexcard Designer.
Add Elements to a Flexcard: Build your card by dragging elements into a state on the canvas. Add data fields, display, and input elements to your Flexcard. Show data generated dynamically from the Flexcard’s data source, or add static information. Rearrange, clone, delete, and adjust the widths of your elements as needed. Style an element and configure its properties in the Flexcard designer.
Adding Global Actions (Managed Package): For the managed package runtime, run Actions on the entire JSON for the Edit Block by adding global actions. Global actions display outside of the Edit Block entries.
Add Inline Styles to a Flexcard Element (Managed Package): For the managed package runtime, when styling options available from the design interfaces in the Flexcard Designer don't meet your design needs, add inline CSS styles to an element on a Flexcard. Override classes and target specific elements or element components.
Add Inputs to an Edit Block (Managed Package): For the managed package runtime, when you create or edit multiple records in an Edit Block, you edit the fields in those records by entering data into Input elements. For example, editing Contact records requires Input elements for fields such as Name and Phone.
Add Integration Procedure Components to an Upgraded Org (Managed Package): For the managed package runtime, to use new components after upgrading an org, add Integration Procedure components to the Omniscript Element Type picklist. This article describes the process of adding components and provides a list of the added components by release.
Add Matrix Lookups (Managed Package): For the managed package runtime, a matrix lookup step calls a calculation matrix, supplying input to the matrix and returning its output.
Add Options for Selects, Multi-Selects, and Radio Buttons (Managed Package): For the managed package runtime, to add options for Select, Multi-Select, and Radio Button elements, go to the Options section of the element properties and click + Add New Option. If no values are defined for a Select element, an Undefined Value is returned.
Add Options for Selects, Multi-Selects, and Radio Buttons: To add options for Select, Multi-Select, and Radio Button elements, go to the Options section of the element properties and click + Add New Option. If no values are defined for a Select element, an Undefined Value is returned.
Add or Modify a Customer Story Icon (Managed Package): For the managed package runtime, in the Customer Story, each story object type has an associated icon that appears next to the title of the story item. The icons are automatically retrieved based on the object type.
Add Session Variables to a Flexcard (Managed Package): For the managed package runtime, set attributes available from a component, or store values from data sources or external systems to access globally on a Flexcard. For example, set an API key or track pagination. Use the merge field {Session.var} to parse the value.
Add Space Inside a Flexcard Element (Managed Package): For the managed package runtime, create space inside the container of a Flexcard element. Add padding to create space between the boundary of your element and the contents inside your element.
Add the DocuSign Login Page as a Trusted URL: DocuSign runs on an iFrame. To allow the content to show on Experience Cloud sites, add the DocuSign login page as a trusted URL and allow iFrame content.
Add the Vlocity Action Toolbar to a Lightning Record Page (Managed Package): For the managed package runtime, open a card, Omniscript, Experience Cloud site page, web page, document, or external application from the Vlocity Action Toolbar on a Lightning record page. For example, add the toolbar to an account page to update an account and perform other Vlocity Actions available to accounts.
Add the Vlocity Actions Toolbar to an Experience Cloud Site Record Page (Managed Package): For the managed package runtime, open a card, Omniscript, another Experience Cloud site page, web page, document, or external application from the Vlocity Action Toolbar on an Experience Cloud site record page. For example, add the toolbar to an account page to update an account and perform other Vlocity Actions available to accounts.
Add the Vlocity LWC OmniOut Component to Adobe Experience Manager (Managed Package): For the managed package runtime, launch Omniscripts from an AEM page by adding the Vlocity LWC OmniOut Component. The Vlocity LWC OmniOut component hosts the Omniscript and uses the Salesforce Cloud Services configuration to make calls to Salesforce.
Added Dimensions in the Matrix (Managed Package): For the managed package runtime, you might want to look up additional dimensions in the Matrix. For example, to look up Age Range Band by gender, create two rows for each age: one for Male applicants, the other for Female applicants. Additional dimensions require additional rows.
Adding a Card to a Layout (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Adding a Custom Action to a Card (Managed Package): For the managed package runtime, add actions directly on a card with Custom Actions. Custom Actions perform faster than standard Vlocity Actions but have fewer configuration options.
Adding a Custom Action to an LWC Card (Managed Package): For the managed package runtime, add actions directly on a card with Custom Actions. Custom Actions perform faster than standard Vlocity Actions but have fewer configuration options. For reusable actions with additional configuration options, see Vlocity Actions.
Adding a Flyout to a Card State (Managed Package): For the managed package runtime, add a flyout to a card state to display additional information about the record displayed on the card when you click the card. For example, the base Vlocity flyout template flyout-grid-slds displays overflow actions from the parent card.
Adding a State to a Card (Managed Package): For the managed package runtime, add card states to display data fields from the card or card layout data source, to present different interactions and layouts based on specified conditions, to add actions, and to add flyouts to display additional information about a record. For example, for cards displaying past due policy information, use a card state template, and display actions, fields, and flyouts different from those on cards displaying information for active policies in good standing.
Adding a Vlocity Action to a Card (Managed Package): For the managed package runtime, add reusable actions to a card with Vlocity Actions to launch Vlocity Omniscripts, Vlocity Cards components, web pages, or external applications.
Adding an LWC Card to a Lightning or Community Page (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Adding Conditions to a Card State (Managed Package): For the managed package runtime, set conditions to determine which card state is displayed on a layout or to change appearance based on conditions. For example, on a card that displays policy information, one card state shows action links to update profile and account information for all policies, while another card state includes a renew action link if the policy is about to expire.
Adding Omniscript Elements to an Upgraded Org (Managed Package): For the managed package runtime, to use new elements after upgrading an org, add Omniscript elements to the Omniscript Element Type picklist. This article describes the process of adding elements and provides a list of the added elements by release.
Add Omniscript to a Page in Adobe Experience Manager (Managed Package): For the managed package runtime, to use Omniscript as a paragraph component in Adobe Experience Manager, it is first necessary to ensure that the Omniscript page exists in Salesforce or a locally defined Omniscript has been added to Adobe Experience Manager. Once the Omniscript is confirmed in Salesforce or locally defined, you can create a page in AEM that uses Omniscript.
Additional OmniAnalytics Customizations (Managed Package): For the managed package runtime, additional OmniAnalytics customizations include inclusion rules for Vlocity Web Tracking Event Types, configuration of other third-party analytics vendors aside from Google Analytics, and using a static resource instead of a Visualforce page.
Adjust the Height of an Element on a Flexcard (Managed Package): For the managed package runtime, update the height of an element on a Flexcard from the Style panel in the Flexcard Designer. Enter any CSS supported values, such as length units (px, cm, and so on), inherit, auto, and so forth. Or enter a CSS function, such as calc(2em * 5).
Adjust the Width of an Element on a Flexcard (Managed Package): For the managed package runtime, after dragging an element from the Build panel into a state, adjust its width along a 12-column horizontal grid. The width of an element is 1 to 12 parts of a 12 column grid. For example, a field element that is 6 columns wide takes up 50% of the available horizontal space.
Administering, Deploying, and Launching Omniscripts (Managed Package): For the managed package runtime, import, version, launch, and deploy Omniscripts. Omniscripts can be launched from Experience Cloud sites, object pages, Console Apps, and remote sites. Omniscripts can be deployed to Salesforce sites and external services, such as Adobe External Manager and Heroku.
Advanced Configuration for Omniscript Form Elements (Managed Package): For the managed package runtime, this section tells you how to work with elements that enable users to input information, search for record information, select options, create records, edit records, and delete records.
Advanced Security Checks for Omnistudio for Managed Packages: Advanced security checks for Omnistudio for Managed Packages enhance data protection by enforcing stricter validation of access and permissions. When enabled, these checks validate object-level access, field-level security, and Apex class permissions for all users, including guest, authenticated, and non-authenticated users, across Omnistudio components.
Agentforce for Omnistudio (Pilot): Get instant product assistance, solution build plans, and troubleshooting help with the Omnistudio Assistance AI pilot agent.
Append a Record from an Action on a Flexcard (Managed Package): For the managed package runtime, reduce the time to render a large list of records using the Append Record action. Instead of using the Update Datasource action to update a record, which renders the whole card again, use Append Record to add additional data tp the end of the record.
Apply Custom CSS to a Flexcard Element (Managed Package): For the managed package runtime, when the design interfaces available in the Style panel of the Flexcard Designer don't meet your design needs, apply custom CSS to your elements. Add custom CSS to edit the internal components of an element or a child element. Use this feature sparingly to optimize performance.
Apply Custom Lightning Styles to a Specific Flexcard (Managed Package): For the managed package runtime, overwrite global Lightning styles for a specific Flexcard. For example, if your Flexcard requires unique branding across multiple components, you can create custom Lightning styles and load them in your Flexcard as a static resource.
Apply Custom Newport Styles to a Specific Flexcard (Managed Package): For the managed package runtime, overwrite global Newport styles for a specific Flexcard. For example, if your Flexcard requires unique branding across multiple components, you can create custom Newport styles and load them in your Flexcard as a static resource.
Apply Custom Styling to Omniscripts with Static Resources (Managed Package): For the managed package runtime, to apply CSS changes to an Omniscript using SLDS or Newport styling, refer to a CSS file static resource in the Styling Options section of the LWC Omniscript Designer. For example, a CSS sheet can change the text color for every Number element in an Omniscript without using a custom Lightning web component to override the Number element.
Apply Global Branding to Omniscripts (Managed Package): For the managed package runtime, apply global style changes to Omniscripts by using the Newport Design System, which you can download and use to edit and override existing Newport CSS styling.
Apply Global Branding to Vlocity Cards (Managed Package): For the managed package runtime, apply global style changes to all Vlocity Cards in your org by using the Newport Design System. The Newport Design System enables you to download, edit, and override the existing Newport CSS styles with your own styles.
Arrange, Duplicate, and Remove Elements on a Flexcard (Managed Package): For the managed package runtime, arrange, duplicate, and delete elements on the canvas of a Flexcard in the Flexcard Designer. Drag elements onto the canvas, and rearrange them by dragging them below, above, and next to other elements. Duplicate and remove elements with one click.
Assert Action for Integration Procedures (Managed Package): For the managed package runtime, the Assert Action compares the expected and actual results of a Test Procedure using an expression that evaluates to true or false. You can use environment variables in the Assert Conditional Formula to test performance.
Assert Action for Integration Procedures: The Assert Action compares the expected and actual results of a Test Procedure using an expression that evaluates to true or false. You can use environment variables in the Assert Conditional Formula to test performance.
Assert Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Assert Actions. The Assert Action compares the expected and actual results of a Test Procedure using an expression that evaluates to true or false.
Subagent: Diagnostics (Pilot): The Diagnostics subagent offers Omnistudio component designers valuable insights for troubleshooting. They can use it during the design phase to identify potential issues and error scenarios that can occur during runtime.
Subagent: Data Mapper Information (Pilot): Data Mapper designers can use the Data Mapper Information subagent for getting information about Data Mappers and the integration among Data Mappers, Integration Procedures, Omniscripts, and Flexcards.
Subagent: Flexcard Information (Pilot): Flexcard designers can use the Flexcard Information subagent for getting information about Flexcards and the integration among Data Mappers, Integration Procedures, Omniscripts, and Flexcards.
Subagent: Omniscript Information (Pilot): Omniscript designers can use the Omniscript Information subagent for getting information about Omniscripts and the integration among Data Mappers, Integration Procedures, Omniscripts, and Flexcards.
Subagent: Product Strategy (Pilot): Implementation experts, solution architects, and developers can use the Product Strategy subagent to design a reusable architecture, a build plan, or a planning guide for various business processes such as vehicle registration, service appointment booking, warranty activation, recall management, work order creation .
Backward Compatibility Support for Passing Page Params (Managed Package): For the managed package runtime, if you pass a page parameter to a Lightning page you must use a namespace prefix, such as params.ns_contactId, where ns represents your namespace prefix. For backward compatibility on older Angular cards, both the page parameter with and without the namespace prefix are read, such as params.contactId and params.ns__contactId.
Base LWC Card and Layout Templates (Managed Package): For the managed package runtime, the following tables list the LWC card templates and LWC layout templates available in Vlocity Cards. When editing a template, it is best practice to make a copy of the existing template first and to edit the cloned version. For more information on creating and cloning LWC card templates, see Creating Custom LWC Card Templates.
Base Omnistudio LWC ReadMe Reference: View examples, and learn about available attributes, methods, and other functions from the ReadMes of each Base Omnistudio Lightning web component.
Base UI and Card Templates (Managed Package): For the managed package runtime, the following tables list the base templates that are available for use with Vlocity Cards. When editing a template, it’s best practice to clone the existing template first and to edit the cloned version.
Base Vlocity LWC ReadMe Reference (Managed Package): For the managed package runtime, view examples, and learn about available attributes, methods, and other functions from the ReadMes of each Base Vlocity Lightning web component.
Batch Action for Integration Procedures (Managed Package): For the managed package runtime, the Batch Action runs a Vlocity Scheduled Job with a Data Source Type of Data Input, Query, List Input, or No Input. A Vlocity scheduled job calls either another Integration Procedure or a VlocityOpenInterface.
Batch Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Batch Actions. The Batch Action runs a Vlocity Scheduled Job with a Data Source Type of Data Input, Query, List Input, or No Input. A Vlocity Scheduled Job calls either another Integration Procedure or a VlocityOpenInterface.
Batch Framework Initialization (Managed Package): For the managed package runtime, the Vlocity batch framework launches the jobs that are defined in the Vlocity Scheduled Job custom object. To start the Vlocity batch framework, you must execute Apex code, which creates an instance of the framework and invokes its start method.
Batch Framework Initialization: The Vlocity batch framework launches the jobs that are defined in the Vlocity Scheduled Job custom object. To start the Vlocity batch framework, you must execute Apex code, which creates an instance of the framework and invokes its start method.
Batch Jobs for Integration Procedures and Vlocity Open Interfaces (Managed Package): For the managed package runtime, the Vlocity batch framework lets you run an Integration Procedure or VlocityOpenInterface on a schedule. Typical use cases are a recurrent billing cycle or a scan for insurance policies that come up for renewal in the next 60 days. When a job is run, it sends its input to an Integration Procedure or Apex method that processes the records.
Batch Jobs for Integration Procedures and Vlocity Open Interfaces: The Vlocity batch framework lets you run an Integration Procedure or VlocityOpenInterface on a schedule. Typical use cases are a recurrent billing cycle or a scan for insurance policies that come up for renewal in the next 60 days. When a job is run, it sends its input to an Integration Procedure or Apex method that processes the records.
Best Practice for Making Remote Calls (Managed Package): For the managed package runtime, when making remote calls, start the flow with the executeAction method. Do not start the flow with the invokeAction method. To standardize the action flow and use the built-in logic of the action framework, Vlocity recommends that all action flows begin with executeAction.
Best Practices for Using the Omnistudio Standard Designer: To troubleshoot an issue or to test new workflows, we recommend that you use a cloned Salesforce org. To directly use the standard designer in your sandbox and production environments, create a new version of your Omnistudio components and validate them in the standard designer. When you use the standard designer in your test orgs for the first time, open all Omnistudio components from the list view page.
Bind a Flexcard Input Value to a Data Field (Managed Package): For the managed package runtime, bind the value of an Input element to a new or existing data field in your Flexcard's data source. When a user updates the input value, the data JSON updates. You can use the new data like any other piece of data from a data source. For example, update the value of an attribute sent from a parent to a child Flexcard based on user input.
Update Data Field Based on Value Entered by User: Ensure that your data is always up to date by binding an input element value to a data field in your Flexcard's data source. As a result, when a user updates the input value, Omnistudio updates the corresponding JSON code. You can use the new data like any other piece of data from a data source. For example, update the value of an attribute sent from a parent to a child Flexcard based on user input.
Block (Managed Package): For the managed package runtime, combine logical groups of elements in an Omniscript Step using a Block element.
Combine Elements Logically in a Block: Combine logical groups of elements in an Omniscript Step using a Block element. Blocks help to group information to create nested JSON data. Blocks are contained within steps and can be repeated to capture an array of data. For example, street, city, state, and postal code elements can be combined into an address block.
Brand Flexcards Globally with the Newport Design System (Managed Package): For the managed package runtime, customize the appearance of Flexcards throughout your org with the Newport Design System. The Newport Design System enables you to download, edit, and override the existing Newport CSS styles with your own customizations. Newport includes Storybook.js, a browser-based preview tool that enables you to see your changes in action.
Branding Omniscripts and Cards Using Vlocity Newport Design System (Managed Package): For the managed package runtime, customize the appearance and behavior of Omniscript elements and Card layouts using the Vlocity Newport Design System. Newport includes Storybook.js, a browser-based preview tool that enables you to see your changes in action.
Build a Flexcard with the Flexcard Designer (Managed Package): For the managed package runtime, with the Flexcard Designer create, build, design, test, and activate a Flexcard before publishing it to a Lightning or Experience page. Use a drag interface with WYSIWYG editing to preview while you build dynamic context-specific user interfaces for customer interactions.
Build an Omniscript with Elements: For guided workflows, Omniscripts use basic tasks: Get, save, modify, and display data from Salesforce objects and other data sources. They can also allow users to add, change, or remove data and can take actions, such as getting a DocuSign signature, sending an email, or opening a web page.
Build an Omnistudio Data Mapper: To get, save, and modify Salesforce data, build Data Mappers with the basic configurations: Input source, queries, formulas, mappings of input and output data, and output destination. The available configurations depend on the type of Data Mapper that you’re building.
Build an Integration Procedure: To build an Integration Procedure, define its steps and logic by using a combination of Blocks and Actions.
Anonymous Apex and JavaScript (Managed Package): For the managed package runtime, review considerations and guidelines for using the Omnistudio Build Tool with Anonymous Apex and JavaScript.
Clean Data (Managed Package): For the managed package runtime, the Omnistudio Build Tool includes a script to help find and eliminate incorrect data.
Command Line API (Managed Package): For the managed package runtime, the command line API can also return JSON formatted output and accept some inputs as JSON.
Omnistudio Build Tool Commands (Managed Package): For the managed package runtime, review Build Tool commands organized and described by export and deploy, troubleshooting, and additional tasks (such as rebuilding data packs, comparing local files with an org, and listing data packs that can be exported).
Creating Custom Matching Keys (Managed Package): For the managed package runtime, Vlocity Matching Keys are a custom metadata type in Salesforce. Vlocity matching keys contain seven fields
Best Practice Developer Workflow (Managed Package): For the managed package runtime, when developing on a large project, exporting data packs through queries isn't an ideal process. We recommend that you use a manifest-driven workflow to track the major items that you’re working on. Then, extract those items to commit to version control. The manifest section of the job file can be used to create a collection of data packs to be exported or deployed. Manifests are based on the data pack key of each data pack.
Errors (Managed Package): For the managed package runtime, review error messages provided by the Omnistudio Build Tool.
Export and Deployment Tools (Managed Package): For the managed package runtime, use the correct command syntax and specify the proper data pack type. Use a job file to define the export and deploy process settings.
External IDs and Global Keys (Managed Package): For the managed package runtime, most objects that are being deployed have a field or set of fields that are used to find unique records like an External Id in Salesforce. For many objects, the Global Key field is used. If a deployment finds one object that matches the global key, it overwrites that object during deploy.
Export and Deploy by Using the Omnistudio Build Tool Job File (Managed Package): For the managed package runtime, use the job file to specify settings, the project path, what to export, and where to deploy. The packExport command takes parameters based on what’s in the job file. The simplest way to export is to include a manifest in your job file that exports all data packs by their data pack key. Or you can narrow the export using SOQL queries.
Load Metadata (Managed Package): For the managed package runtime, if you recently installed the managed package or created a sandbox org that isn't a full-copy sandbox, and you didn’t develop in this org, load all the default metadata by running this command:
Export and Deploy Data from Source Org to Target Org (Managed Package): For the managed package runtime, to export and deploy data between a source or and a target org, follow this process. If you recently installed the managed package or created a sandbox org, follow the instructions for loading metadata.
Other Job File Settings (Managed Package): For the managed package runtime, the job file has a number of additional runtime settings that you can use to define your project and to run exports and deployments run. Modify the default settings only to account for unique issues in your org.
Overriding Data Pack Settings (Managed Package): For the managed package runtime, you can change the settings that are used to define the behavior of each data pack that is imported, deployed, and written to the files.
Set Up a Project to Export and Deploy (Managed Package): For the managed package runtime, start by identifying the data source and the target org. Examples show the simplest job file that can be used to set up a project and the commands for exporting and deploying.
Tools and Processes for Troubleshooting (Managed Package): For the managed package runtime, the Omnistudio Build Tool includes various tools and processes for troubleshooting, including log files, errors, and a script for cleaning data.
Validate Local Data (Managed Package): For the managed package runtime, to detect missing and duplicate global keys in the local files that have been exported, use the validateLocalData command.
Data Pack Key (Managed Package): For the managed package runtime, each data pack has a data pack key that represents its unique name in the data pack system. After a data pack is exported, the data pack key matches the folder name of the data pack.
Cache Block: Using a cache to store frequently accessed, infrequently updated data saves round trips to the database and improves performance. Use Cache Blocks if some parts of the Integration Procedure update data and therefore shouldn't be cached, or if different cached data should expire at different times.
Cache Block Properties (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Cache Blocks. Use Cache Blocks if some parts of the Integration Procedure update data and therefore shouldn't be cached, or if different cached data should expire at different times.
Cache for Omnistudio Data Mappers (Managed Package): For the managed package runtime, Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Data Mappers. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in the Data Mapper designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Vlocity Cache in Omnistudio with managed package runtime. Each serves a distinct purpose and comes with specific configuration considerations.
Cache for Omnistudio Integration Procedures (Managed Package): For the managed package runtime, Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Integration Procedures. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in Integration Procedure designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Vlocity Cache in Omnistudio with managed package runtime. Each serves a distinct purpose and comes with specific configuration considerations.
Improving Data Mapper Performance with Caching: Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Data Mappers. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in the Data Mapper designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Scale Cache in Omnistudio with standard runtime. Each serves a distinct purpose and comes with specific configuration considerations.
Improve Performance by Using Caching: Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Integration Procedures. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in Integration Procedure designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Scale Cache in Omnistudio with standard runtime. Each serves a distinct purpose and comes with specific configuration considerations.
Cache for Top-Level Integration Procedure Data (Managed Package): For the managed package runtime, using a cache to store frequently accessed, infrequently updated Integration Procedure data saves round trips to the database and improves performance. You can cache all the data for an Integration Procedure, as described here, or you can use a Cache Block to cache only part of it.
Cache for Top-Level Integration Procedure Data: Using a cache to store frequently accessed, infrequently updated Integration Procedure data saves round trips to the database and improves performance. You can cache all the data for an Integration Procedure, as described here, or you can use a Cache Block to cache only part of it.
Calculation Action (Managed Package): For the managed package runtime, call a Vlocity Calculation Procedure directly from an Omniscript using the Calculation Action.
Calculation Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Calculation Actions. A Calculation Action invokes the specified calculation procedure and returns the results to the Integration Procedure.
Calculation Example for Life Insurance Quote (Managed Package): For the managed package runtime, to provide an accurate quote, an agent must know a person’s age, home ZIP code, and whether they smoke. First, a form prompts for the needed data, from an agent or web self-service. When the form is submitted, a calculation procedure defined for that form runs. The first procedure step is a Matrix Lookup, which looks across the matrix input fields—Smoker, ZIP, and Age—to find the corresponding output (Rate).
Calculation Matrices (Managed Package): For the managed package runtime, calculation matrices are one of the key elements of a Vlocity rating engine. Vlocity uses calculation matrices to look up inputs, match them to outputs, and provide the outputs to calculation procedures.
Calculation Procedures and Matrices (Managed Package): For the managed package runtime, a calculation procedure is a series of calculations performed on matrix lookups and user-defined variables and constants. A calculation matrix is a table that looks up information using multiple input dimensions and returns the corresponding output value.
Calculation Procedures Overview (Managed Package): For the managed package runtime, a Calculation Procedure is a series of calculations performed using matrix lookups and user-defined variables and constants. A calculation procedure can call Apex classes for pre- and post-calculation custom logic. Calculation procedures are part of pricing rules.
Call a Data Source from an Action on a Flexcard (Managed Package): For the managed package runtime, trigger a data source from an action to get data from a server or post data to a server. When data is fetched from the server, the incoming data is appended to the data JSON in the card's record object or to a data node you name. If you choose to send the request without getting a response from the server, the data JSON does not update. To confirm your request is sent successfully, in Preview, view the requested data in the Action Debugger's response.
Get or Send Data from or to a Flexcard: Transfer data from or to a server by calling a data source. When Omnistudio receives the data, it adds it to the JSON data in the card's record object or to a data node that you specify. For example, populate a child Flexcard with data from its parent, or conditionally show messages from an API response.
Card States (Managed Package): For the managed package runtime, cards have states. Each state displays a list of fields from either the layout or the individual card data source, plus a list of Vlocity Actions. You can also associate each state with a flyout, an extended version of a card with supplemental data displayed in a larger area.
Cards Caching (Managed Package): For the managed package runtime, cards, card layouts, templates, custom labels, and profile data load from the VlocityMetadata partition of the Platform Cache when the card is active and viewed from a record page or a community page. You can clear, enable, or disable the user session cache and specific types of data from the Platform Cache.
Cards Context Variables (Managed Package): For the managed package runtime, several variables are available across the framework to provide contexts to cards, data sources, flyouts, templates, and other components.
Cards Designer (Managed Package): For the managed package runtime, you can use the Cards Designer to interactively create and configure layouts, zones, cards, flyouts, and card states.
Cards Framework Event Tracking (Managed Package): For the managed package runtime, the Vlocity Tracking Service is an event-tracking service that can capture details about how Vlocity users interact with the Cards Framework.
Cards Framework Required Resources (Managed Package): For the managed package runtime, for Angular components, when implementing the CardFramework in your custom page, you must include these resources, in the order given.
Cards Framework Versioning (Managed Package): For the managed package runtime, the Vlocity Cards Framework supports versioning for all components. The name, author, and version combination must be unique for each component of a given type (layout, card, or template) in an org.
Cards Framework Web Deployment Options (Managed Package): For the managed package runtime, you can deploy Omnistudio for Managed Packages components, including Omniscripts and Cards Framework components, outside of Salesforce. This type of deployment is also called off-platform. You can use these components in an external server with or without an active connection to a Salesforce org. You can deploy components to a Heroku web server or to Adobe Enterprise Manager.
Cards URL Syntax (Managed Package): For the managed package runtime, the Vlocity Cards framework uses a generic Visualforce page to show layouts. This page requires at least one parameter pair to load a specific layout. For example:
Change the Hierarchical Level of a List: If a list is defined at the wrong level of a JSON node hierarchy, you can use an Omnistudio Data Mapper Transform to change the level at which the list is defined. This approach only works for a short list with a known number of items.
Chatter Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Chatter Actions. All properties except Markup Type support merge fields. The Chatter Action creates a Chatter post and sends it to a Chatter feed.
Checkbox Properties (Managed Package): For the managed package runtime, Checkbox properties are configurable from the Properties panel when you select a Checkbox element. With the Checkbox element, enable users to select a checkbox in your Omniscript.
Classic Cards (Managed Package): For the managed package runtime, Classic Cards in the Vlocity Cards Framework are UI components rich in information and actions relevant to the customer's context. The Classic Card Designer is a declarative tool to create cards and card layouts, with minimal HTML, CSS, and AngularJS coding.
Classic Omniscript Designer (Managed Package): For the managed package runtime, create Omniscripts in the classic designer when an element, property, or functionality solves a project requirement that you cannot resolve in the LWC Omniscript Designer.
Clean Metadata Deployment for Omnistudio: Clean Metadata Deployment modernizes how you deploy Omnistudio components. When you turn it on, Omnistudio components behave like standard Salesforce metadata, so you deploy them with Salesforce CLI, DevOps Center, change sets, and packaging, alongside Lightning web components, flows, and Apex classes in a single pipeline.
Clear Platform and User Session Caches (Managed Package): For the managed package runtime, remove temporarily stored data by clearing the platform and user session caches to get the latest available data. Cards, card layouts, templates, custom labels, and profile data load from the VlocityMetadata partition of the Platform Cache when the card is active and viewed from a record page or a community page.
Clear a Saved State from a Previous Step (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 , when a Custom LWC's saved state relies on data from a previous step, you can conditionally clear the saved state of the Custom LWC whenever a user navigates to a previous step. After configuration, the Step element passes a boolean flag to the custom LWC. The code in your Custom LWC must use the boolean to determine whether to instantiate a new saved state or continue using the existing saved state.
Clone a Calculation Procedure (Managed Package): For the managed package runtime, the Clone action button isn't present for calculation procedures by default, but you can add it. When you clone a calculation procedure, you're cloning all of its versions, steps, variables, and constants.
Clone a Flexcard (Managed Package): For the managed package runtime, create an identical copy of a Flexcard with the Clone feature in the Flexcard Designer. Cloning an existing Flexcard creates a new Flexcard with a new Name, or Author, or both. The Name and Author must be unique.
Cloning a Card Layout (Managed Package): For the managed package runtime, clone an existing card layout to copy layout, card state, and data source settings to a new card layout.
Cloning a Template (Managed Package): For the managed package runtime, edit a template without overriding existing code and settings by cloning an Omniscript element or Cards Framework component template with the Template Designer.
Close a Flexcard Flyout Modal from an Action (Managed Package): For the managed package runtime, enable users to close a Flyout from an actionable element inside the modal. Add a custom event action with the closemodal event to your child Flexcard, custom LWC, or Omniscript flyout.
Collect Ids for the Chatter Post (Managed Package): For the managed package runtime, before you can create the Integration Procedure example with the Chatter Action, you must collect the Ids needed for assembling the Chatter post.
Common Action Element Properties (Managed Package): For the managed package runtime, Action elements can be either rendered as a button when placed in a Step or Block or run remotely if placed between steps. In either case, you can specify a redirect page, where the user can proceed to the next Step or Action, or if a button, back to the source Step.
Common Action Utility for Remote Calls (Managed Package): For the managed package runtime, make remote calls from any custom LWC using the Common Action Utility. The Common Action Utility relies on the Vlocity Action Framework to make remote calls without the dependency of a strict Omniscript data structure.
Common Integration Procedure Action Properties (Managed Package): For the managed package runtime, to compose an Integration Procedure, you add a sequence of actions. To configure an action, you set the action's properties. Standard properties that exist in most or all actions are listed here. All properties are of the String data type unless otherwise noted.
Common Omniscript Element Properties Definitions (Managed Package): For the managed package runtime, each element also includes an extensible Property set that's specific to the type of element. Use the Properties pane on the Designer to edit these properties. Some common element properties aren’t available in certain elements.
Common Omniscript Element Properties: Each Omniscript element has settings, some of which are unique to that element. Some settings are common among the elements, though some of these setting aren’t available in all elements. To edit these settings, use the Properties pane on the Designer.
Concatenate List Items: This Integration Procedure example concatenates values from an array into a single comma-separated string by using a Set Values Action inside a Loop Block, then trimming and returning the output.
Conditional Block: Use a Conditional Block to group actions and blocks behind a formula without performing a loop or merging a list. The Conditional Block’s only job is to control the Integration Procedure flow. A Conditional Block executes in its entirety if an expression is true, executes one of a set of mutually exclusive conditions defined in the steps it contains, or both.
Conditional Block Properties (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Conditional Blocks. A Conditional Block executes in its entirety if an expression is true, executes one of a set of mutually exclusive conditions defined in the steps it contains, or both.
Conditional Steps For Calculation Procedures (Managed Package): For the managed package runtime, for each step in the Calculation Procedure, you can define a condition that must be met in order for the step to be executed. The step is only executed when the condition is met.
Use the Conditional View Property to Conditionally Display Elements (Managed Package): For the managed package runtime, every step, block, or element supports at least one Conditional View. Conditional Views allow you to hide the element or the group of elements contained in a block or step based on certain conditions. Elements contain up to three conditional view options depending on the type of element. For example, an Action outside of a Step doesn’t have a Read-Only option since the action isn’t visible.
Conditionally Display Omniscript Elements: With the Conditional View property, you can hide an element or a group of elements in a block or step based on certain conditions. Every step, block, or element supports at least one conditional view. Elements contain up to three conditional view options depending on the type of element. For example, an action outside of a step doesn’t have a Read-Only option since the action isn’t visible.
Configure a Custom Data Source on a Flexcard (Managed Package): For the managed package runtime, embed custom JSON data directly into Flexcard without depending on any external data source. Configure the Custom data source for testing with temporary static data. For example, when you're waiting for access to an API, or if you want to quickly test a concept.
Configure a Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source on a Flexcard to retrieve data from a Salesforce object or an external database. A Child Flexcard can have a data source independent of the parent Flexcard or use the data source from the parent Flexcard.
Set Up a Data Source on a Flexcard: Configure how to retrieve the data that a Flexcard shows. Pull it directly from Salesforce objects with Omnistudio Data Mappers, Salesforce Object Query Language (SOQL) queries, and Salesforce Object Search Language (SOSL) searches. You can also use an external source with REST methods. For complex business processes, use the Apex remote method or Integration Procedures. If needed, set different data sources for the child and parent Flexcards. Then, choose where to publish the Flexcard.
Configure a Platform Event Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a Platform Event data source to enable apps to communicate inside and outside of Salesforce. Platform Events are part of Salesforce’s enterprise messaging platform. A Platform Event combines PushTopic and Streaming Channel. Instead of working with an sObject, Platform Events work with custom objects.
Configure a PushTopic Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a PushTopic data source to run a SOQL query that returns a result that notifies listeners of changes to records in a Salesforce organization. The PushTopic defines a Streaming API channel. For example, get notified when a case is created for a particular type or status or both.
Configure a REST Web Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a REST Web data source to get or post data from or to a public API. For example, pull in weather data from a weather API based on a policy holder's postal code.
Configure a SOQL Query Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source to use a Salesforce Object Query Language (SOQL) query to search an org's data for specific information. The SOQL queries are encrypted so that Flexcards don’t display query information on the client-side. If security is a concern, use an Omnistudio Data Mapper instead of a SOQL query, because Data Mappers provide field-level security.
Configure a SOSL Search Data Source on a Flexcard (Managed Package): For the managed package runtime, construct text-based search queries against the search index with Salesforce Object Search Language (SOSL). You can search text, email, and phone fields for multiple objects to which you have access, including custom objects, in a single query. The SOSL queries are encrypted so that Flexcards don’t display query information on the client-side.
Configure a Streaming Channel Data Source on a Flexcard (Managed Package): For the managed package runtime, enable the Streaming Channel data source to send and receive notifications based on custom events that you specify. The Streaming Channel API type enables the Streaming API to send notifications of general events that aren’t tied to Salesforce data changes.
Configure a Vlocity Action (Managed Package): For the managed package runtime, configure a Vlocity Action to launch Vlocity Omniscripts, Vlocity Cards components, web pages, or external applications. Actions are typically specific to a given object type, such as Account, Contact, Policy, or Asset.
Configure an Apex Remote Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source to invoke an Apex Class and method that fetches data to populate a Flexcard. Apex remote data sources can run asynchronously through Apex, which increases the CPU time but ensures that long-running transactions aren’t timed-out.
Configure an Apex REST Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source to use an Apex REST call to fetch data to populate fields on a Flexcard with the Get method. Use the Post method to post data back to the server.
Configure a Salesforce Org for DocuSign Integration: Enable Omnistudio to use DocuSign templates by configuring authentication providers, named credentials, and Omni Interaction Configurations. You can also enable sending or signing DocuSign documents on behalf of other users.
Configure an Edit Block (Managed Package): For the managed package runtime, Edit Blocks enable a user to add and edit multiple entries in a single array. For example, you can use an Edit Block to list and edit an Account's list of Contacts. Edit Blocks are repeatable blocks by default. You can prefill repeatable blocks with data by using an array format.
Configure an Edit Block in Omniscripts: Edit Blocks enable a user to add and edit multiple entries in a single array. For example, you can use an Edit Block to list and edit an Account's list of Contacts. Edit Blocks are repeatable blocks by default. Prefilling repeatable blocks with data is possible using an array format.
Configure an Integration Procedure Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source to use a Vlocity Integration Procedure to execute multiple actions in a single server call. For example, as a Systems Admin, you want your customer service reps to view the weather forecast of policy holders when on a call. You can use an Integration Procedure with an Omnistudio Data Mapper Extract that returns an account's ZIP code, and a REST API call that uses the ZIP code to get the current forecast for the Account's region.
Configure an Org Using a Community User Login (Managed Package): For the managed package runtime, when you configure an org for running Test Procedures, you can specify a Salesforce Community and authenticate as a Community user. This is especially useful for running Test Procedures in which user access affects the results.
Configure an SDK Data Source on a Flexcard (Managed Package): For the managed package runtime, configure a data source to use methods from an SDK to provide the data for a Flexcard. An SDK allows you to call multiple data sources, reuse business logic, and control which fields appear on your Flexcard.
Configure Caching for a Data Mapper: To configure top-level caching for a Data Mapper, go to the Procedure Configuration and set the Salesforce Platform Cache Type and Time To Live In Minutes properties.
Configure Community Profiles for Flexcards (Managed Package): For the managed package runtime, ensure that your users see Flexcards on Experience Builder sites by configuring user profile settings. Enable the appropriate interface first. Then configure custom object permissions and Apex class access.
Configure Custom Object Permissions (Managed Package): For the managed package runtime, configure custom object permissions to ensure that your users see Vlocity Card Layouts on Experience sites. Give access to the necessary objects.
Configure Elements in the LWC Omniscript Designer (Managed Package): For the managed package runtime, configure elements for your Omniscript in the Properties panel of the designer when an element is selected, such as the name, label, and instructions for a step element.
Configure for Deployment from a JSON File (Managed Package): For the managed package runtime, you can specify a DataPack as a Source and deploy to either an org or a Git repository Target. The DataPack must include all the objects you want to deploy in a single JSON file.
Configure Knowledge for Individual Steps in the Omniscript (Managed Package): For the managed package runtime, after the initial configuration to set up your Omniscript to work with Salesforce Knowledge, integrate Knowledge in your Omniscript Steps. Configure options on each step to enable Knowledge and filter results.
Configure LWC Omniscript and Flexcard Activation and Compilation (Managed Package): For the managed package runtime, if Google Chrome is your default browser and IDX Workbench logs you into your source and target orgs through it, you can skip this task. When you deploy Omniscripts, Integration Procedures, and Flexcards, they’re automatically activated in the target org. However, if you use a different browser, you must configure this automatic activation feature manually.
Configure Multi-Language in OmniOut for Omniscripts (Managed Package): For the managed package runtime, display multi-language Omniscripts in OmniOut using custom labels. Access custom labels in your Omniscript directly from Salesforce or use custom labels defined in local files. Control which language displays by using a language code.
Configure Omniscript Cancel Options: Navigate users to different Salesforce experiences after canceling an Omniscript by configuring cancel options. Omniscript's cancel functionality enables users to cancel an Omniscript from a Step by clicking a cancel link. The cancel link directs the user to a Salesforce experience set in the cancel options.
Configure a Salesforce Org for DocuSign Integration (Managed Package): For the managed package runtime, enable Omnistudio to use DocuSign templates by configuring authentication providers, named credentials, and Omni Interaction Configurations. You can also enable sending or signing DocuSign documents on behalf of other users.
Configure Publish Options on a Flexcard (Managed Package): For the managed package runtime, define metadata values, such as where your Flexcard is visible, and update the component SVG icon for your Flexcard before publishing your component to a Lighting or Experience page. For example, to view your Flexcard on an Experience site you can enable Community Page under Targets in Publish Options.
Configure Save Options (Managed Package): For the managed package runtime, enable your users to save and resume Omniscripts by configuring the save for later functionality.
Configure Top-Level Caching for an Integration Procedure: To configure top-level caching for an Integration Procedure, go to the Procedure Configuration and set the Salesforce Platform Cache Type and Time To Live In Minutes properties.
Configuring a PushTopic Data Source (Managed Package): For the managed package runtime, configure a PushTopic data source to run an SOQL query that returns a result that notifies listeners of changes to records in a Salesforce organization.
Configuring a SOQL Query Data Source (Managed Package): For the managed package runtime, configure a data source to use a Salesforce Object Query Language (SOQL) query to search an org's data for specific information.
Configuring Action Options (Managed Package): For the managed package runtime, configure additional options for Vlocity Actions, Omniscript Actions, and Custom Actions on a card state by enabling the Action Options feature.
Configuring Community Profiles for Vlocity Cards (Managed Package): For the managed package runtime, ensure users see Vlocity Card Layouts on community pages by configuring user profile settings. Enable the appropriate interface, and configure custom object permissions, Visualforce page access, and Apex class access.
Configuring Data Sources for Cards Components (Managed Package): For the managed package runtime, configure a data source on a card, layout, or flyout to retrieve data from a Salesforce object or an external database. Display the returned data on cards in a layout or flyout.
Configuring Dual Data Sources (Managed Package): For the managed package runtime, a dual data source combines Apex remote and Apex REST technologies to support hybrid applications for both web apps and mobile apps. The Salesforce web environment uses Apex remote technology, and the parallel mobile app uses the Apex REST API, requiring configuration for dual environments.
Configure Smart Actions on an LWC Card (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Configuring the Cancel Link in an Omniscript (Managed Package): For the managed package runtime, the Cancel link appears on every Step in an Omniscript. From the Omniscript Designer, in the Cancel Options section of the Script Configuration, you can specify the behavior for when a user hits the Cancel link with the Cancel Type and Cancel Source.
Connect APIs for Cache Management in Data Mappers: See this table for a summary of Connect APIs to call Data Mappers from Apex classes. Starting with Summer ’25, replace the existing methods in the DRGlobal Apex classes with the Connect APIs.
Connect APIs for Cache Management in Integration Procedures: See this table for a summary of Connect APIs to call Integration Procedures from Apex classes. Starting Summer ’25, replace the existing methods in the IntegrationProcedureService Apex classes with the Connect APIs.
Connect Your OmniOut App (Managed Package): For the managed package runtime, OmniOut connects your CMS to Salesforce through a proxy or directly. Configure a connection object to connect to the Salesforce Connected App. Connections are unique to your app's requirements and must be configured outside the scope of OmniOut.
Console Card and Layout Templates (Managed Package): For the managed package runtime, console card and layout templates enable multiple records to be accessible and actionable all from the same view. Apply console cards and layouts to service Vlocity Service Console apps.
Continuation in Long-Running Calls (Managed Package): For the managed package runtime, to support long-running calls, Salesforce provides Apex Continuations. If your Omniscript calls a long-running Integration Procedure or Apex class, you can enable continuation. If your Flexcard calls a long-running Integration Procedure that has an HTTP action or a Remote Action, you can enable continuation.
Continuation in Long-Running Calls: To support long-running calls, Salesforce provides Apex Continuations. If your Omniscript calls a long-running Integration Procedure or Apex class, you can enable continuation. If your Flexcard calls a long-running Integration Procedure that has an HTTP action or a Remote Action, you can enable continuation.
Controlling Field Property (Managed Package): For the managed package runtime, the Controlling Field Property on a Select Element can display Select Field Values based on the selection of another value from a Controlling Select field.
Convert a List of Objects to a List of Values (Managed Package): For the managed package runtime, you can convert a list of JSON objects (key-value pairs in braces) to a list of single values, regardless of the length of the list. The trick is to use a formula to remove the second level of the hierarchy.
Convert a List of Objects to a List of Values: You can convert a list of JSON objects (key-value pairs in braces) to a list of single values, regardless of the length of the list. The trick is to use a formula to remove the second level of the hierarchy.
Convert a Single Item to a List with One Item (Managed Package): For the managed package runtime, in some cases, a component's output that isn't in list format must pass to another component that only accepts a list. You can use the Output Data Type setting in an Omnistudio Data Mapper Transform to perform this conversion.
Convert a Single Item to a List with One Item: Sometimes, a component requires input as a list, but the input isn’t a list. You can use the Output Data Type setting in an Omnistudio Data Mapper Transform to convert JSON data to a list. Use a formula to remove the second level of the hierarchy.
Convert an Angular Omniscript to an LWC Omniscript (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Extract Fields from the Account Object Example: In this example, a Data Mapper extracts an account ID parameter and returns the account name so that an Omniscript can use the extracted account data.
Create a Basic List Merge Example (Managed Package): For the managed package runtime, the first Integration Procedure retrieves all Contacts with the same AccountId in two lists, one containing addresses, the other birthdates. It then merges the two lists into one.
Create a Basic List Merge Example: In this example, the first Integration Procedure retrieves all Contacts with the same AccountId in two lists, one containing addresses, the other birthdates. It then merges the two lists into one.
Create a Cache Block Example (Managed Package): For the managed package runtime, an Integration Procedure accepts a list of first or last names and retrieves Contacts having those names. A Cache Block improves Contact retrieval performance.
Create a Cache Block Example: In this example, an Integration Procedure accepts a list of first or last names and retrieves Contacts having those names. A Cache Block improves Contact retrieval performance.
Create a Connected App for OmniOut (Managed Package): For the managed package runtime, enable the external connection to interact with Salesforce by configuring a Connected App in Salesforce. Create a Connected App to make external calls from OmniOut. Connected Apps provide OmniOut with an access token that enables proxies and login authentication to work.
Create a Connection Object in OmniOut (Managed Package): For the managed package runtime, send and receive data to and from Salesforce by creating a connection object. A connection object must be present for every type of connection, including when a proxy is present. The connection object exposes the instance URL, namespace, and request function.
Create a Connection Object in OmniOut for Flexcards (Managed Package): For the managed package runtime, send and receive data to and from Salesforce by creating a connection object. A connection object must be present for every type of connection, including when a proxy is present. The connection object exposes the instance URL, namespace, and request function.
Create a Contact and Use a Formula (Managed Package): For the managed package runtime, an Omnistudio Data Mapper Load creates a record in the Salesforce Contact object. A formula checks whether the contact is over 18 years old: if so, a custom Authorized field is set to true.
Create a Contact and Use a Formula: A common task for an Omnistudio Data Mapper Load is to create a record in a Salesforce object. Depending on the source data, the input might need light cleanup or a check for a particular field status. In this example, the Data Mapper load creates a record in the Contact object and sets the Authorized field to true if the contact is over 18 years old.
Create a Contact for an Existing Account (Managed Package): For the managed package runtime, the following example of an Omnistudio Data Mapper Load creates a record in the Salesforce Contact object. A link to an Account object record with a specific Id ensures that the new Contact is related to that Account.
Create a Contact for an Existing Account: A common task for an Omnistudio Data Mapper Load is to create a record in a Salesforce object that's linked to another object. In this example, a Data Mapper Load creates a record in a Contact object. A link to an Account object record with a specific Id ensures that the new Contact is related to that Account.
Create a Custom Lightning Web Component for Omniscript: Add custom HTML, JavaScript, and CSS to an Omniscript by creating a custom Lightning web component. The Custom LWC element enables custom components to either interact with the Omniscript or to act as a standalone component. Standalone components do not interact with the Omniscript or the Omniscript's data JSON.
Create a Custom Style for a Flexcard Element (Managed Package): For the managed package runtime, save style settings on a Flexcard element as a Custom Style to use on multiple elements on your Flexcard. For example, to apply the same font color, font size, text color, and background color to multiple Field elements on a Flexcard, create a Custom Style called blue-field-scheme on one Field element. Then apply blue-field-scheme to other Field elements as needed.
Create a DataPack or a MultiPack (Managed Package): For the managed package runtime, to deploy data between orgs, you can create and export DataPacks, which are files with a selected object’s data in JSON format. A single DataPack contains one main object and its dependent objects. A MultiPack is a DataPack that contains multiple main objects and their dependent objects.
Create a Flexcard (Managed Package): For the managed package runtime, configure basic settings and data source options when creating a Flexcard in the Flexcard Designer. After creating a Flexcard you can update additional options and start building your user experience.
Create a Flexcard: Create a Flexcard by specifying a unique name and author. Optionally, save the Flexcard as a child card to embed it in other Flexcards. In the designer for a managed package, you can also configure its data sources and test parameters.
Create a Formula or Aggregate in an Omniscript: Create expressions to set calculated values and evaluate data across multiple fields using a Formula or Aggregate element. For example, if you are accepting information for a qualifying life event you may want to create a formula that determines if the date entered for the qualifying life event is within thirty days of today's date.
Create a Lightning App Page with a Tracking Manager (Managed Package): For the managed package runtime, the Vlocity Tracking Manager is a Lightning Web Component that must be included in any Lightning page that includes components tracked with OmniAnalytics. It listens for user interaction events and sends data for those events to VlocityTrackingEntry__c objects, VlocityTrackingEvent__e Platform Events, or both.
Create a List Merge Example with Dynamic Output Fields: The final Integration Procedure is a modified version of the previous example. It uses Dynamic Output Fields to eliminate the duplicate FN and LN JSON nodes from the output.
Create a Loop Block Example that Creates Contacts (Managed Package): For the managed package runtime, an Integration Procedure accepts an Account Id and an array of first and last names and creates new Contacts for the specified Account. It also includes a step that deletes these Contacts, which you can optionally disable.
Create an OAuth 2.0 Named Credential to Connect to DocuSign: Add a Named Credential using authentication provider information to create a secure connection. Omniscripts and Integration Procedures use these credentials to connect with DocuSign. Create a named credential for the admin who manages templates and your DocuSign account. You can also create a Send on Behalf named credential to send or sign DocuSign forms on behalf of other users.
Create an OAuth 2.0 Named Credential to Connect to DocuSign (Managed Package): For the managed package runtime, add a Named Credential using authentication provider information to create a secure connection. Omniscripts and Integration Procedures use these credentials to connect with DocuSign. Create a named credential for the admin who manages templates and your DocuSign account. You can also create a Send on Behalf named credential to send or sign DocuSign forms on behalf of other users.
Create a New Static Resource (Managed Package): For the managed package runtime, after you have downloaded and edited the default static resource, the next step is to bundle and upload the new static resource.
Create a New Version of a Calculation Procedure (Managed Package): For the managed package runtime, it's much quicker to create a new version of an existing calculation procedure than it is to create a new version from scratch. When you create a new version, all the details, variables, constants, calculations, matrix lookups, and aggregation steps are cloned from the previous version.
Create a New Version of a Flexcard (Managed Package): For the managed package runtime, create a new version of a Flexcard in the Flexcard Designer when you want to make slight modifications to a current. Creating a version of a Flexcard makes an exact copy with a version number equal to the latest version number plus one. For example, if you already have two versions, the new version number will be 3.
Create a Public Property for a Flexcard LWC in the Flexcard Designer (Managed Package): For the managed package runtime, in the Flexcard Designer, define an attribute that creates a public property whose value is set in the Lighting App Builder and Experience Builder. Call the attribute within the Flexcard as a session variable ({Session.AttName}) where merge fields are supported, such as in a Text element and a data source parameter.
Create a Public Property for a Flexcard LWC in the Flexcard Designer: In the Flexcard Designer, define an attribute that creates a public property whose value is set in the Lightning App Builder and Experience Builder. Call the attribute within the Flexcard as a session variable ({Session.AttName}) where merge fields are supported, such as in a Text element and a data source parameter.
Create a Remote Action for an Invocable Action (Managed Package): For the managed package runtime, an Integration Procedure uses a Remote Action to call the emailSimple Invocable Action, which is present in every Salesforce org. Inputs to the Invocable Action are specified in the Integration Procedure as Additional Input.
Create a Remote Action Example for an Invocable Action: This example Integration Procedure uses a Remote Action to call the emailSimple Invocable Action, which is present in every Salesforce org. Inputs to the Invocable Action are specified in the Integration Procedure as Additional Input.
Create a Remote Action for an Invocable Action with an Input Key (Managed Package): For the managed package runtime, an Integration Procedure uses a Remote Action to call the emailSimple Invocable Action, which is present in every Salesforce org. Inputs to the Invocable Action are specified in the Integration Procedure in a Remote Option named InvocableInputKey.
Create a Remote Action Example for an Invocable Action with an Input Key: An Integration Procedure uses a Remote Action to call the emailSimple Invocable Action, which is present in every Salesforce org. Inputs to the Invocable Action are specified in the Integration Procedure in a Remote Option named InvocableInputKey.
Create a Standalone Custom Lightning Web Component: Enable custom Lightning web components to act independently from an Omniscript by adding it to the Omniscript as a standalone component. Standalone custom Lightning web components cannot extend any Omniscript element component or the OmniscriptBaseMixin component. The standalone component supports custom functionalities, but cannot interact with an Omniscript or the Omniscript's data JSON.
Create a Top-Level Caching Example (Managed Package): For the managed package runtime, an Integration Procedure accepts a list of first or last names and retrieves Contacts having those names. Top-level caching to the VlocityAPIResponse partition improves Contact retrieval performance.
Create a Top-Level Caching Example: An Integration Procedure accepts a list of first or last names and retrieves Contacts having those names. Top-level caching to the VlocityAPIResponse partition improves Contact retrieval performance.
Create a Try-Catch Block Example (Managed Package): For the managed package runtime, an Integration Procedure creates and deletes a Contact with the specified LastName and returns an error message if the LastName is blank.
Create a Try-Catch Block Example: An Integration Procedure creates and deletes a Contact with the specified LastName and returns an error message if the LastName is blank.
Create a Try-Catch Block Example with a Formula (Managed Package): For the managed package runtime, an Integration Procedure finds Contacts with the specified Name and returns an error message if none are found. Because returning no records normally isn't considered a failure, the Omnistudio Data Mapper Extract Action within the Try-Catch Block includes a Failure Condition Formula.
Create a Try-Catch Block Example with a Formula: An Integration Procedure finds Contacts with the specified Name and returns an error message if none are found. Because returning no records normally isn't considered a failure, the Omnistudio Data Mapper Extract Action within the Try-Catch Block includes a Failure Condition Formula.
Create an Advanced List Merge Example (Managed Package): For the managed package runtime, the next Integration Procedure is a modified version of the previous example. Instead of matching list items using Id fields, it uses the Advanced Merge feature to match first and last names.
Create an Advanced List Merge Example: The next Integration Procedure is a modified version of the previous example. Instead of matching list items using Id fields, it uses the Advanced Merge feature to match first and last names.
Create an Authentication Provider to Connect to DocuSign: Add an authentication provider for Salesforce to create a secure connection to your DocuSign account. Omnistudio uses these credentials to fetch document templates from DocuSign.
Create an Example Test Procedure (Managed Package): For the managed package runtime, after you mock a response in the Integration Procedure to be tested, create the Test Procedure that tests a calculation it performs.
Create an Example Test Procedure: After you mock a response in the Integration Procedure to be tested, create the Test Procedure that tests a calculation it performs.
Create an Inclusion Rule for an Event Type (Managed Package): For the managed package runtime, a Vlocity Web Tracking Event Type can have an Inclusion Rule, which specifies a true-or-false condition that determines whether an event is sent to a third-party analytics vendor such as Google Analytics.
Create an Integration Procedure (Managed Package): For the managed package runtime, to create an Integration Procedure, you must name it, configure it, define its logic, and preview how it runs. You can also view debugging information and set options that apply only to previews.
Create an LWC Omniscript (Managed Package): For the managed package runtime, create an LWC Omniscript to use custom Lightning web components and functionality exclusive to LWC Omniscripts.
Create a Profile for an Omnistudio Standard User: Depending on how you configure roles and sharing rules, your Omnistudio user can access specific features that are restricted. We recommend that only users with the Omnistudio license have access to the designers and perform actions such as building business processes. After creating an Omnistudio user assigned to the Omnistudio license, create a profile to enforce this limitation.
Create a Profile for an Omnistudio Standard User: Depending on how you configure roles and sharing rules, your Omnistudio user can access specific features that are restricted. We recommend that only users with the Omnistudio license have access to the designers and perform actions such as building business processes. After creating an Omnistudio user assigned to the Omnistudio license, create a profile to enforce this limitation.
Create and Map Data Inside the Custom LWC Element (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health and Vlocity CME Summer '20, construct additional data JSON nodes in the Custom LWC element and pass values down from the element into the new JSON nodes using the omniaggregate event.
Create and Update Data from Omniscripts (Managed Package): For the managed package runtime, Omniscripts post data to Salesforce and external databases using Action elements that integrate Omnistudio Data Mappers, Integration Procedures, external calls, and Apex.
Create and Update Data from Omniscripts: After you’ve gotten new or changed data from other sources or users, you’ll likely need to update records in Salesforce or other data sources. As with getting data, Omniscripts can create or update records with various methods: Omnistudio Data Mappers, REST APIs, or Apex. You can also write data to a fillable PDF.
Create Contacts by Using a Loop Block: Use a Loop Block to iterate over a list provided in the input JSON, adding a Contact object for each element in the list.
Create Custom CSS Within the Flexcard Designer (Managed Package): For the managed package runtime, create custom CSS classes within the Flexcard Designer to apply to Flexcard elements or supported fields inside elements. Create custom CSS classes when the design interfaces in the Style panel do not meet your design needs.
Create an Email Action with Template: An Integration Procedure uses an Email Template and includes the email that's sent in the recipient's Activities list. No Email Templates exist by default, so this example includes steps for creating one.
Create Formula Fields in an Omniscript (Managed Package): For the managed package runtime, create expressions to set calculated values and evaluate data across multiple fields using a Formula or Aggregate element. For example, if you are accepting information for a qualifying life event you may want to create a formula that determines if the date entered for the qualifying life event is within thirty days of today's date.
Create Interface Objects (Managed Package): For the managed package runtime, you can make external data available to Omnistudio Data Mapper Loads using an interface object.
Match Records by Using Advanced Merge: Advanced Merge matches nodes with different names or at different levels in incoming lists. For example, instead of using a primary key that exists in both lists, you can match records based on first and last name.
Create Multi-Language Select Elements: Populate Select, Multi-select, and Radio elements for a multi-language Omniscript using custom configuration options.
Create New Profile Attribute Categories (Managed Package): For the managed package runtime, the type of attribute is defined at the Attribute Category level. Attributes Categories must created before you can add attributes to the category. Typically, Profile Attributes are used with Vlocity Intelligence and can be automatically assigned (see ).
Create New Profile Attributes (Managed Package): For the managed package runtime, attributes act like tags that provide more information about the entity in the profile. Typically, Profile Attributes are used with Vlocity Intelligence and can use attribute assignment rules. Product attributes are used with Policy Product Management.
Create Components Using Omnistudio Hybrid: Select the Managed Using Standard Designer option when creating Omnistudio components to build new components in the standard designer while you continue managing legacy components in the managed package designer.
Create Preprocessor Classes for Interface Objects (Managed Package): For the managed package runtime, to modify data before it is imported into an interface object, create an Apex class that implements the IDRPreprocess interface. This Apex interface runs before each insert to the Interface Object.
Create Responsive Elements on a Flexcard (Managed Package): For the managed package runtime, enable an element's width to change when the viewport updates. For example, make the widths of the fields for First Name and Last Name of a Contact take the full width of the page on smaller devices, but shrink to 50% on larger devices such as laptops and desktops.
Create Stateful LWC Omniscripts (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, enable LWC Omniscripts to store the state of an Omniscript in the URL.
Create the GoodStudentDiscountCalculation Calculation Procedure (Managed Package): For the managed package runtime, the GoodStudentDiscountCalculation calculation procedure calls the GoodStudentDiscountEligibility calculation matrix, which applies a 15% discount to a quoted amount for an Age between 16 and 24 and a GPA of 3.0 or greater.
Create the GoodStudentDiscountEligibility Calculation Matrix (Managed Package): For the managed package runtime, before you can create the Integration Procedure example with a Matrix Action, you must create the GoodStudentDiscountEligibility calculation matrix that it calls. This matrix returns a Qualified value of true for an Age between 16 and 24 and a GPA of 3.0 or greater.
Create the Integration Procedure with the Chatter Action (Managed Package): For the managed package runtime, after you collect the Ids needed for assembling a Chatter post, you can create an Integration Procedure that sends a Chatter post to a user. The example post includes text, an image, and mentions of two other users.
Create the Integration Procedure with the HTTP Action: After you configure NASA as a Remote Site and get a NASA API key, you can create and run the example Integration Procedure, which retrieves the astronomy picture of the day.
Create the Script Structure (Managed Package): For the managed package runtime, create the logic that executes when the script runs, by building a hierarchical structure of Actions and Steps.
Create the Script Structure (Managed Package): For the managed package runtime, create the logic that executes when the script runs, by building a hierarchical structure of Actions and Steps.
Create the Static Resource for an SDK Data Source on a Flexcard (Managed Package): For the managed package runtime, before you configure an SDK as a data source for your Flexcard, you need to add or create a static resource named OmniStudioActionRegistry that contains the configuration of the SDK that you want to use as a datasource in the Flexcard. The Flexcard looks for a file with that name in the static resource.
Create the TestReserializeApex Class: Before you can create the Integration Procedure example, you must create the TestReserializeApex Apex class that it calls.
Create the Visualforce Component for a Customer Story (Managed Package): For the managed package runtime, create the Visualforce component for a new Customer Story you want to add to a new page layout. For example, create the Visualforce component for a new Customer Story for the Opportunity object.
Creating a Card Layout Using Card Designer (Managed Package): For the managed package runtime, create a card layout to build visual components to your customer interactions by adding data, enabling actions, and using custom or Vlocity templates to determine the look and feel.
Creating a Custom Cards Apex Page (Managed Package): For the managed package runtime, to create a custom Cards Apex page, create a Visualforce Apex page, add your Angular app to the page, add some common scripts, and add your layout name.
Creating a Custom State Field (Managed Package): For the managed package runtime, you can create a custom State Field in the template for your layouts or cards by entering 'custom-type' into the supporting HTML for the template in the Template Designer, as follows:
Creating a Flyout (Managed Package): For the managed package runtime, create a flyout to display additional information about the record displayed on the card when you click the card. For example, a flyout can display information from long text strings that do not fit in the standard card field, or data from child records, such as open cases for an account, or additional actions.
Creating a Placeholder (Managed Package): For the managed package runtime, create placeholders in the Template Designer to insert additional fields into card states in the Card Designer. For example, to add a unique title for escalated case cards, select the card-active-placeholders-slds card template, and enter Escalated for the value of the Title placeholder.
Creating a Template with the Template Designer (Managed Package): For the managed package runtime, customize the layout of a card state or card layout by creating custom templates for Omniscript elements or Cards Framework components with the Vlocity Template Designer.
Creating an LWC Flyout (Managed Package): For the managed package runtime, flyouts in Vlocity Cards provide additional information about the record displayed on the card when you click the flyout. For example, a flyout can display information from long text strings that do not fit in the standard card field, or data from child records, such as open cases for an account, or additional actions.
Creating Custom Angular Templates for Adobe Experience Manager (Managed Package): For the managed package runtime, Omniscript is built on the AngularJS framework and leverages templates to display different elements and objects. Custom templates saved in Adobe Experience Manager can be used to replace specific instances of elements to tweak how they display and add additional functionality.
Creating Custom JavaScript and CSS for Adobe Experience Manager (Managed Package): For the managed package runtime, in Adobe Experience Manager, client-side code such as stylesheets and JavaScript are handled by a system of Client Libraries. To simplify customization, we have included a clientlib that is loaded by the Omniscript components. This removes the need for customers to create and manage custom Omniscript components manually for instance-wide customizations. This clientlib can be found at /apps/vloc/clientlibs/ooutCustom.
Creating Custom LWC Card Templates (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Creating Steps in an Omniscript (Managed Package): For the managed package runtime, when creating the structure for an Omniscript, Steps should be used to create each "page" of the form. Users can navigate through Steps using Next and Previous buttons. You can enable field validation for a Step, which means that all required fields on the Step must be completed in order to move forward. Conditionally display elements by applying conditional views to steps. This enables you to create one Omniscript that offers different experiences based on the user's responses.
Creating Zones (Managed Package): For the managed package runtime, zones enable you to arrange the information on a card layout into sections. Create zones in the Template Designer, add the zones to a layout in the Card Designer, then add cards or nested layouts inside the zones.
Creating, Editing, and Deleting Records with Default Actions and sObject Mapping (Managed Package): For the managed package runtime, add sObject Mapping functionality by adding Remote Actions to the Edit Block for each option you want to make available to the User. These Remote actions will access Apex classes built for the Edit Block and the sObject Mapping tool. The Default Actions use the sObject mapping property to determine how the entries map to an sObject.
Currency Properties (Managed Package): For the managed package runtime, Currency properties are configurable from the Properties panel when you select a Currency element. With the Currency element, enable users to enter a currency amount in an input field in your Omniscript.
Enable OAuth 2.0 With Custom Settings In Omnistudio for Managed Packages (Managed Package): For the managed package runtime, salesforce recommends the more secure OAuth 2.0 for DocuSign. We've introduced a custom implementation for you to switch from OAuth 1.0 to OAuth 2.0 authentication for Omniscripts using custom objects (OmniScript__c). If you’re setting up DocuSign for the first time, you don't need to change the custom settings. If OAuth 2.0 authentication isn’t loading or you’re still using OAuth 1.0, enable OAuth 2.0 with the custom settings.
Custom Input and Output for Omnistudio Data Mappers in Omnistudio: By default, Data Mappers handle JSON and XML data. To handle other data formats, you can configure a Data Mapper to use a custom input or output that you implement is a custom class. For example, you can define a Data Mapper Transform that accepts CSV-formatted data and outputs it as JSON.
Custom Input and Output for Omnistudio Data Mappers in Omnistudio for Managed Packages (Managed Package): For the managed package runtime, by default, Data Mappers handle JSON and XML data. To handle other data formats, you can configure a Data Mapper to use a custom input or output that you implement is a custom class. For example, you can define a Data Mapper Transform that accepts CSV-formatted data and outputs it as JSON.
Custom Lightning Web Component Properties (Managed Package): For the managed package runtime, custom Lightning Web Component element properties are configurable from the Properties panel when you select the element. With the Custom Lightning Web Component element, embed a custom Lightning web component into your Omniscript.
Custom LWC Element (Managed Package): For the managed package runtime, add a custom Lightning web component that does not extend an Omniscript element component to an Omniscript using the Custom LWC element.
Custom LWC Element: Add a custom Lightning web component that does not extend an Omniscript element component to an Omniscript using the Custom LWC element.
Customizable Style Guide for Newport Design System (Managed Package): For the managed package runtime, Vlocity's customers have their own set of brand guidelines and design specifications, particularly for customer-facing applications. The Vlocity Omniscript and Cards Designers allow you to choose between two templates:
Newport Design System: Use the Newport Design System to design, customize, and preview your Omniscripts directly within the designer canvas without switching between design and preview modes. The system offers Newport and Newport Storybook themes in addition to the existing Lightning theme. The Newport theme is available in the designer canvas and preview alongside the Lightning theme. The Newport Storybook theme is available only in the designer preview, alongside the Newport and Lightning themes. Previously, the Omniscript Designer canvas supported only the Lightning theme, while preview mode supported both Newport and Lightning.
Customize Omniscript Error Messages (Managed Package): For the managed package runtime, the error message handler enables you to replace default error messages from remote apex calls with more user-friendly error messages when errors occur in Omniscript. The Error Messages handler property is available in File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.
Customize Omniscript Error Messages: The error message handler enables you to replace default error messages from remote apex calls with more user-friendly error messages when errors occur in Omniscript. The Error Messages handler property is available in File elements, Image elements, all Action elements, and Setup.
Customize SLDS Design Tokens in Omniscript (Managed Package): For the managed package runtime, modify the appearance of an Omniscript by overriding Salesforce's SLDS Design tokens. Omniscript elements use SLDS Design Tokens for styling. Override tokens that have global access to modify the appearance of your Omniscript.
Customize the Step Chart Component (Managed Package): For the managed package runtime, add customizations to your Step Chart by extending the Step Chart Lightning web components, the StepChart component, and the Step Items component.
Data Deployment with the Omnistudio Build Tool (Managed Package): For the managed package runtime, the Omnistudio Build Tool (formerly Vlocity Build Tool or VBT) is a Node.js command-line automation tool that packages and deploys Salesforce data packs in a source-control-friendly format. The tool creates a YAML (YAML Ain’t Markup Language) manifest that describes a deployment project. The Build Tool enables continuous integration of Omnistudio metadata to source control.
Data Deployment with Data Packs (Managed Package): For the managed package runtime, a data pack is a collection of components and related functionality that are packaged for deployment between orgs. For example, you can use data packs to deploy functionality from a sandbox environment to a production environment.
Omnistudio Data Mapper Basics (Managed Package): For the managed package runtime, a Data Mapper moves Salesforce data into and out of applications. There are four types: Extract, Turbo Extract, Transform, and Load. Data Mappers enable you to read and write data to and from your Salesforce org.
Omnistudio Data Mapper Calls From Apex (Managed Package): For the managed package runtime, to call a Data Mapper from Apex, call the vlocity_ins.DRGlobal.processObjectsJSON() method, specifying the name of the Data Mapper and the input data that it requires.
Omnistudio Data Mapper Calls From Apex: Starting with Summer’ 25, to call a Data Mapper from Apex, call the ConnectApi.OmniDesignerConnect.executeDataMapper(bundleName, apexInput) Connect API specifying the name of the Data Mapper and the input data that it requires. This API replaces the vlocity_ins.DRGlobal.processObjectsJSON() method. This Connect API removes the dependency on the managed package and provides up to 60% better performance for Data Mapper calls from an Apex class compared to the previous method.
Omnistudio Data Mapper Extract Action (Managed Package): For the managed package runtime, invoke a Data Mapper Extract to retrieve data from one or more related Salesforce objects. You can also use formulas and complex field mappings.
Omnistudio Data Mapper Extract Examples (Managed Package): For the managed package runtime, Data Mapper Extract examples demonstrate object relationships, paging with data values, paging with offsets, working with attributes, and relationship notation.
Omnistudio Data Mapper Extract Examples: Data Mapper Extract examples demonstrate object relationships, paging with data values, paging with offsets, and relationship notation.
Omnistudio Data Mapper Extract Output (Managed Package): For the managed package runtime, to map data from the extraction step JSON to the output JSON, go to the Output tab. You can also handle null values, attributes, translations, field-level permissions, caching, and list transforms.
Omnistudio Data Mapper Extract Overview (Managed Package): For the managed package runtime, Data Mapper Extracts read Salesforce data and return results in JSON, XML, or custom formats. You can filter the data and select the fields to return. Formulas, attributes, default values, and translations are supported. Extracts typically provide Omniscripts, Integration Procedures, and Cards with the data they require.
Omnistudio Data Mapper Load Overview (Managed Package): For the managed package runtime, Data Mapper Loads accept data in JSON, XML, or custom input formats and write the data to Salesforce objects. Formulas and attributes are supported.
Omnistudio Data Mapper or Integration Procedure? (Managed Package): For the managed package runtime, Data Mappers read or write Salesforce SObject data or perform single-step data structure transformations. Integration Procedures can interact with many types of data, including REST APIs and Apex classes, and process it in multiple steps. For some use cases, a single Data Mapper is sufficient. Integration Procedures usually call one or more Data Mappers and are more flexible and powerful. Use these guidelines to help you determine which to build.
When to Use Omnistudio Data Mappers and Integration Procedures: Omnistudio Data Mappers read or write Salesforce SObject data or perform single-step data structure transformations. Omnistudio Integration Procedures can interact with many types of data, including REST APIs and Apex classes, and process it in multiple steps. For some use cases, a single Data Mapper is sufficient. Integration Procedures usually call one or more Data Mappers and are more flexible and powerful. Use these guidelines to help you determine which to build.
Omnistudio Data Mapper Output Data Types (Managed Package): For the managed package runtime, many data types can be assigned to data in the Output JSON, including boolean, currency, string, various number and list types, and date formats.
Omnistudio Data Mapper Output Data Types: Many data types can be assigned to data in the Output JSON, including boolean, currency, string, various number and list types, and date formats.
Omnistudio Data Mapper REST API (Managed Package): For the managed package runtime, you can invoke any type of Data Mapper using the Data Mapper REST API. To update Salesforce objects using a Data Mapper Load, issue a POST request that includes a JSON payload that is formatted to comply with the input that the Data Mapper load expects. To retrieve data from Salesforce, issue a GET call to a Data Mapper Extract, specifying the Id or parameters identifying the data to be retrieved. The data is returned in the response in JSON format.
Omnistudio Data Mapper REST API: You can invoke any type of Data Mapper using the Data Mapper REST API. To update Salesforce objects using a Data Mapper Load, issue a POST request that includes a JSON payload that is formatted to comply with the input that the Data Mapper load expects. To retrieve data from Salesforce, issue a GET call to a Data Mapper Extract, specifying the Id or parameters identifying the data to be retrieved. The data is returned in the response in JSON format.
Omnistudio Data Mapper Transform Action (Managed Package): For the managed package runtime, invoke a Data Mapper Transform to restructure, rename, and convert data. Unlike Data Mapper Extracts and Loads, Transforms do not read or write Salesforce data.
Map Inputs and Outputs for Transformations: To map data from the input to the output, go to the Transform tab. If you're using the designer on a managed package, go to the Output tab. You can also handle null values, data types, caching, and list transforms.
Omnistudio Data Mapper Transform Examples (Managed Package): For the managed package runtime, Data Mapper Transform examples demonstrate how to convert a single item into a list with one item and how to convert a list of objects to a list of values.
Omnistudio Data Mapper Transform Examples: Data Mapper Transform examples demonstrate how to convert a single item into a list with one item and how to convert a list of objects to a list of values.
Omnistudio Data Mapper Transform Overview (Managed Package): For the managed package runtime, Data Mapper Transforms let you perform intermediate data transformations without reading from or writing to Salesforce. Formulas are supported.
Omnistudio Data Mapper Turbo Action (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, Invoke a Data Mapper Turbo Extract to retrieve data from a single Salesforce object. Unlike a standard Data Mapper Extract, a Data Mapper Turbo Extract doesn't support formulas or complex field mappings.
Omnistudio Data Mapper Turbo Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Data Mapper Extract Actions. A Data Mapper Turbo Action calls the specified Data Mapper Turbo Extract to read data from Salesforce and returns it to the Integration Procedure.
Omnistudio Data Mapper Turbo Extract Overview (Managed Package): For the managed package runtime, a Data Mapper Turbo Extract retrieves data from a single Salesforce object type, with support for fields from related objects. You can filter the data and select the fields to return. Unlike a standard Data Mapper Extract, a Data Mapper Turbo Extract doesn't support formulas. There’s no Output tab, so you can't use mappings to structure the output. Custom JSON, default values, attributes, and translations aren't supported.
Omnistudio Data Mappers (Managed Package): For the managed package runtime, a Data Mapper is a mapping tool that enables you to read, transform, and write Salesforce data. There are four types of Data Mapper: Turbo Extract, Extract, Transform, and Load.
Date Properties (Managed Package): For the managed package runtime, Date properties are configurable from the Properties panel when you select a Date element. With the Date element, enable users to select a date from a date picker in your Omniscript.
Date/Time Properties (Managed Package): For the managed package runtime, Date/Time properties are configurable from the Properties panel when you select a Date/Time element. With the Date/Time element, enable users to select a date from a date picker and a time from a dropdown list in your Omniscript.
Debug Flexcard Action and Event Requests and Responses (Managed Package): For the managed package runtime, view your Flexcard's action and event requests and responses from the Action Debugger in the Flexcard Designer's Preview tab. Click an actionable item to display its debug log and associated events. Debug before publishing your Flexcard to a Salesforce page or third-party application.
Declarative Calculation Procedures (Managed Package): For the managed package runtime, declarative calculation procedures are a key component of the ratings engine. Along with calculation matrices, calculation procedures are the key components of any or ratings engine. Calculation procedures take an input JSON and run through a series of matrix lookups (calling values from calculation matrices) and calculations to calculate ratings for policy products.
Define Custom Label Translations in Multi-Language Omniscripts: Define translations in various languages for custom labels in multi-language Omniscripts. Create localized content so that users see the Omniscripts in the language based on their locale. Create custom labels in English first, followed by translations for other languages.
Define Execution Logic Using Conditional Blocks (Managed Package): For the managed package runtime, a Conditional Block executes in its entirety if an expression is true, executes one of a set of mutually exclusive conditions defined in the steps it contains, or both.
Define Execution Logic: Define conditional flow in Integration Procedures by using the Execution Conditional Formula field on an action or block, or by using a Conditional Block to compose a series of mutually exclusive conditions.
Define Metadata Values from the Flexcard Designer (Managed Package): For the managed package runtime, define the metadata values for the generated Flexcard LWC from the Flexcard Designer. When your Flexcard is active, use the Publish Options feature to configure API Version, Targets, Description, and other metadata values from a GUI or code editor.
Define Metadata Values from the Flexcard Designer: Define the metadata values for the generated Flexcard LWC from the Flexcard Designer. When your Flexcard is active, use the Publish Options feature to configure API Version, Targets, Description, and other metadata values from a GUI or code editor.
Define the Initial Extraction (Managed Package): For the managed package runtime, on the Extract tab, you specify the Salesforce objects to be queried and the filters that determine the data to be returned from the object. You can also specify a limit and offset for paging or a field on which to sort.
Configure an Omnistudio Data Mapper Extract: Configure a Data Mapper Extract by specifying the object and filters. To enhance the performance of the Data Mapper Extract, you can define formulas, add fields to write data to, create mappings, and configure additional properties.
Delete a Flexcard (Managed Package): For the managed package runtime, delete a Flexcard from the Flexcards home tab in your org. Once deleted it cannot be retrieved.
Delete Action (Managed Package): For the managed package runtime, enable users to delete one or more sObject records by using the Delete Action. Use an Object's Record Id to determine which record to delete. Vlocity recommends using a merge field in the Path to Id field that refers to an Id or a list of Ids in the data JSON.
Delete an Object Record from an Omniscript: Enable users to delete one or more sObject records by using the Delete Action. Use an Object's Record Id to determine which record to delete. The best practice is to use a merge field to refer to an Id or a list of IDs in the data JSON.
Delete Action: Enable users to delete one or more sObject records by using the Delete Action. Use an Object's Record Id to determine which record to delete. Vlocity recommends using a merge field in the Path to Id field that refers to an Id or a list of Ids in the data JSON.
Deployment of Omnistudio for Managed Packages Components Between Orgs (Managed Package): For the managed package runtime, for your projects that use Omnistudio for Managed Packages, move the components and metadata from one org to another by using the Build Tool (formerly known as Vlocity Build Tool or VBT) or IDX Workbench. For simple use cases, you can move objects between orgs by exporting and importing data packs.
Deploy Global Style Changes to Flexcards with the Newport Design System (Managed Package): For the managed package runtime, add any changes to the Newport Design System theme by uploading the theme in a Salesforce org. Install your theme so that all Flexcard designer users can use it to preview their Flexcards. Apply modifications to the Newport templates by adding a Static Resource that overrides the Newport preview wherever it is available.
Deploy Lightning Web Components (Managed Package): For the managed package runtime, deploy new Lightning web components or change existing components from your local development environment with Visual Studio and Salesforce DX or IDX Workbench.
Deploy Lightning Web Components: Deploy new Lightning web components or change existing components from your local development environment with Visual Studio and Salesforce DX or IDX Workbench.
Deploy OmniOut to Adobe Experience Manager (Managed Package): For the managed package runtime, add your AEM credentials to OmniOut and deploy it to your AEM server. The deployment adds a Vlocity LWC OmniOut component to AEM. The Vlocity LWC OmniOut component allows you to add your Omniscripts to an AEM page.
Deployment of Omnistudio Components Between Orgs: For your projects that use Omnistudio tools, and when you’re on Omnistudio standard runtime with standard objects, use Salesforce CLI to move the components and metadata from one org to another org.
Deploying Omnistudio Components Between Orgs or Migrating from Omnistudio for Managed Packages (Managed Package): For the managed package runtime, deployment means moving Omnistudio components from one org to another, whether you use Omnistudio for Managed Packages or Omnistudio. Migration means migrating your data from the Omnistudio for Managed Packages custom data model to the Salesforce standard data model and switching to the Salesforce standard runtime. Omnistudio migration includes migration of Omnistudio metadata only.
Tool Considerations for Deploying Omnistudio Components: Select the tool for deploying components based on what you’re deploying, the data model used in the source and target orgs, and the Omnistudio runtime used in the source and target orgs. The source and target orgs can be sandboxes, development orgs, or production orgs.
Deploying an Omniscript (Managed Package): For the managed package runtime, Vlocity Omniscripts can be deployed within the Vlocity application, or within an iFrame either on a Salesforce Community or an external website. Once embedded within the page, the script can be versioned, modified, and activated without the need to reconfigure the page.
Deploying Omniscripts Off-Platform with OmniOut (Managed Package): For the managed package runtime, deploy Omniscripts to AEM, Heroku, and other Cloud Application Platforms to run them outside of the Salesforce platform. AEM, Heroku, and other Cloud Application Platforms connect with Salesforce through Salesforce Cloud Authentication Components or via a Salesforce Connected App.
Deploying Omniscripts to Cloud Application Platforms (Managed Package): For the managed package runtime, Cloud Application Platforms host Omniscripts by connecting to Salesforce as a Connected App or as a standalone app. In the example Heroku deployment below, steps that are not exclusive to Heroku can be applied to most Cloud Application Platform deployments.
Deploying the Cards Framework to a Heroku Web Server (Managed Package): For the managed package runtime, this topic assumes you have a Heroku server deployed and know how to upload resources to it using development tools such as FTP and Git. It also assumes that you understand AngularJS and HTML5.
Omnistudio Standard Designer: In addition to the managed package designer, Omnistudio offers a standard designer for Flexcards, Omniscripts, Integration Procedures, and Data Mappers in the standard runtime. The standard designer provides ease of navigation and improved performance. All the existing elements and configurations from the managed package designer are available in the standard designer.
Designing and Styling Omniscript (Managed Package): For the managed package runtime, this section explains how to edit the look and feel of your Omniscripts. Design and style your Omniscript by overwriting an element's HTML template, customizing which steps in the form to display, or using images for buttons.
Differences Between Lightning and TinyMCE Rich Text Editors: Omnistudio integrates the TinyMCE editor in the standard designer and managed package designer. However, you can switch to Lightning Rich Text Editor, if needed. Review the key differences between these editors. Before implementing any use cases with the Lighting Rich Text Editor, contact Salesforce Customer Support.
Differences Between Omnistudio and Omnistudio for Managed Packages (Managed Package): For the managed package runtime, Omnistudio and Omnistudio for Managed Packages differ in a few ways, but the key differences are the data models, the features available in each, and how you access each suite depending on your org licenses. Think of Omnistudio and Omnistudio for Managed Packages as two versions of an application suite, not two types of packages. While Omnistudio uses the standard object model, Omnistudio for Managed Packages uses the custom object model. That difference is why the two versions don’t have exactly the same features.
Disable Enhanced Profile User Interface (Managed Package): For the managed package runtime, enable the appropriate interface before configuring Community profile settings that ensure that your users see Flexcards on Experience Builder site. Use the Original Profile Interface.
Disable Platform Cache (Managed Package): For the managed package runtime, disable caching across the Vlocity Cards Framework to get the latest available data directly from the database. Cards, card layouts, templates,custom labels, and profile data load from the VlocityMetadata partition of the Platform Cache when the card is active and viewed from a record page or a community page by the end-user.
Disable Platform Cache for Flexcards in Omnistudio: To get the latest available data from the database, disable caching for all Flexcards in Omnistudio. Flexcards, custom labels, and profile data load from the VlocityMetadata partition of the Platform Cache when the card is active and viewed from a record page or a community page by the end user.
Disable Preload on Conditional Elements (Managed Package): For the managed package runtime, improve performance on Flexcards with conditional elements by removing hidden elements from the Document Object Model (DOM), or the rendered HTML. By default, all elements on a Flexcard are preloaded, which means they’re added to the DOM and then, if the condition is false, are hidden with CSS. The element's HTML is still rendered.
Disable Record Looping on a Flexcard (Managed Package): For the managed package runtime, to display data that doesn't need repeating in a Chart or Datatable, disable the Repeat Records feature. For example, disable the feature to display a Chart element that displays data from multiple Accounts or a Datatable element that lists Account Cases.
Disable User Information Caching (Managed Package): For the managed package runtime, disable user information caching in the session cache. The Vlocity Cards Framework keeps stored user profile data on the VlocityMetadata partition of the Platform Cache. The Cards.UserTrigger caches the user after user information updates, and removes the cached user after the user is disabled or deleted.
Disable User Information Caching for Flexcards in Omnistudio: Disable user information caching in the session cache for Flexcards in Omnistudio. Flexcards keep stored user profile data on the VlocityMetadata partition of the Platform Cache. The Cards.UserTrigger caches the user after their information updates, and removes the cached user after the user is disabled or deleted.
Disclosure Properties (Managed Package): For the managed package runtime, disclosure properties are configurable from the Properties panel when you select a Disclosure element. With the Disclosure element, enable users to read a disclosure statement and select a checkbox to indicate agreement.
Display Inline Omniscripts on Lightning and Community Pages (Managed Package): For the managed package runtime, enable LWC Omniscripts to run inline without leaving the context of a page. An inline Omniscript renders as a button that, when clicked, launches the Omniscript inline. The record id of a page passes into an inline Omniscript as a Context Id automatically. You can render more than one inline Omniscript on a page beginning in Vlocity Insurance and Health Summer '20 and CME Fall '20 .
Display Messages in Omniscripts (Managed Package): For the managed package runtime, display comments, requirements, and success and warning messaging depending on whether the validate expression returns True or False. Configure the Messaging element after creating an element, such as a formula or aggregate, to display validation messages in the OmniScript. Merge fields are supported in messages.
Display Messages in Omniscripts: Display comments, requirements, and success and warning messaging depending on whether the validate expression returns True or False. Configure the Messaging element after creating an element, such as a formula or aggregate, to display validation messages in the OmniScript. Merge fields are supported in messages.
Display Records Side-By-Side on a Flexcard (Managed Package): For the managed package runtime, display records side-by-side instead of stacked on top of each other by embedding a child Flexcard and adjusting the widths of its states. By default, records display one on top of the other regardless of the widths of individual elements in the Flexcard.
Display Sprites in an Edit Block (Managed Package): For the managed package runtime, display Sprites to indicate information about an Edit Block record entry using the Default Svg Sprite and Default Svg Icon properties. For example, a User icon can indicate if the entry is a Contact record. Omnistudio supports the Lightning Design System icons. To dynamically display different sprites, map values of the SVG Controlling Element to SLDS icons in the SVG Controlling Element Map.
Display Sprites in an Edit Block: Display Sprites to indicate information about an Edit Block record entry using the Default Svg Sprite and Default Svg Icon properties. For example, a User icon can indicate if the entry is a Contact record. Omnistudio supports the Lightning Design System icons. To dynamically display different sprites, map values of the SVG Controlling Element to SLDS icons in the SVG Controlling Element Map.
Displaying Conditional Actions on a Card (Managed Package): For the managed package runtime, you can use conditions to show or hide actions on a card based on the card data. For example, you can have a card display one set of actions for a Policy card when the Status is New, and a different set when the Status is not New. To do this, clone a state on the card, modify the actions, and use conditions to determine when to display each state.
Does Your Org Use Custom or Standard Objects? (Managed Package): For the managed package runtime, to determine whether your org uses Omnistudio standard objects or Omnistudio for Managed Packages custom objects, go to Setup and find Omni Interaction Configuration.
Done Action (Managed Package): For the managed package runtime, the Done Action ends the Omniscript and returns the user either to where the script was launched or a custom URL. This page explains the settings to configure for the Done Action.
Download Flexcard Sample Data Packs (Managed Package): For the managed package runtime, download sample Flexcard data packs with configured Flexcard elements and settings to import into your org. For example, download a Flexcard data pack that displays how to pass data from a parent Flexcard to a child Flexcard.
Download the OmniOut Static Resource (Managed Package): For the managed package runtime, download the OmniOut Static Resource from your Salesforce Org. The OmniOut static resource includes JS, HTML, CSS, and other files necessary for Omniscripts and Flexcards to run outside of Salesforce.
DRGlobal Class and Methods: Use the ConnectApi.OmniDesignerConnect.executeDataMapper(bundleName, apexInput) Connect API to call Data Mappers from Apex through the DRGlobal Apex class. Starting with Summer ’25, replace the existing methods in the DRGlobal Apex classes with the Connect API.
Dynamically Update Remote Site Settings for Flexcards (Managed Package): For the managed package runtime, dynamically grant access to your org domains to enable LWC features such as Preview. When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the Remote Site Settings page in your org does not include the URLs required. The required URLs are your org's lightning.force.com URL and the vf.force.com URL of the Visualforce page that contains the Flexcard Designer.
Edit Block (Managed Package): For the managed package runtime, create, edit, and delete multiple Salesforce or external records on one page by using an Edit Block. For example, if you're collecting an Account's Contact information, you can add an Edit Block to your Omniscript to enable users to add a record for each Contact.
Manage Records with an Edit Block: Create, edit, and delete multiple Salesforce or external records on one page using Edit Block. For example, if you're collecting an Account's Contact information, you can add an Edit Block to your Omniscript to enable users to add a record for each Contact.
Edit Matrix Headers (Managed Package): For the managed package runtime, you can change the names and data types of the column headers in a calculation matrix.
Edit the Tracking Manager Component (Managed Package): For the managed package runtime, to use a third-party analytics vendor, the first step is to clone the Visualforce page for the Tracking Manager and add third-party code to it.
Edit User Profiles to Enable OmniAnalytics Access (Managed Package): For the managed package runtime, in the Salesforce Winter '21 release, a critical update enforces user profile restrictions for Apex classes that Aura and Lightning Web Components use. To configure OmniAnalytics, users must have permission in their profiles or permission sets to access the FetchStaticResourceUrl and OmniAnalyticsController Apex classes.
Email Action (Managed Package): For the managed package runtime, the Omniscript Email Action uses the Salesforce Email API to either send an email template to the email address of a User, Lead, or Contact or to send an email body defined in the action configuration to any email address.
Sending Email from Omniscripts: Use emails to send alerts or notifications as part of a workflow, such as sending a summary of a customer’s changes to their account information or a report of new customer cases to agents. An Omniscript can send an email from a template or a custom message, and you can use data from Salesforce objects or other data sources in the email address or body fields.
Email Action for Integration Procedures: An Email Action sends the specified email. You can either specify all the email field values or use a Salesforce email template.
Email Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Email Actions. An Email Action sends a specified email. You can specify all the email field values or use a Salesforce email template.
Email Properties (Managed Package): For the managed package runtime, Email properties are configurable from the Properties panel when you select an Email element. With the Email element, enable users to enter an email address in your Omniscript.
Emailing an Omniscript (Managed Package): For the managed package runtime, to email a link to an Omniscript to a Contact, Lead, or User, you create an Integration Procedure that uses a remote action to send the email and call the Integration Procedure from an Omniscript or from Apex code.
Emailing an Omniscript: To email a link to an Omniscript to a Contact, Lead, or User, you create an Integration Procedure that uses a remote action to send the email and call the Integration Procedure from an Omniscript or from Apex code.
Embed a Custom Lightning Web Component: Embed components to which you add custom styling and functionality. For example, embed an existing carousel component in a Flexcard and then configure its attributes.
Embed an Omniscript in Another Omniscript (Managed Package): For the managed package runtime, an Omniscript can be reused in one or more existing Omniscripts. Reusing Omniscripts enables you to build a variety of smaller scripts and then piece them together into one or more parent scripts. Embedded Omniscripts behave just like other Omniscript elements.
Embed an Omniscript in Another Omniscript: An Omniscript can be reused in one or more existing Omniscripts. Reusing Omniscripts enables you to build a variety of smaller scripts and then piece them together into one or more parent scripts. Embedded Omniscripts behave just like other Omniscript elements.
Embed Flexcard Inside Another Flexcard (Managed Package): For the managed package runtime, embed a reusable Flexcard as a child inside another Flexcard. The child Flexcard can have its own data source. Or, the parent can override the child's data source with its own data source. The parent can also pass specific data to the child, such as its recordId to use as the child's contextId.
Embed Flexcard in a Flexcard: Share data between Flexcards by embedding a Flexcard as a child in another Flexcard. The child Flexcard can have its data source, or the parent can override the child's data source with its own data source. The parent can also pass specific data to the child, such as its record ID to use as the child's context ID.
Embed Flexcards in an LWC Omniscript (Managed Package): For the managed package runtime, embed a Flexcard Lightning Web Component in an Omniscript by using the Custom LWC element. Flexcards can receive data from the LWC Omniscript and perform any action available in the Flexcard.
Embed Flexcards in an Omniscript: Embed a Flexcard Lightning Web Component in an Omniscript by using the Custom LWC element. Flexcards can receive data from the Omniscript and perform any action available in the Flexcard.
Embed the Component (Managed Package): For the managed package runtime, copy the Omniscript component tag and embed it in a Lightning Web Component.
Embedding a Reusable Omniscript (Managed Package): For the managed package runtime, you can embed active reusable Omniscripts in other Omniscripts. For example, if you have an Omniscript that updates a case, you might want to add that reusable script component at the end of an Omniscript form used for troubleshooting.
Embedding a Vlocity Lightning Web Component Inside an LWC Card State (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, LWC Cards support embedding any Vlocity Lightning Web Component, such as an LWC Omniscript, an LWC enabled card, or any other custom LWC, inside an LWC Card state and setting the attributes of the embedded component.
Enable and Disable Data Sources (Managed Package): For the managed package runtime, enable and disable data source types for an org, profile, or user level from the Card Framework Configuration custom setting. For example, disable Apex REST, Apex Remote, and other complex data sources for your entire org, or prevent system admins with limited permissions from using these data sources.
Enable and Disable Data Sources: Enable and disable data source types for an org, profile, or user level from the Card Framework Configuration custom setting. For example, disable Apex REST, Apex Remote, and other complex data sources for your entire org, or prevent system admins with limited permissions from using these data sources.
Enable Error Logging (Managed Package): For the managed package runtime, in Winter '20 and later releases, you can write Integration Procedure errors to Vlocity Error Log Entry SObject records by setting ErrorLoggingEnabled to true. ErrorLoggingEnabled is a Custom Setting under General Settings.
View, Modify, and Enable Fast Activation on Omnistudio Content: When you disable the Managed Package Runtime setting, you can view and modify standard Omnistudio content that ships with your Salesforce Industries license from the designers. You also enable faster Omniscript and Flexcard activation.
Enable Multi-Language Support on a Flexcard (Managed Package): For the managed package runtime, enable multi-language support on a Flexcard from the Flexcard Designer. When the multi-language support feature is on, all custom labels are updated and not cached.
Enable OmniAnalytics and Store Tracking Data (Managed Package): For the managed package runtime, to enable OmniAnalytics, you must first allocate space in the VlocityMetadata partition of the Platform Cache. Then you must configure custom settings that determine whether OmniAnalytics is enabled and whether OmniAnalytics data is stored in VlocityTrackingEntry__c object records, VlocityTrackingEvent__e platform events, or both.
Enable Omniscript Support on a Flexcard (Managed Package): For the managed package runtime, enable the Omniscript Support feature when your Flexcard interacts with an LWC Omniscript. For example, render a Flexcard inside an Omniscript with the Omniscript Designer's Custom LWC element. Or update an Omniscript with the Update Omniscript action element.
Enable Omnistudio Metadata API Support: To deploy and retrieve Omnistudio standard objects with Salesforce Metadata API, enable the Omnistudio Metadata setting. Until you enable this setting, you can't use Metadata API to deploy Omnistudio components. Future enhancements will depend on this setting and completion of the migration. After this setting is enabled, Omnistudio checks for valid unique names and creates entries for existing components from the standard objects in the Omnistudio configuration tables. Also, for each new component, Omnistudio creates an entry in the Omnistudio configuration tables. Omnistudio Metadata supports OmniProcess (Omniscript and Integration Procedure), OmniDataTransform (Omnistudio Data Mapper), and OmniUiCard (Flexcard) standard objects. This setting doesn't apply to Omnistudio custom objects.
Enable or Disable Data Sources For a Profile or User (Managed Package): For the managed package runtime, manually enable or disable a data source for a specific profile or user from Custom Settings in your org. For example, prevent system admins with limited permissions from using more complex data sources like an Apex REST or Apex Remote.
Enable SEO for LWC Omniscripts (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, make Omniscripts in Communities appear in online searches by enabling SEO.
Enable the Omnistudio Standard Designer: The standard designer is available to new and existing users by default, depending on the Omnistudio license and version in your Salesforce org. If necessary, you can switch to the managed package designer. However, if you switch to the managed package designer, you can't edit components that are created or modified using the standard designer.
Disable the Managed Package Runtime and Deploy Custom Lightning Web Components: If you migrate from Omnistudio for Managed Packages to Omnistudio, disable the Managed Package Runtime setting. Before you disable this setting, ensure that all Flexcards and Omniscripts in use that are key to your business processes are supported in standard objects. If you add or edit an Omniscript or Flexcard after disabling this setting and use custom components to load these Omniscripts or Flexcards in Lightning App Builders and communities, the changes won’t be reflected unless you replace them with standard components. To update your existing Flexcards and Omniscripts in Lightning App Builders and communities without using the standard components, enable the Deploy Custom Lightning Web Components setting.
Enable Tracking on a Flexcard (Managed Package): For the managed package runtime, enable user interaction tracking from a Flexcard action or child Flexcard element to publish tracked data with OmniAnalytics. The tracking feature sends tracked information from the Flexcard element to the Vlocity Tracking Service, which is then published by OmniAnalytics.
Enhance Performance Using Cache Blocks (Managed Package): For the managed package runtime, using a cache to store frequently accessed, infrequently updated data saves round trips to the database and improves performance. Use Cache Blocks if some parts of the Integration Procedure update data, or if you need different cached data to expire at different times. For example, current weather data changes more frequently than user session data.
Enhance Performance by Using Cache Blocks: Use Cache Blocks if some parts of the Integration Procedure update data, or if you need different cached data to expire at different times. For example, current weather data changes more frequently than user session data.
Error Handling in Integration Procedures (Managed Package): For the managed package runtime, you can configure the conditions for success or failure of an Integration Procedure action or group of actions. You can also configure error logging.
Access to Data Within and Outside a Repeatable Block (Managed Package): For the managed package runtime, suppose you place an element in a repeatable block (a Block or an Edit Block) and you want to access data that is calculated in a different element. The method that you use to access the data depends on whether the element containing the data is within or outside the same repeatable block in the Omniscript. Review guidelines and examples for the Formula element and for the Select element, which is used to add a dependent picklist to an Omniscript.
Access to Data Within and Outside a Repeatable Block: Suppose you place an element in a repeatable block (a Block or an Edit Block) and you want to access data that is calculated in a different element. The method that you use to access the data depends on whether the element containing the data is within or outside the same repeatable block in the Omniscript. Review guidelines and examples for the Formula element and for the Select element, which is used to add a dependent picklist to an Omniscript.
Guidelines for Accessing Select Element Data in Repeatable Blocks: When you use a Select element within a repeatable block, review guidelines and examples for accessing data within or outside the same repeatable block. The Select element is used with Salesforce dependent picklists.
Guidelines for Accessing Select Element Data in Repeatable Blocks (Managed Package): For the managed package runtime, when you use a Select element within a repeatable block, review guidelines and examples for accessing data within or outside the same repeatable block. The Select element is used with Salesforce dependent picklists.
Event Tracking Data for Cards Framework (Managed Package): For the managed package runtime, for the Cards Framework, events tracked are OmniAnalytics Card Events, initTracking, initCardFramework, initLayout, selectCard, performAction, trackField, and Resolution.
Event Tracking for Custom Fields (Managed Package): For the managed package runtime, for Integration Procedures and Omniscripts, you can add your own custom fields to the data stored by the Tracking Service. In Summer '20 and later releases, you can add custom fields to Flexcards as well.
Example (Managed Package): For the managed package runtime, in the Troubleshooting Omniscript, the callOut1 Remote Action element calls an external system to check if the asset is still under warranty.
Example: Update Data Field Based on Value Entered by User: Bind two input elements to the same data field on a Flexcard's data source so that when a user updates one element's value, the other element's value updates to match. This example uses a SOQL query data source that returns Account names, and shows how a value entered in a Text Input element flows through to a Text Area Input element bound to the same field.
Examples of Omnistudio Data Mappers: For each type of Data Mapper, examples show how they’re set up for specific, common uses. Each example provides sample JSON for input. Each shows the setup for input, output, mapping, query, and formula, as they apply to the Data Mapper type and the use case.
Export a Flexcard (Managed Package): For the managed package runtime, export a Flexcard as a data pack to import to other environments. You can export one or more Flexcards from the Flexcards home tab or from within the Flexcard Designer.
Export and Import Omniscripts: Export or import Omniscripts to use them in another org, such as when you create them in a sandbox or to use sample data packs that Salesforce provides. When exporting or importing data packs for Omniscripts, if you encounter Apex limit errors such as heap or CPU limits, reduce the size of the data pack by unselecting dependencies during the export process. Additionally, break the data pack into multiple smaller data packs. As a best practice, we recommend including no more than 10 elements in each data pack.
Export or Import an Omnistudio Data Mapper: Export or import Data Mappers to use them in another org, such as when you create them in a sandbox. When exporting or importing data packs for Data Mappers, if you encounter Apex limit errors such as heap or CPU limits, reduce the size of the data pack by unselecting dependencies during the export process. Additionally, break the data pack into multiple smaller data packs. As a best practice, we recommend including no more than 10 elements in each data pack.
Export or Import an Omnistudio Integration Procedure: Export or import Integration Procedures to use them in another org, such as when you create them in a sandbox. When exporting or importing data packs for Integration Procedures, if you encounter Apex limit errors such as heap or CPU limits, reduce the size of the data pack by unselecting dependencies during the export process. Additionally, break the data pack into multiple smaller data packs. As a best practice, we recommend including no more than 10 elements in each data pack.
Exporting Omniscripts (Managed Package): For the managed package runtime, Omniscripts can be exported using the new Data Pack feature. This allows you to move Omniscripts from one environment to another.
Exporting Vlocity Layouts and Cards (Managed Package): For the managed package runtime, when deploying components in a new org, you must export any applicable Vlocity Cards framework components, particularly those that you modified. The Vlocity Cards Framework supports versioning for all components (layouts, cards and templates). Only active versions are exported.
Exporting Vlocity Layouts and Cards (Managed Package): For the managed package runtime, when deploying components in a new org, you must export any applicable Vlocity Cards framework components, particularly those that you modified. The Vlocity Cards Framework supports versioning for all components (layouts, cards and templates). Only active versions are exported.
Calling Expression Sets from an Omniscript: From an Omniscript, call an expression set created in the Business Rules Engine, and return its results to the Omniscript. Expression sets evaluate conditions, perform mathematical operations, look up decision tables and matrices, and perform multiple transformations simultaneously.
Extend an Omniscript Element's Lightning Web Component (Managed Package): For the managed package runtime, add custom behavior and styling to an Omniscript element while maintaining its core functionality. Replace an Omniscript element’s Lightning web component with a component that re-creates its properties and adds new ones.
Extend the Component (Managed Package): For the managed package runtime, learn how a custom Lightning web component extends the OmniScriptBaseMixin component to wrap a Salesforce Lightning Element.
Extend Omnistudio Lightning Web Components: Customize the behavior and styling of an application by extending Omnistudio Lightning web components. For example, override properties, add other components, or insert HTML.
Extend the Edit Block Label LWC (Managed Package): For the managed package runtime, customize an LWC Edit Block's Label for the Cards and Long Cards edit modes by extending the Edit Block Label LWC. Exclusive to Cards and Long Cards edit mode, the Edit Block Label LWC overrides the original labels, including global actions.
Extend the Edit Block New LWC (Managed Package): For the managed package runtime, customize an LWC Edit Block's new entry card by extending the Edit Block New LWC. Exclusive to the Card edit mode, the Edit Block New LWC overrides the new entry card.
Extend the OmniScriptBaseMixin Component (Managed Package): For the managed package runtime, enable a custom Lightning web component to interact with an Omniscript by extending the OmniScriptBaseMixin component. The OmniScriptBaseMixin includes methods to update an Omniscript's data JSON, pass parameters, and more.
Extend the OmniscriptBaseMixin Component: Enable a custom Lightning web component to interact with an Omniscript by extending the OmniscriptBaseMixin component. The OmniscriptBaseMixin includes methods to update an Omniscript's data JSON, pass parameters, and more.
Extend Vlocity Lightning Web Components (Managed Package): For the managed package runtime, customize the behavior and styling of an application by extending Vlocity Lightning web components. For example, override properties, add other components, or insert HTML.
Extend a Template to Create a Custom LWC Layout Template (Managed Package): For the managed package runtime, extend a template to create a custom LWC layout template. For example, use the CardCanvasLayout LWC template to overwrite methods and HTML templates. To see what methods can be overwritten for your extended component, view its ReadMe file. See Vlocity Cards LWC ReadMe Reference and Base Omnistudio LWC ReadMe Reference.
External Objects in Integration Procedures (Managed Package): For the managed package runtime, Integration Procedures support Salesforce External Objects. The external data can come from any source that can be accessed using a REST endpoint. The returned data can be rendered as JSON or XML.
External Objects in Integration Procedures: Integration Procedures support Salesforce External Objects. The external data can come from any source that can be accessed using a REST endpoint. The returned data can be rendered as JSON or XML.
Extract Data from Three Related Objects (Managed Package): For the managed package runtime, create an Omnistudio Data Mapper Extract for use by a Case-handling Omniscript. The agents who handle Cases can look up an Account, list all the Cases for the Account, and find the Contact for each Case.
Extract Data from Three Related Objects: Create an Omnistudio Data Mapper Extract for use by a Case-handling Omniscript. The agents who handle Cases can look up an Account, list all the Cases for the Account, and find the Contact for each Case.
Extract from Multiple Related Custom Objects (Managed Package): For the managed package runtime, although relationship notation is different for standard and custom fields, it is exactly the same for standard and custom objects. This example extracts data from three custom fields of the vlocity_cmt__CatalogProductRelationship__c SObject.
Feature Support Changes with Standard Designers: This table provides major feature support differences. It doesn't cover all supported features across both Omnistudio managed package and standard designers.
Firing a Pubsub Event from an Action on an LWC Card (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Vlocity Spring '20, Vlocity supports firing pubsub events from an action to notify another component on a page or application of an event occurring. For example, create an action link that fires a pubsub event called openPolicy that opens a Policy record page from any component that listens for the event.
Fix Beginning with Vlocity Insurance and Health Spring '20 (Managed Package): For the managed package runtime, if you receive a warning on your Vlocity Cards home page, and the error message, The LWC is inactive/invalid, on a card layout after enabling LWC, the required Remote Site URLs are missing. You can automatically register your org domains in one click from the Vlocity Cards home page.
Fix Cyclic Redundancy When Embedding Flexcard Components (Managed Package): For the managed package runtime, when you embed components, such as flyouts, Custom LWCs, and child Flexcards, check that components are not called multiple times. If you add components that call themselves or call other components embedded inside components, you may create cyclic redundancy causing events to continuously fire in your browser, exceeding your maximum call size stack.
Fix the DataPack Import or Export Error: No Configuration Found (Managed Package): For the managed package runtime, if you see the error message No Configuration Found while trying to import or export a DataPack, the issue is most likely with the configuration of the Salesforce org. This error often occurs in developer sandboxes that are missing some of the configuration files owing to a recent refresh or an install or upgrade that has missed a post-install or post-upgrade step. You can fix this error with code in Anonymous Apex.
Flexcard Card Actions (Managed Package): For the managed package runtime, the Flexcard Card action type enables you to trigger actions specific to a record item on a Flexcard or the Flexcard itself.
Set Up Card Actions to Update a Flexcard: Configure actions that users can trigger and that affect a record on a Flexcard or the Flexcard itself. For example, let users arrange a records view to suit their personal preference.
Flexcard Chart Element Aspect Ratio (Managed Package): For the managed package runtime, you can adjust the proportions of a Chart element with the Aspect Ratio, Maintain Aspect Ratio, and Chart Height features in the Flexcard Designer. Set the Aspect Ratio to adjust height relative to the width. Set fixed proportions. Or, override the aspect ratio and set a fixed height.
Flexcard Designer (Managed Package): For the managed package runtime, the Flexcard Designer is a declarative tool with a drag interface and WYSIWYG editing that makes it easy to build user interface (UI) Lightning web components without code. Build interfaces rich in information and with actions relevant to your customer's context. You can also create the look and feel of your Flexcard by styling individual elements from graphic user interfaces (GUIs) built into the designer.
Flexcard Designer Action Debugger (Managed Package): For the managed package runtime, debug your Flexcard's client and server-side actions and events with the Action Debugger in the Flexcard Designer's Preview tab. View requests and responses to see when and where errors occur to determine how to fix them.
Flexcard Designer Considerations (Managed Package): For the managed package runtime, the Flexcard Designer doesn’t support all functions, features, and data sources available in the Vlocity Cards Designer.
Flexcard Designer Data JSON (Managed Package): For the managed package runtime, use the Data JSON feature in the Flexcard Designer's Preview tab to see how your data source populates the elements on the rendered cards of your Flexcard component. Detect potential issues at run time. The Data JSON panel updates when you interact with the Flexcard, such as when entering data in an input field or clicking an actionable item.
Flexcard Designer Preview (Managed Package): For the managed package runtime, preview your Flexcard's appearance and test functionality before publishing it to a Lightning or Community page. Test how your Flexcard looks on multiple devices. Test the functionality of interactive elements such as actions. Debug your Flexcard's data output, events, and actions.
Flexcard Elements (Managed Package): For the managed package runtime, build a Flexcard in the Flexcard Designer by dragging elements from the Build panel onto the canvas. Each element can be styled and properties configured within the Designer. For example, add an action link styled as a button with or without an icon.
Flexcard Elements Custom CSS (Managed Package): For the managed package runtime, create, edit, and apply custom CSS classes and inline styles to your Flexcard elements in the Flexcard Designer. When styling options available from the design interfaces of the Style panel don't meet your design needs, create custom CSS classes from a code editor inside the designer, and apply them to supported fields. Or, add inline styles to a specific element.
Flexcard Naming Conventions (Managed Package): For the managed package runtime, follow requirements when naming Flexcards and Flexcard elements to prevent errors when working with the Flexcard Designer and importing Flexcards as datapacks. For example, you may run into issues when importing a Flexcard with the same name as one that already exists in your org.
Flexcard SDK Data Source (Managed Package): For the managed package runtime, you can use a SDK, such as the Salesforce Industries Digital Commerce SDK, which contains all the business logic necessary for your application and reuse that business logic in other applications. This allows you to focus on creating the UI for an application without needing to call an API and process the API response. You only need to call the method of the SDK and the SDK calls the API. The SDK gets the API response, parses that response, then gives it back to the client. The client then consumes the SDK response in the UI so you can design your Flexcard based on the response you receive.
Flexcard Setup Reference (Managed Package): For the managed package runtime, the Setup panel in the Flexcard Designer provides multiple configuration options that enable a user to define the behavior of the Flexcard further. For example, update the data source and add session variables.
Flexcard States (Managed Package): For the managed package runtime, Flexcards have states. Each state displays a list of fields, a data source, and one or more actions. You can also associate a state with one or more flyouts, which show supplemental data displayed as a modal or popover.
Flexcard Toggle Element Type Reference (Managed Package): For the managed package runtime, select how to trigger an action when a user clicks a Toggle element on a Flexcard. Enable a user to pick between two states, enable or disable an option, or select multiple options to trigger an action.
Flexcards (Managed Package): For the managed package runtime, build customer-centric, industry-specific UI components and applications on the Salesforce platform with Flexcards. Display Salesforce object information along with distinct, clickable actions that change according to the context in which they appear and based on the information that they contain.
Flexcards Action Properties (Managed Package): For the managed package runtime, Action element properties are configurable from the Properties panel in the Flexcard Designer when you select an Action element. With the Action element, create an action to launch an Omniscript, navigate to a web page or application, display a flyout, fire an event, and more.
Flexcards Actions Reference (Managed Package): For the managed package runtime, select from multiple ways to execute an action from a Flexcard. Create an action to launch an Omniscript, navigate to a web page or application, display a flyout, fire an event, and more.
Flexcards Block Properties (Managed Package): For the managed package runtime, block element properties are configurable in the Property Panel when you select a Block element in the Flexcard Designer. With the Block element, combine logical groups of elements in a collapsible container.
Flexcards Chart Properties (Managed Package): For the managed package runtime, chart element properties are configurable in the Property Panel when you select a Chart element in the Flexcard Designer. With the Chart element, display data as a chart and enable users to perform actions within the chart.
Flexcards Checkbox Input Element Properties (Managed Package): For the managed package runtime, Checkbox Input element properties are configurable in the Properties panel when you select a Checkbox element in the Flexcard Designer. Enable a user to select or unselect a checkbox.
Flexcards Child Flexcard Properties (Managed Package): For the managed package runtime, Flexcard element properties are configurable in the Property Panel when you select a Flexcard element in the Flexcard Designer. With the Flexcard element, embed a reusable Flexcard as a child inside the state of another Flexcard.
Flexcards Clone Properties (Managed Package): For the managed package runtime, this page lists Flexcards Clone Card properties available when cloning a Flexcard in the Flexcard Designer.
Flexcards Cloning (Managed Package): For the managed package runtime, Flexcards supports cloning. You can create a new Flexcard by cloning a current one to update the Author and/or Name, and copy over layout and/or settings.
Flexcards Common Display Element Properties (Managed Package): For the managed package runtime, Flexcard elements have properties shared by all Flexcard elements. For example, any element can be shown or hidden based on conditions set with the Conditions property.
Flexcards Common Input Element Properties (Managed Package): For the managed package runtime, Flexcard Input elements have properties shared by most or all Input elements. For example, add a help icon on any input element that when hovered displays helpful text about the input field.
Element-Specific Considerations for Flexcard Input Elements: Review some element-specific considerations and learn which Lightning web component the element maps to, and the attribute that you can configure. Then, access the corresponding readme file for information about the custom attribute setup.
Flexcards Conditional Style Properties (Managed Package): For the managed package runtime, add Conditional Style properties are configurable from the Style panel in the Flexcard Designer when you select an element. Conditionally apply styles to an element depending on the value of a data field.
Flexcards Conditions Properties (Managed Package): For the managed package runtime, the properties for conditions are configurable for all elements in the Properties panel in the Flexcard Designer. Conditionally display Flexcard elements based on the value of a data field.
Flexcards Context Variables (Managed Package): For the managed package runtime, global and local context variables are available to a Flexcard to provide context to data sources, actions, and other components. All variables are case sensitive.
Flexcards Context Variables: To provide context to data sources, actions, and other components, add global and local context variables to a Flexcard. All variables are case-sensitive.
Flexcards Currency Input Element Properties (Managed Package): For the managed package runtime, Currency Input element properties are configurable in the Properties panel when you select a Currency element in the Flexcard Designer. Enable users to enter a currency amount based on the locale (location and language) and currency type you specify.
Flexcards Custom CSS Properties (Managed Package): For the managed package runtime, custom CSS properties are configurable from the Style panel in the Flexcard Designer when you select an element. When the design interfaces in the Style panel do not meet your design needs, apply a class from any style sheet available to the Flexcard, or add inline styles.
Flexcards Custom LWC Properties (Managed Package): For the managed package runtime, custom LWC element properties are configurable in the Property Panel when you select a Custom LWC element in the Flexcard Designer. With Custom LWC element, embed an LWC Omniscript, a generated Flexcard LWC, or a custom LWC, inside a Flexcard state.
Flexcards Custom Styles Properties (Managed Package): For the managed package runtime, custom Styles properties are configurable in the Style panel when you select an element in the Flexcard Designer. Save style settings on a Flexcard element as a Custom Style to use on multiple elements on a Flexcard.
Flexcards Data Source Properties (Managed Package): For the managed package runtime, Flexcard Data Source properties are configurable for each data source type in the Setup panel of the Flexcard Designer. Retrieve data from a Salesforce object or an external database.
Flexcards Data Source Reference (Managed Package): For the managed package runtime, select from multiple data source types to retrieve data from a Salesforce object or an external database. Select a data source from the Setup panel in the Flexcard Designer, or when creating a Flexcard.
Flexcards Datatable Properties (Managed Package): For the managed package runtime, datatable element properties are configurable in the Property Panel when you select a Datatable element in the Flexcard Designer. With the Datatable element, display a tabular structure of the data fetched from a data source.
Flexcards Date Input Element Properties (Managed Package): For the managed package runtime, Date Input element properties are configurable in the Properties panel when you select a Date element in the Flexcard Designer. Enable users to select a formatted date from a calendar widget.
Flexcards Date/Time Input Element Properties (Managed Package): For the managed package runtime, Date/Time Input element properties are configurable in the Properties panel when you select a Date/Time element in the Flexcard Designer.Enable users to select a formatted date from a calendar widget and a formatted time from a list of time intervals.
Flexcards Display Elements Reference (Managed Package): For the managed package runtime, select from a number of display elements to add to your Flexcard. Add elements such as data fields, actions, states, data tables, and more.
Flexcards Display Elements: Show relevant information to your users by adding display elements to Flexcards such as data fields, actions, states, data tables, and more. While we provide info bubbles for most element properties directly in the app, some elements are more complex to set up, such as custom Lightning web components. Review the considerations and requirements for those elements.
Flexcards Element Alignment (Managed Package): For the managed package runtime, with Alignment properties in the Style panel of the Flexcard Designer, you can create space inside and around your elements. You can also adjust the position of the text relative to the element's container.
Flexcards Element Alignment Properties (Managed Package): For the managed package runtime, the Alignment properties of an element are configurable in the Style panel when an element is selected in the Flexcard Designer. Configuring padding, margin, and text alignment.
Flexcards Element Appearance (Managed Package): For the managed package runtime, update the appearance of your Flexcard elements with the Appearance properties in the Style panel of the Flexcard Designer. Change the text color, background, border, and set a Salesforce theme for your elements.
Flexcards Element Appearance Properties (Managed Package): For the managed package runtime, appearance properties are configurable in the Style panel of the Flexcard Designer when you select an element. Update background, text color, border, and theme of your elements.
Flexcards Element Dimensions (Managed Package): For the managed package runtime, set the height and width, and configure the responsiveness of a Flexcard element within the Flexcard Designer. In addition to adjusting the width of an element by clicking and moving its drag markers left and right on the canvas, use a slider on the Style panel to adjust the width.
Flexcards Element Dimensions Properties (Managed Package): For the managed package runtime, an element's Dimensions properties are configurable from the Style panel in the Flexcard Designer when an element is selected. Update the height and width, and configure responsiveness for your element.
Flexcards Element Responsiveness (Managed Package): For the managed package runtime, in the Flexcard Designer, enable responsiveness on one or more elements to set the width to change as the visible area of a page, called the viewport, changes. By default, the width of an element is the same regardless of the width of the viewport device on which the user views the Flexcard. The width of an element is 1 to 12 parts of a 12 column grid. For example, a field element that is 6 columns wide takes up 50% of the available horizontal space.
Flexcards Email Input Element Properties (Managed Package): For the managed package runtime, Email Input element properties are configurable in the Properties panel when you select an Email element in the Flexcard Designer. Enable users to enter a valid email address.
Flexcards Event Listener Properties (Managed Package): For the managed package runtime, event Listener properties are configurable from the Setup panel in the Flexcard Designer. Add a listener for a PubSub or Custom event that is triggered when a user performs an action.
Flexcards Field Properties (Managed Package): For the managed package runtime, field element properties are configurable in the Property Panel when you select a Field element in the Flexcard Designer. With the Field element, display data fields returned from a provided data source.
Flexcards Icon Properties (Managed Package): For the managed package runtime, icon element properties are configurable in the Property Panel when you select an Icon element in the Flexcard Designer. With the Icon element, display a Salesforce SVG Icon or a custom icon on a Flexcard.
Flexcards Image Properties (Managed Package): For the managed package runtime, image element properties are configurable in the Property Panel when you select an Image element in the Flexcard Designer. With the Image element, display an image on a Flexcard.
Flexcards Input Elements Reference (Managed Package): For the managed package runtime, add input elements on a Flexcard to enable users to enter data or select from a list of options you provide. When a user enters, selects or updates a value, the change is reflected in the data JSON. You can configure an element to execute an action when a user selects an option or enters data. Input elements are available in the Inputs section of the Build panel of the Flexcard Designer.
Flexcards Input Elements: Add input elements to Flexcards so that your users can provide data, which then updates the JSON data. You can also configure an element to run an action when a user interacts with the element.
Flexcards Menu Properties (Managed Package): For the managed package runtime, menu element properties are configurable in the Property Panel when you select a Menu element in the Flexcard Designer. With the Menu element, create a menu from a list of actions.
Flexcards Multi-Select Input Element Properties (Managed Package): For the managed package runtime, Multi-Select Input element properties are configurable in the Properties panel when you select a Multi-Select element in the Flexcard Designer. Enable users to select one or more from a list of possible options. Display options as images, checkboxes, buttons, or a dropdown list.
Flexcards Number Input Element Properties (Managed Package): For the managed package runtime, Number Input element properties are configurable in the Properties panel when you select a Number element in the Flexcard Designer. Enable users to enter a numeric value.
Flexcards Omni Interaction Access Configuration: In Omnistudio, limit access to data sources and update cache settings for the Omni UI Card object (Flexcard) across your org. Enable and disable data source types for an org, profile, or user level. Disable caching on the Platform Cache for all Flexcards. Enable Flexcards to cache asynchronously without waiting for the full caching process to finish.
Flexcards Preview 'Add Test Params' Properties (Managed Package): For the managed package runtime, Flexcards Add Test Params properties are available when previewing a Flexcard in the Flexcard Designer. Preview the Flexcard's appearance and functionality before publishing it to a Lightning or Community page. Enter additional test variables that your data source query can use to update your Preview.
Flexcards Publish Options Properties (Managed Package): For the managed package runtime, Flexcard Publish Options properties are configurable after activating a Flexcard. Define metadata values and update theffd SVG icon for your generated Flexcard LWC from the Flexcard Designer.
Supported XML Configuration for Publishing Flexcards: When publishing Flexcards, you have options for where and how the Flexcard is displayed. For these options, you can configure XML metadata for the Lightning web component for a Flexcard. Flexcards supports many but not all of the available configuration elements.
Flexcards Radio Input Element Properties (Managed Package): For the managed package runtime, Radio Input element properties are configurable in the Properties panel when you select a Radio element in the Flexcard Designer. Enable users to select one option from a list of options. Display options as radios, images, buttons, or color blocks.
Flexcards Range Input Element Properties (Managed Package): For the managed package runtime, Range Input element properties are configurable in the Properties panel when you select a Range element in the Flexcard Designer. Enable users to select from a range of numbers you specify.
Flexcards Reserved Event and Channel Names (Managed Package): For the managed package runtime, when configuring pubsub and custom events, there are some event names and channel names that are reserved for specific purposes. These reserved names are listed here.
Flexcards Select Input Element Properties (Managed Package): For the managed package runtime, select Input element properties are configurable in the Properties panel when you select a Select element in the Flexcard Designer. Enable users to select an item from a dropdown list.
Flexcards Sequential Actions (Managed Package): For the managed package runtime, enable an element or an event listener to execute sequential actions on a Flexcard. When there are multiple actions, the first action fires, completes, and then triggers the next action. You can use the response from the previous action to perform subsequent actions.
Flexcards State Properties (Managed Package): For the managed package runtime, this page contains lists of available Flexcards State element properties. Add additional states o a Flexcard to present different interactions and layouts based on specified conditions.
Flexcards Telephone Input Element Properties (Managed Package): For the managed package runtime, telephone Input element properties are configurable in the Properties panel when you select a Telephone element in the Flexcard Designer. Enable users to enter valid phone number.
Flexcards Text Area Input Element Properties (Managed Package): For the managed package runtime, Text Area Input element properties are configurable in the Properties panel when you select a Text Area element in the Flexcard Designer. Enable users to enter multiple lines of text.
Flexcards Text Element Properties (Managed Package): For the managed package runtime, Text element properties are configurable in the Property Panel when you select a Text element in the Flexcard Designer. With the Text element, combine plain text and merge fields using a Rich Text Editor.
Flexcards Text Input Element Properties (Managed Package): For the managed package runtime, Text Input element properties are configurable in the Properties panel when you select a Text Input element in the Flexcard Designer. Enable users to enter a single line of text.
Flexcards Time Input Element Properties (Managed Package): For the managed package runtime, time Input element properties are configurable in the Properties panel when you select a Time Input element in the Flexcard Designer. With the Time Input element, enable users to select a formatted time from a list of time intervals.
Flexcards Toggle Properties (Managed Package): For the managed package runtime, toggle element properties are configurable in the Property Panel when you select a Toggle element in the Flexcard Designer. Trigger an action when a user selects a Toggle element.
Flexcards Troubleshooting Considerations (Managed Package): For the managed package runtime, when working within the Flexcard Designer, you may run into issues that require some troubleshooting to resolve. Before contacting support, consider these troubleshooting articles.
Flexcards Typeahead Input Element Properties (Managed Package): For the managed package runtime, Typeahead Input element properties are configurable in the Properties panel when you select a Typeahead element in the Flexcard Designer. Enable users to click into a search field, which provides hints or a list of possible options based on the text the user enters.
Flexcards Versioning (Managed Package): For the managed package runtime, Flexcards supports versioning. You can create an identical copy of a Flexcard by creating a new version and keeping other versions with the same name, and author, but with a new version number. Create a new version when you want to make slight modifications to a Flexcard already published to Lighting or Community pages, and elsewhere.
Flexcards Versioning and Cloning (Managed Package): For the managed package runtime, Flexcards supports versioning and cloning. You can create an identical copy of a Flexcard based on how you want to use the new version.
Flexcards 'Add Custom CSS' Properties (Managed Package): For the managed package runtime, add Custom CSS properties are configurable from the submenu of the Flexcard Designer. Create custom CSS classes and add them to supported fields in the Properties and Style panels.
Understand Flexcards: Flexcards provide tools for building customer-centric, industry-specific UI components and applications on the Salesforce platform. Flexcards are rich in information and actions relevant to the customer's context. Create your Flexcards in a declarative design tool and add them to your Lightning or Experience Cloud pages.
Flyout Templates (Managed Package): For the managed package runtime, flyout templates enable users to view information or access additional actions for the current record or a child record. To create a flyout layout template, see Creating a Flyout.
Formula Overview (Managed Package): For the managed package runtime, the formula builder that is available in Omnistudio Data Mappers and Integration Procedures, and in Vlocity Intelligence, eligibility rules, underwriting rules, state rules, and calculation procedures enables you to use functions to define calculations required by your business logic.
Formula Syntax for Insurance Rules (Managed Package): For the managed package runtime, you use formulas when you Create Eligibility Rules, Create Underwriting Rules, or Create State Transition Rules. See Using the Expression Engine for more information. Formulas for insurance rules must return TRUE or FALSE.
Formulas and Functions (Managed Package): For the managed package runtime, the Expression Engine is an APEX-based formula builder used across multiple areas in Omnistudio, including Omniscripts, Omnistudio Data Mappers, and Integration Procedures. Underwriting and Eligibility Rules also use the formula builder. These rules require a server call following a state change or request.
Function Reference (Managed Package): For the managed package runtime, use these operators and functions in Omnistudio Data Mappers and Integration Procedures, and in Vlocity Intelligence, eligibility rules, underwriting rules, state rules, and calculation procedures.
Get an API Key from NASA (Managed Package): For the managed package runtime, you must specify an API key every time you invoke a NASA REST API. You can get this key from NASA.
Get an API Key from NASA: You must specify an API key every time you invoke a NASA REST API. You can get this key from NASA.
Get Started with Flexcards (Managed Package): For the managed package runtime, Flexcards provide a set of components for building UI components and applications on the Salesforce platform. Here are some key resources to help you navigate the Flexcard Designer and guide you through common tasks.
Get to Know the Flexcard Designer (Managed Package): For the managed package runtime, get to know how the different parts of the Flexcard Designer work to build rich interfaces relevant to your customer's context.
Getting Started with Omniscripts (Managed Package): For the managed package runtime, Vlocity Omniscript is an omnichannel customer engagement and a business tool built on the Salesforce platform. Administrators can define a script once and then deploy the script within a Salesforce application or on a web page. Omniscript can be used to collect data from both Salesforce.com users and anonymous users via a wide variety of HTML controls.
Group Elements Inside a Block on a Flexcard (Managed Package): For the managed package runtime, combine logical groups of elements inside a collapsible container with the Block element on a Flexcard. For example, group an Account's basic information together, and separately, group the account's Contact information together.
Group Elements in a Block on a Flexcard: Combine logical groups of elements in a collapsible container by using the block element. For example, group an account's basic information in one block, and group the account's contact information in another.
Group Integration Procedure Steps Using Blocks (Managed Package): For the managed package runtime, in an Integration Procedure, you can run a group of related steps as a unit inside a block to execute them conditionally, cache them, repeat them for each item in a list, or return an error if they fail.
Integration Procedure Blocks: In an Omnistudio Integration Procedure, you can run a group of related steps as a unit inside a block to execute them conditionally, cache them, repeat them for each item in a list, or return an error if they fail.
Handle a Login Failed Message (Managed Package): For the managed package runtime, if you refresh a Source or Target org and see a Login Failed ... Please Login Again message, you can fix the error.
Handle Errors by Using a Try-Catch Block: Handle errors in Integration Procedures by using Try-Catch Blocks. A Try-Catch Block lets you "try" running the steps inside it and then "catch" the error if a step fails.
Hide Omniscript Elements: Hide elements and child elements using the Hide property available on Omniscript Input Components, Blocks, Steps, Groups, Formulas, and Aggregate elements.
Hide the Next and Previous Buttons (Managed Package): For the managed package runtime, hide a Step's Next and Previous buttons when using auto-advance options or when you do not want the user to navigate steps.
Hide the userProfile Node in Omniscript Preview: To improve the performance of Omniscript previews, you can hide the userProfile node. This helps previews load faster, especially for larger Omniscripts.
How to Launch (Managed Package): For the managed package runtime, make an active Omniscript available for launch in one of four ways: as a standalone Lightning web component in a Lightning page, as an embedded link in another LWC, as a URL, or using an Aura wrapper.
How to Launch Omniscripts: Make an active Omniscript available for launch in one of three ways: as a standalone Lightning Web Component in a Lightning Web Page or as a URL.
HTTP Action (Managed Package): For the managed package runtime, call internal and external web services from Omniscript without coding or making Salesforce API calls using the HTTP Action.
Calling Web Services with the Omniscripts HTTP Action: With the HTTP Action, call internal and external web services from an Omniscript without coding or making Salesforce API calls. You can call an HTTP API that allows Apex, Named Credentials, SOAP/XML, or Web, and use the Omniscript's JSON as input.
HTTP Action for Integration Procedures: The HTTP Action executes a REST call and returns its results to the Integration Procedure. The HTTP Action in Integration Procedures supports only getBody() for returning the response. Use Apex directly via a Remote Action to handle binary responses.
HTTP Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in HTTP Actions. The HTTP Action executes a REST call and returns its results to the Integration Procedure.
IDX Workbench Configuration for Deployment (Managed Package): For the managed package runtime, before you can deploy components, you must specify the source, the target, and the objects to be deployed. The source can be an org, a Project object in an org, a JSON file, the Vlocity Process Library, or a Git repository. The target can be an org or a Git repository.
IDX Workbench Desktop Application (Managed Package): For the managed package runtime, IDX Workbench is a desktop application that you use to deploy Omnistudio data packs and Salesforce metadata. Its user interface is built on top of the Omnistudio Build Tool. The application is available for Mac and Linux.
IDX Workbench Menu Commands (Managed Package): For the managed package runtime, most of the commands in the IDX Workbench menus are like those of any application. For example, Edit > Copy copies the selected text. Commands specific to IDX Workbench are listed here.
Implement the VlocityRequiredPermissionCheck Class (Managed Package): For the managed package runtime, for the DefaultRequiredPermission setting to work, you must implement the VlocityRequiredPermissionCheck class manually because Salesforce handles classes in managed and unmanaged packages differently. This class doesn't work properly if it's included in the managed package.
Implement the VlocityRequiredPermissionCheck Class (Managed Package): For the managed package runtime, for the DefaultRequiredPermission setting to work, you must implement the VlocityRequiredPermissionCheck class manually because Salesforce handles classes in managed and unmanaged packages differently. This class doesn't work properly if it's included in the managed package.
Implement the VlocityRequiredPermissionCheck Class: For the DefaultRequiredPermission setting to work, you must implement the VlocityRequiredPermissionCheck class manually because Salesforce handles classes in managed and unmanaged packages differently. This class doesn't work properly if it's included in the Vlocity managed package.
Implement the VlocityRequiredPermissionCheck Class: For the DefaultRequiredPermission setting to work, you must implement the VlocityRequiredPermissionCheck class manually because Salesforce handles classes in managed and unmanaged packages differently. This class doesn't work properly if it's included in the Vlocity managed package.
Import a Flexcard (Managed Package): For the managed package runtime, import a Flexcard as a data pack from another environment into your org.
Import Customer Story Configuration Settings (Managed Package): For the managed package runtime, before updating a Customer Story Object Configuration for a new Customer Story, you can import the standard Customer Story Object Configuration from Static Resources. Download as a JSON file to upload to an object's home page.
Importing Omniscripts (Managed Package): For the managed package runtime, starting with Spring 2016, Omniscripts can be imported using the Data Pack feature. This allows you to move Omniscripts from one environment to another.
Improve Performance of Repeated Records on a Flexcard (Managed Package): For the managed package runtime, improve the performance on rerendered elements when a Flexcard with repeating records updates. Only rerender the affected card record in the Flexcard component by entering a unique Render Key that identifies it. The Flexcard LWC uses the key to find which element in the Document Object Model (DOM), the rendered HTML, to update.
Include Nested Custom LWCs in Your OmniOut Omniscript (Managed Package): For the managed package runtime, map nested custom Lightning web components in your Omniscript to include them in your OmniOut project. Lightning web components that override or map to an Omniscript element are automatically downloaded with the off-platform Omniscript LWC.
Initial Configuration for the Knowledge Component in Classic Omniscript (Managed Package): For the managed package runtime, if your organization has Salesforce Knowledge enabled, you can integrate it with Omniscript to enable users to search and view Salesforce Knowledge articles in the Omniscript. Omniscript also supports querying Lightning Knowledge once it has been enabled.
Inputs and Outputs for Omnistudio Data Mappers: The configuration of inputs and outputs in Salesforce Omnistudio Data Mappers is highly flexible. The primary data formats are JSON and XML with other options available.
Install OmniOut Dependencies (Managed Package): For the managed package runtime, configure and install the OmniOut dependencies using a command-line-tool. Install the tools necessary to build your OmniOut app and view it locally.
Install or Upgrade the Omnistudio Package: Omnistudio is in a managed package that you install into a Salesforce org. If your org isn’t automatically upgraded, use these procedures to upgrade Omnistudio.
Integrate DocuSign with Omniscripts (Managed Package): For the managed package runtime, enable users to either sign DocuSign forms in an Omniscript or email a user a copy of the document to sign at their convenience. DocuSign integration requires an active DocuSign account.
Integrate DocuSign with Omniscripts: Enable users to either sign DocuSign forms in an Omniscript or email a user a copy of the document to sign at their convenience. DocuSign integration requires an active DocuSign account.
Integrate Integration Procedures with Agentforce: To make Integration Procedures available as a new action type within Agent Actions, start by selecting the desired Integration Procedure. Define its input and output data in JSON format, then verify the data. This process automatically converts the Integration Procedure Data JSON into a format compatible with Agentforce. Then, add the Agent Action from the Asset Library in Agentforce Studio, configure the Agent and subagent, and activate the embedded Integration Procedure within Agentforce. After it’s set up, the Integration Procedure can be triggered during agent-customer interactions to drive real-time automation and data access.
Integrate Salesforce Knowledge with Omniscript (Managed Package): For the managed package runtime, enable users to search and view Salesforce Knowledge Articles when using an Omniscript. Configure Omniscript Knowledge Options to search for articles based on static values and dynamic inputs from Omniscript fields, or a query from a simple search bar.
Integrate Salesforce Knowledge with Omniscript: Enable users to search and view Salesforce Knowledge Articles when using an Omniscript. Configure Omniscript Knowledge Options to search for articles based on static values and dynamic inputs from Omniscript fields, or a query from a simple search bar.
Integrating Salesforce Knowledge with Classic Omniscript (Managed Package): For the managed package runtime, activate the Knowledge component in Omniscript to allow users to view and search for articles from your Salesforce Knowledge articles. Automatically search for articles based on static values set up during configuration, dynamic inputs from Omniscript fields, or using a simple search bar.
Retrieve Data with an Integration Procedure in an Omniscript: From an Omniscript, call an Integration Procedure to retrieve Salesforce data and external data. You can run multiple actions as a headless service (lacking a UI) through JavaScript or Apex Service.
Integration Procedure Actions (Managed Package): For the managed package runtime, to compose an Integration Procedure, you add actions that run sequentially. These actions can set data values, perform functions, call Omnistudio Data Mappers, invoke Apex classes, send emails, invoke REST endpoints, run other Integration Procedures, and more.
Integration Procedure Actions: To compose an Integration Procedure, you add actions that run sequentially. These actions can set data values, perform functions, call Omnistudio Data Mappers, invoke Apex classes, send emails, invoke REST endpoints, run other Integration Procedures, and more.
Integration Procedure Event Tracking (Managed Package): For the managed package runtime, for Integration Procedures, the following events are tracked. When one Integration Procedure calls another, and you enable tracking only in the calling Integration Procedure, events in the called Integration Procedure are also tracked.
Integration Procedure Event Tracking: For Integration Procedures, the following events are tracked. When one Integration Procedure calls another, and you enable tracking only in the calling Integration Procedure, events in the called Integration Procedure are also tracked.
Integration Procedure Features Not in Omniscripts: Integration Procedures and Omniscripts have differences and common features. Some important Integration Procedure features aren't present in Omniscripts.
Integration Procedure Invocation (Managed Package): For the managed package runtime, you can invoke Integration Procedures from other Omnistudio tools such as Omniscripts and Cards. You can also invoke Integration Procedures from Apex classes, batch jobs, REST APIs, or Salesforce flows.
Invoke an Integration Procedure: You can invoke Integration Procedures from other Omnistudio tools such as Omniscripts and Cards. You can also invoke Integration Procedures from Apex classes, batch jobs, REST APIs, or Salesforce flows.
Integration Procedure Invocation from Apex: Starting with Summer’ 25, use the ConnectAPI.OmniDesignerConnect.integrationProcedureExecute(ipName, apexInput) Connect API for Integration Procedure calls from the IntegrationProcedureService Apex class. This Connect API removes the dependency on the managed package and provides up to 21% better performance for Integration Procedure calls from an Apex class compared to the previous method.
Integration Procedure Invocation from REST APIs (Managed Package): For the managed package runtime, you can use either a GET or a POST call to invoke an Integration Procedure and retrieve the result. The difference between the two is that a GET call can't include a JSON request body.
Integration Procedure Invocation from REST APIs: With a REST API, you can use either a GET or a POST call to invoke an Integration Procedure and retrieve the result. The difference between the two is that a GET call can't pass data with a JSON request body.
Integration Procedure Invocation from Salesforce Flow (Managed Package): For the managed package runtime, to call an Integration Procedure from a Salesforce Flow, create a Salesforce Flow component by defining a class using the Salesforce Developer Console, as shown in the following example. Note that the class must have the @InvocableMethod annotation.
Integration Procedure Invocation from Salesforce Flow: To call an Integration Procedure from a Salesforce Flow, create a Salesforce Flow component by defining a class using the Salesforce Developer Console, as shown in the following example. Note that the class must have the @InvocableMethod annotation.
Integration Procedure Invocation Using GET (Managed Package): For the managed package runtime, to request JSON data from an Integration Procedure, issue a GET call. With a GET call, you can specify inline values in the URL path and append query parameters to the URL. You can't pass data with a JSON request body.
Integration Procedure Invocation Using POST (Managed Package): For the managed package runtime, to send JSON data to an Integration Procedure, issue a POST call. With a POST call, you can specify inline values in the URL path, append query parameters to the URL, and include a JSON request body.
Integration Procedure Unit Testing from Apex: You can set up a test class in Apex and use it to call and test an Integration Procedure. In the core runtime, HTTP mocking isn’t possible, and real HTTP calls occur during test execution.
Integration Procedures (Managed Package): For the managed package runtime, the following diagram shows the relationship between an Omniscript and an Integration Procedure that it calls.
Interface Objects for External Data Loads (Managed Package): For the managed package runtime, to provide data from an external source (for example, a CSV file) to an Omnistudio Data Mapper, create an interface object and optionally a preprocessor class. Interface objects are custom Salesforce objects.
Invoke a Chainable Integration Procedure with REST Calls (Managed Package): For the managed package runtime, a chainable Integration Procedure is split into multiple transactions to avoid hitting Salesforce governor limits. Using a REST API is the easiest way to see the partial responses each transaction returns before the Integration Procedure completes.
Invoke a Chainable Integration Procedure with REST Calls: A chainable Integration Procedure is split into multiple transactions to avoid hitting Salesforce governor limits. Using a REST API is the easiest way to see the partial responses each transaction returns before the Integration Procedure completes.
Invoke Omnistudio Data Mappers: Easy to build and reusable, you can call Data Mappers from other Omnistudio tools, such as Integration Procedures, Omniscripts, and Flexcards. But Apex classes, batch jobs, or REST APIs, can also call Data Mappers. With a Data Mapper, centrally manage data transactions to use in multiple applications.
Advanced Apex Class Check for Integration Procedures in Omnistudio for Managed Packages: The advanced Apex class check is performed through the ApexClassCheckForIP security flag. The ApexClassCheckForIP flag strengthens Omnistudio security by enforcing Apex class access checks during Integration Procedure execution. This enhancement makes sure that users have the required permissions to run custom Apex classes referenced within Integration Procedures.
Enable Error Logging for Integration Procedures: Enable error logging to capture detailed information about failed Integration Procedure steps. Omnistudio writes all Integration Procedure errors to the OmniComponentErrorLog sObject records.
Work with Data and Lists: Use Integration Procedures to read, write, and transform complex, hierarchical data from Salesforce objects and other sources. Use actions to work with data, and blocks to process it.
Knowledge Options Properties Reference (Managed Package): For the managed package runtime, Knowledge Options properties are configurable from the Setup and Properties panels in the Omniscript Designer. Enable Knowledge in your Omniscript to allow users to view and search for articles from your Salesforce Knowledge articles.
Launch a Flyout from an Action on a Flexcard (Managed Package): For the managed package runtime, create a flyout to display additional information when a user clicks an action on a Flexcard. For example, a Flexcard that displays Account information can display the Primary Contact's name and email address in a flyout.
Set Up Flyouts on a Flexcard: Display additional information from a child Flexcard, an Omniscript, or a custom Lightning web component when a user clicks an action on a Flexcard. For example, show account information on a Flexcard and the primary contact's name and email address in a flyout.
Launch an Omniscript from a Flexcard (Managed Package): For the managed package runtime, launch an Angular or LWC Omniscript from an Omniscript Action element on a Flexcard. For example, launch a form that updates Account information based on the account Id passed from the Flexcard to the Omniscript.
Launch an Omniscript from a Flexcard: Set up a Flexcard to call an Omniscript that updates the Flexcard’s data source. For example, users enter their account ID on a Flexcard. Then, when they click the Omniscript action, Omnistudio passes the entered value and launches a form that updates their account information.
Launch Lightning Web Component URLs with vlocityLWCWrapper (Managed Package): For the managed package runtime, add the vlocityLWCWrapper to make Lightning web components in a Lightning page URL addressable. Lightning web components are not URL addressable by default. The vlocityLWCWrapper wraps the Lightning web component in a URL addressable aura component.
Launch Vlocity Cards within an LWC Omniscript (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Launching an LWC Omniscript from a Vlocity or Custom Action on a Card (Managed Package): For the managed package runtime, launch an LWC Omniscript from a card on a Community or Lightning page by configuring the URL of a Vlocity Action or Custom Action. Add a generated LWC OS component to a Community page when you do not need to pass custom parameters to the component, or add the component to a Lightning page with or without custom parameters. Add the Vlocity LWC Omniscript Wrapper component to a Community page when you need to pass parameters to the LWC Omniscript.
Launching an LWC Omniscript from an OS Action on a Card (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Vlocity Health Winter '18, Vlocity Cards contains a configurable Omniscript Action (OS Action). The OS Action simplifies the process to navigate to an Omniscript from a card action.
Launching an Omniscript from an OS Action on a Card (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Vlocity Health Winter '18, Vlocity Cards contains a configurable Omniscript Action (OS Action). The OS Action simplifies the process to navigate to an Omniscript from a card action.
Launching an Omniscript From the Action Toolbar (Managed Package): For the managed package runtime, using the Action toolbar, you can launch a single Omniscript from a variety of contexts without configuring a Visualforce page for each context. For example, you can launch an Omniscript from a Contact, Account, Case record, or Customer Community, using a single Visualforce page.
Launching Multi-Language Angular Omniscripts (Managed Package): For the managed package runtime, by default, a multi-language Angular Omniscript uses the language configured for the user who is running the script. To specify the language in which a script is run, use a Salesforce-supported language code.
Launching Omniscript from a Community or Lightning Record Page (Managed Package): For the managed package runtime, the Vlocity LWC Omniscript Wrapper component hosts a single Omniscript that is invoked directly from a Community or Lightning Record Page. By default, the record Id that exists on a Lightning Record page passes as a parameter into the Omniscript as a context Id.
Launch Omniscripts (Managed Package): For the managed package runtime, launch Omniscripts in Salesforce from Communities, Object detail pages, and Vlocity Card Actions.
Legacy Features (Managed Package): For the managed package runtime, Omnistudio for Managed Packages includes features for older products and applications.
Legacy Omnistudio UI Reference: This reference table shows the functionalities affected by the ShowLegacyOmniStudioUi setting.
Limit User Access to a Card Layout in a Managed Package (Managed Package): For the managed package runtime, in the managed package in your org, the VlocityRequiredPermissionCheck Apex Class must exist in Setup > Apex Classes for the Required Permissions feature to work. The Required Permissions feature enables you to limit user access to a card layout. Enter a list of custom permissions to specify which users can see your layout.
Line Break (Managed Package): For the managed package runtime, the Line Break element creates a line break in the Omniscript wherever it exists. Elements placed after a line break start on the next line regardless of another element's width. Place the Line break element directly above the element that should begin on a new line.
Adding a Line Break in an Omniscript: To help separate other elements in a step, you can create a line break in the Omniscript wherever it exists. Elements placed after a line break start on the next line regardless of another element's width. Place the Line break element directly above the element that should begin on a new line.
List Action for Integration Procedures: The List Action merges multiple lists by matching values of specified list item JSON nodes. A basic merge matches node names exactly. An advanced merge matches nodes that have different names or reside at different levels in the incoming lists.
List Input for Omnistudio Data Mappers (Managed Package): For the managed package runtime, Data Mappers can perform list transformations. For mapping input to output, Data Mappers require a list input in which every value is paired with a key.
Transforming Lists with Data Mappers: Data Mappers can perform list transformations. For mapping input to output, Data Mappers require a list input in which every value is paired with a key.
List Input in Custom Functions (Managed Package): For the managed package runtime, if an input to your custom function is of the type List<Object>, the input is saved to a VLOCITY-FORMULA-LIST key. To retrieve the input, use code that retrieves this key.
List Merge Action for Integration Procedures (Managed Package): For the managed package runtime, the List Merge Action merges multiple lists by matching values of specified list item JSON nodes. A basic merge matches node names exactly. An advanced merge matches nodes that have different names and/or reside at different levels in the incoming lists.
Load Data into Omniscript Elements (Managed Package): For the managed package runtime, populate Omniscript elements with data to prefill elements, create selectable options, dynamically display elements, and test functionality. Load data into your Omniscript using Omnistudio Data Mappers, Integration Procedures, HTTP Actions, URL parameters, or Apex.
Load Data into Omniscript Elements: You’ll likely need to pull data into an Omniscript to prefill elements, create selectable options, dynamically display elements, or test your Omniscript. You can use data from Salesforce objects or external and internal sources. Omniscripts use several ways to get this data: Omnistudio Data Mappers, Integration Procedures, REST APIs, or Apex. Users can also add or change data in an Omniscript.
Long-Running Integration Procedures: When invoking long-running Integration Procedures you can avoid hitting Salesforce governor limits by using chainable and queueable chainable settings or Apex Continuations, or by chaining on one or more specific long-running steps.
Lookup Element (Managed Package): For the managed package runtime, run a query using text input to retrieve Salesforce data using the Lookup element. The retrieved data is returned in Value/Label pairs and becomes available for selection in a dropdown list.
Query Salesforce Data from an Omniscipt with the Lookup Element: Run a query using text input to retrieve Salesforce data using the Lookup element. The retrieved data is returned in value-label pairs and becomes available for selection in a dropdown list.
Create a Loop Block Example That Adds Values to List Items Using Conditions (Managed Package): For the managed package runtime, an Integration Procedure adds a dynamic value to each item in a list using conditions. Although dynamic in the list, the values are hard-coded in the Integration Procedure. Use this approach if you know or care about a specific set of possible values.
Set Values in a List by Using Conditions: In this example, an Integration Procedure adds a dynamic value to each item in a list using conditions. Although dynamic in the list, the values are hard-coded in the Integration Procedure. Use this approach if you have a specific set of possible values.
Add Values to List Items by Using VALUELOOKUP: In this example, an Integration Procedure adds a dynamic value to each item in a list using the VALUELOOKUP function. The values aren't hard-coded in the Integration Procedure. Use this approach if you don't know the set of possible values in the input.
Loop Block Properties (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Loop Blocks. A Loop Block iterates over the items in a data array, enabling the Actions within it to repeat for each item.
Loop Block: A Loop Block iterates over the items in a data array, enabling the Actions within it to repeat for each item. The array input to the Loop Block is processed so that each iteration receives only one item in the array.
LWC Card and Layout Templates (Managed Package): For the managed package runtime, apply card and layout templates to a Vlocity LWC enabled card to control the information and actions available to a user.
Lightning Web Component Cards (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
LWC Cards Changes and Enhancements (Managed Package): For the managed package runtime, LWC Cards contain changes to existing features that affect the configuration and performance of an LWC Flexcard. See LWC Cards Considerations for unsupported features and functionality.
LWC Cards Considerations (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
LWC Omniscript Changes and Enhancements (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
Angular Features Not Supported in Omniscripts (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.
LWC Omniscript Designer Considerations (Managed Package): For the managed package runtime, the Vlocity LWC Omniscript Designer does not support all of the elements, functionality, and deployment options available in the Classic Omniscript Designer.
LWC Omniscript Designer Overview (Managed Package): For the managed package runtime, beginning with the Vlocity Insurance and Health Spring '20, the Vlocity LWC Omniscript Designer enables you to preview dynamic web forms as you build them using a drag-and-drop interface with WYSIWYG editing.
LWC Omniscript ReadMe Reference (Managed Package): For the managed package runtime, this page lists the Lightning web components ReadMes available for LWC Omniscripts. Extend Lightning web components to add custom behavior and styling.
Lightning Web Component Omniscripts (Managed Package): For the managed package runtime, LWC Omniscripts enable you to enhance an existing Omniscript element or add custom functionality to the Omniscript by using custom Lightning web components.
Make a Long-Running Remote Call Using VlocityContinuationIntegration (Managed Package): For the managed package runtime, to support long-running remote calls, Vlocity supports the use of the Salesforce Continuation object. The VlocityOpenInterface2 interface and VlocityContinuationIntegration class support normal Remote Calls and Remote Calls that use the Continuation Object. For the new Apex classes, don’t use VlocityOpenInterface.
Make a Long-Running Remote Call Using VlocityContinuationIntegration: To support long-running remote calls, Vlocity supports the use of the Salesforce Continuation object. The VlocityOpenInterface2 interface and VlocityContinuationIntegration class support normal Remote Calls and Remote Calls that use the Continuation Object. For the new Apex classes, don’t use VlocityOpenInterface.
Make Remote Calls from Lightning Web Components using the LWC Omniscript Action Framework (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, LWC Omniscripts make remote calls using a new action framework built with JavaScript classes. The Action framework is available to all custom LWCs in your Salesforce org. Enable an LWC to make remote calls using specific functionalities by importing the Common Action Utility class into the LWC.
Remote Calls (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 , enable users to make remote calls from a Custom LWC by using the omniRemoteCall() method.
Manage Flexcard Data Source User and Profile Access in Omnistudio: Enable or disable specific Flexcard data sources for an Omnistudio profile or user. For example, prevent admins with limited permissions from using more complex data sources like an Apex REST or Apex Remote.
Manage Omniscript Data (Managed Package): For the managed package runtime, this section contains information on how to transform, evaluate, and set data in Omniscript. The data is maintained in an intermediate structure called the data JSON, which is visible to you, the developer, as you define the Omniscript. Data JSON is not visible to users who run the Omniscript.
Managed and Unmanaged Components in Managed Packages (Managed Package): For the managed package runtime, managed Flexcard components visible in the Lighting App and Community Builders and shipped in the managed package in your org, work as-is. As in, you can add them to a Lightning or Community page without having to use the Flexcard Designer.
Manipulate JSON with the Send/Response Transformations Properties (Managed Package): For the managed package runtime, specify and transform the input and output JSON of Omniscripts or Integration Procedures with the Send and Response Transformation properties. The Send properties transform the input; the Response properties transform the output.
Manipulate JSON with the Send/Response Transformations Properties: Specify and transform the input and output JSON of Omniscripts or Integration Procedures with the Send and Response Transformation properties. The Send properties transform the input; the Response properties transform the output.
Manually Update Remote Site Settings for Flexcards (Managed Package): For the managed package runtime, manually grant access to your org domains to enable LWC features such as Preview. When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the Remote Site Setting page in your org does not include the URLs required. The required URLs are your org's lightning.force.com URL and the vf.force.com URL of the Visualforce page that contains the Flexcard Designer.
Manually Update Remote Site Settings for Flexcards: Manually grant access to your org domains to enable LWC features such as Preview. When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the Remote Site Setting page in your org does not include the URLs required. The required URLs are your org's lightning.force.com URL and the vf.force.com URL of the Visualforce page that contains the Flexcard Designer.
Manually Update Remote Site Settings from a Notification in Flexcards (Managed Package): For the managed package runtime, if you see a notification in Flexcards home tab, grant access to your org domains to enable LWC features such as Preview. When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the Remote Site Settings page in your org does not include the URLs required. The required URLs are your org's lightning.force.com URL and the vf.force.com URL of the Visualforce page that contains the Flexcard Designer.
Map an Element Type to a Custom Lightning Web Component (Managed Package): For the managed package runtime, override all elements of one type with a custom Lightning web component by mapping the element type to the Custom LWC. The custom Lightning web component must extend the element type's Lighting web component. For example, to override all of the Text elements in the Omniscript, the custom component must extend the OmniScriptText component.
Map Data from an LWC Omniscript to an Embedded Flexcard (Managed Package): For the managed package runtime, after embedding a Flexcard inside an LWC Omniscript, map records from the Omniscript to data fields in the Flexcard. For example, populate a list of Flexcards from an array in an Omniscript. In this scenario, the Flexcard uses data from the Omniscript instead of its own data source.
Map Fields from the Omniscript to the DocuSign Template (Managed Package): For the managed package runtime, to populate a DocuSign template, you define Omniscript data as input to an Omnistudio Data Mapper Transform, which uses that data to populate the template. You can construct the Omniscript data manually or copy it from the Omniscript.
Map Fields from the Omniscript to the DocuSign Template: To populate a DocuSign template, you define Omniscript data as input to an Omnistudio Data Mapper Transform, which uses that data to populate the template. You can construct the Omniscript data manually or copy it from the Omniscript.
Matrix Action (Managed Package): For the managed package runtime, the Omniscript Matrix Action enables you to retrieve a value from a calculation matrix by specifying the required input parameters.
Matrix Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Matrix Actions. The Matrix Action calls a calculation matrix with specified inputs and returns the result to the Integration Procedure.
Use the Omnistudio MCP (Beta): Use the Omnistudio Model Context Protocol (MCP) server (Beta) to create Flexcards with a simple prompt or a complex set of requirements.
Meeting Industry Challenges with Omnistudio (Managed Package): For the managed package runtime, the industries we serve face daunting challenges to thrive and remain competitive. To better serve customers, companies often resort to custom coding, which can be expensive, risky, can require months or years to complete. And custom projects can be delayed because a business process has changed. Improving and transforming customer service can be a monumental task. Here are the industries that Vlocity serves:
Message Types (Managed Package): For the managed package runtime, the LWC Omniscript messages have different styling than Angular Omniscript messages. The LWC Omniscript messages use pure SLDS styling. This table provides examples of both LWC Omniscript and Angular Omniscript messages.
Messaging Example (Managed Package): For the managed package runtime, in this example, a Requirement message displays when a user is under the age of eighteen:
Messaging Framework (Managed Package): For the managed package runtime, communicate between an Omniscript, windows, Lightning web components, and Omniscript elements using window post messages, session storage messages, and PubSub messaging.
Messaging Framework for Omniscripts: Communicate between an Omniscript, windows, Lightning web components, and Omniscript elements with window post messages, session storage messages, and PubSub messaging.
Troubleshooting Errors After Enabling Omnistudio Metadata: If you see an error after enabling the Omnistudio Metadata setting, check for invalid names for components, Omnistudio Data Mapper version numbers, and populated configuration tables.
About the Migration Process: The migration process uses the Omnistudio Migration Assistant to move components such as Flexcards, Omniscripts, Data Mappers, Integration Procedures, custom labels, Omni Global Auto Numbers, and related objects such as Apex classes, FlexiPages, Experience Cloud site pages, Lightning web components (LWCs), and custom labels from managed package runtime and Omnistudio Foundation package to the Omnistudio standard runtime. This makes sure that the components from industry packages such as Insurance (INS), Communications, Media, and Energy (CME), and Public Sector (PS) match the standard runtime, easing maintenance and upgrades.
About the Omnistudio Migration Assistant: The Omnistudio Migration Assistant is a Salesforce CLI plugin that helps automate the migration of Omnistudio components such as Flexcards, Omniscripts, Data Mappers, and Integration Procedures from the Vlocity Industries managed package or Omnistudio Foundation package runtime to the Omnistudio standard runtime. This process also helps you migrate custom labels, Omni Global Auto Numbers, and related objects such as Apex classes, FlexiPages, Experience Cloud site pages, Lightning web components (LWCs), and custom labels.
Set the Omnistudio Designers to Use the Standard Data Model: As part of the migration from managed package runtime to Omnistudio standard runtime, execute an Apex class to set the Omnistudio designers to use the standard data model instead of the custom data model.
Deploy Migrated Omnistudio Components to Another Environment: ̄After you test all your migrated content in a sandbox, use Visual Studio Code (VS Code) to push the content to the next environment in your migration plan. Deployment can be challenging if dependencies are not fully understood. We recommend thoroughly analyzing your entire implementation and carefully defining components in the package.xml file to make sure that no dependencies are overlooked.
Omnistudio Migration Prerequisites: Before you start any Omnistudio migration, review these setup requirements and preparatory steps. These checks ensure your org is ready for a successful migration and help you identify any manual updates needed before running the Omnistudio Migration Assistant.
Migrate Your Components to Omnistudio Standard Runtime Using the Omnistudio Migration Assistant: The Omnistudio migration process helps you reduce package dependencies and migrate Omnistudio components such as Flexcards, Omniscripts, Data Mappers, and Integration Procedures from the Vlocity Industries managed package or Omnistudio foundation package runtime to the Omnistudio standard runtime. This process also helps you migrate custom labels, Omni Global Auto Numbers, and related objects such as Apex classes, FlexiPages, Experience Cloud site pages, Lightning web components (LWCs), and custom labels.
Migrate Omnistudio Components from Vlocity Industries Managed Packages and Custom Data Model to Omnistudio Standard Runtime: The Omnistudio migration process migrates components such as Flexcards, Omniscripts, Data Mappers, Integration Procedures, Omni Global Auto Numbers, Apex classes, FlexiPages, Experience Cloud site pages, Lightning web components (LWCs), and custom labels from the Vlocity Industries managed package runtime (custom data model) to the Omnistudio standard runtime (standard data model). Moving to the Omnistudio standard runtime involves migrating components from the custom data model used in Vlocity Industries managed packages to the standard data model. The Vlocity Industries managed packages include Insurance (INS), Communications, Media, and Energy (CME), and Public Sector (PS). The migration is performed using the Omnistudio Migration Assistant, which automates and guides you through the process for a smooth transition.
Migrate Omnistudio Components from Omnistudio Foundation Package and Standard Data Model to the Omnistudio Standard Runtime: The Omnistudio migration process helps migrate components such as Flexcards, Omniscripts, Data Mappers, Integration Procedures, Apex classes, FlexiPages, Experience Cloud pages, Lightning web components (LWCs), and custom labels from the standard data model and Omnistudio foundation package to the Omnistudio standard runtime with Omnistudio Metadata setting enabled. The migration is performed using the Omnistudio Migration Assistant, which automates and streamlines the process to ensure a seamless transition to the standard runtime environment.
Migration Phase 1: Development Sandbox (Vlocity Industries Managed Packages and Custom Data Model): In phase 1, prepare your development and testing sandboxes by upgrading to the required managed package versions, provisioning necessary licenses, and enabling the Omnistudio Metadata API setting. Convert or rebuild any unsupported Angular components and migrate calculation logic to the Business Rules Engine. Next, run the Omnistudio Migration Assistant in Assess mode to identify issues and confirm readiness. After resolving any manual interventions, run the tool in Migrate mode to move components and related objects to the standard runtime. Finally, validate the migration by reviewing reports, updating integrations, and testing business workflows in your sandboxes.
Migration Phase 1: Development Sandbox (Omnistudio Foundation Package and Standard Data Model): In Phase 1, prepare your development and testing sandboxes, upgrade to the required managed package versions, and provision licenses. Migrate calculation logic to Business Rules Engine. Next, run the Omnistudio Migration Assistant in Assess mode to identify issues and confirm readiness. After resolving any manual interventions, run the tool in Migrate mode to move components and related objects to the Omnistudio standard runtime. Finally, validate the migration by reviewing reports, updating integrations, and testing business workflows in your sandboxes.
Migrate Omnistudio Components from Vlocity Industries Managed Package and Standard Data Model to Omnistudio Standard Runtime: The Omnistudio migration process helps migrate components such as Flexcards, Omniscripts, Data Mappers, Integration Procedures, Omni Global Auto Numbers, Apex classes, FlexiPages, Experience Cloud pages, Lightning web components (LWCs), and custom labels from the Vlocity Industries Managed Packages and standard data model to the Omnistudio standard runtime. The migration is performed using the Omnistudio Migration Assistant, which automates and streamlines the process to ensure a seamless transition to the standard runtime environment.
Sandboxes for Omnistudio Migration: Create two dedicated sandboxes: a migration development sandbox for converting your Omnistudio components to work with the standard runtime, and a migration testing sandbox for thoroughly testing migrated Omnistudio components before you deploy to production.
Review the Assessment Reports (Vlocity Industries Managed Packages and Custom Data Model): When you run the Omnistudio Migration Assistant in Assess mode, it generates assessment reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These assessment reports highlight several key areas that require attention before migrating Omnistudio components.
Review the Assessment Reports (Vlocity Industries Managed Package or Omnistudio Foundation Package and Standard Data Model): When you run the Omnistudio Migration Assistant in Assess mode, it generates assessment reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These assessment reports highlight several key areas that require attention before migrating Omnistudio components.
Review the Migration Reports (Vlocity Industries Managed Packages and Custom Data Model): When you run the Omnistudio Migration Assistant in Migrate mode, it generates migration reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These migration reports highlight several key areas that require attention after migrating Omnistudio components.
Review the Migration Reports (Vlocity Industries Managed Package or Omnistudio Foundation Package and Standard Data Model): When you run the Omnistudio Migration Assistant in Migrate mode, it generates migration reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These migration reports highlight several key areas that require attention after migrating Omnistudio components.
Update Remote Actions: To ensure that remote actions work as expected after you migrate from Omnistudio for Managed Packages to Omnistudio, update any Apex classes used in remote actions with the correct syntax.
Updates to Omnistudio Custom Functions: If you're on the managed package runtime with standard data model, Omnistudio automatically converts all custom functions in the user-defined syntax to the standard syntax when you switch to the Omnistudio standard runtime. For the custom data model, first use Omnistudio Migration Assistant (Pilot) to convert your records to the standard data model, then switch to the standard runtime to automatically convert the custom functions.
Modify Omniscript UI Behavior: You modify UI behaviors in an Omniscript to hide or show elements and errors conditionally. You can also trigger Salesforce platform events. When previewing large Omniscripts, you can hide the userProfile node.
Modify the Story List Page Limit (Managed Package): For the managed package runtime, set the number of records displayed on your Customer Story. When you add your Customer Story as a story-slds component, you can update the pageSize parameter from the default 10 to a different number. If the API returns no page limit, the Page Limit number set in Setup > Custom Settings > Story List Page Limit is used instead.
Move OmniOut into Your App (Managed Package): For the managed package runtime, generate a compiled dist folder to move OmniOut into your app project before deploying your app to a content management system.
Multi-Select Properties (Managed Package): For the managed package runtime, Multi-Select properties are configurable from the Properties panel when you select a Multi-Select element. With the Multi-Select element, enable users to select one or more items from one or more options in your Omniscript.
Multiple Related Object Loads (Link Mappings) (Managed Package): For the managed package runtime, when loading data into a sequence of objects, you can propagate data directly from one object to another related object. For example, you can use an Omnistudio Data Mapper Load to support an Omniscript that creates an Account and a Contact for the Account.
Multiple Related Object Loads (Link Mappings): When loading data into a sequence of objects, you can propagate data directly from one object to another related object. For example, you can use an Omnistudio Data Mapper Load to support an Omniscript that creates an Account and a Contact for the Account.
Navigate Action (Managed Package): For the managed package runtime, navigate to various Salesforce experiences from Omniscript using the Navigate Action element.
Navigate from a Flexcard with the Navigate Action (Managed Package): For the managed package runtime, navigate to an external web address, or within Lightning Experience, Lightning communities, or the Salesforce mobile app from a Navigate Action element on a Flexcard. For example, allow a user to navigate to a Policy record page by clicking an action element on a Flexcard that lists Account Policies.
Set Up Navigation on a Flexcard: Enable navigation to an external URL, a Lightning page, a page in an Experience Builder Aura site, or any Salesforce page. For example, when a policyholder views their account policies on a Flexcard, they can click a button that opens a selected policy record page.
Navigate to a Community Login or Logout (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, direct users from an Omniscript to a Community Login or Logout page for authentication.
Navigate to a Component (Managed Package): For the managed package runtime, navigate to Aura components and Lightning web components from an Omniscript by using the Component PageReference Type.
Navigate to a Knowledge Article (Managed Package): For the managed package runtime, display a Knowledge Article in an Omniscript by selecting the Navigate Action's Knowledge Article PageReference Type.
Navigate to a Named Page or Community Named Page (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, direct users to a standard or community page by using the Named Page or Community Named Page PageReference Type.
Navigate to a Navigation Item (Managed Package): For the managed package runtime, navigate from an Omniscript to a custom tab displaying mapped content by using the Navigate Action Navigation Item PageReference Type.
Navigate to a Record Page (Managed Package): For the managed package runtime, navigate from an Omniscript to a Record page by using Navigate Action's Record PageReference Type.
Navigate to a URL from a Flexcard in an OmniOut App (Managed Package): For the managed package runtime, direct users to different URLs from a Flexcard in an OmniOut app using the Navigate action type. OmniOut for Flexcards supports only the Web Page target type. Application authors must decide how to handle the generated URLs based on the project's unique requirements.
Navigate to a URL from an Omniscript in an OmniOut App (Managed Package): For the managed package runtime, direct users to different URLs from an Omniscript in an OmniOut app using the Navigate Action. Configure endpoints in the Navigate Action and create redirects for the URLs in your OmniOut app. OmniOut supports all Navigate Action types, including URL generation and browser location updates. Application authors must decide how to handle the generated URLs based on the project's unique requirements.
Navigate to an App (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, Direct users from an Omniscript to a standard App, custom App, or a page within an App using Navigate Action's App PageReference Type.
Navigate to an Object Page (Managed Package): For the managed package runtime, navigate from an Omniscript to an Object page by using the Navigate Action's Object PageReference Type.
Navigation Between Steps (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20, learn which mixins you can set on the steps of an Omniscript so that users can navigate between those steps.
Navigate to the Current Page (Managed Package): For the managed package runtime, update and navigate to the current page from an Omniscript by using the Current Page PageRefrence Type in a Navigate Action.
Numeric Ranges in Calculation Matrices (Managed Package): For the managed package runtime, when you configure numeric ranges for a matrix, values below the lowest level that you configure are treated as the lowest value, and values above the highest value that you configure are treated as the highest value configured for the matrix.
Object Deployment and Comparison (Managed Package): For the managed package runtime, after you have configured a project, you can deploy objects from the Source to the Target. After the initial deployment, you can compare objects in the Source and Target to see if any have been updated and need to be deployed again. You can also save objects in the Source to DataPacks.
Object Deployment and Comparison Options (Managed Package): For the managed package runtime, after you’ve configured a project, you can deploy objects from the source to the target. After the initial deployment, you can compare objects in the source and target to see if any have been updated and need to be deployed again. You can also save objects in the source to data packs.
Object Field Mapping (Managed Package): For the managed package runtime, on the Fields tab, you map data from the Omnistudio Data Mapper Load input JSON to the target Salesforce object and field. You can also handle data types, attributes, and default values.
Configure an Omnistudio Data Mapper Load: Configure a Data Mapper Load by specifying the object type and filters. To enhance the performance of the Data Mapper Load, you can define formulas, add fields to write data to, and configure additional properties.
Create an External Tracking Configuration: Third-party analytics vendors require an External Tracking Configuration in addition to a Tracking Group. The steps in this task are for Google Analytics.
Create Flexcard Event Types: External Tracking Event Types arrange Flexcard data in the format that a third-party analytics provider expects. The steps in this task are for Google Analytics Ecommerce.
Create Google Analytics Trusted URLs: For OmniAnalytics and Google Analytics to communicate, your Salesforce org must trust the Google Analytics websites.
Create Omniscript Event Types: External Tracking Event Types arrange Omniscript data in the format that a third-party analytics provider expects. The steps in this task are for Google Analytics and Google Tag Manager Ecommerce.
Add Tracked Components to a Lightning App Page: Users interact with Omniscripts and Flexcards via Lightning App Pages. However, instead of directly adding Omniscripts and Flexcards to pages, you add wrapper components that make the Omniscripts and Flexcards available to OmniAnalytics.
Enable OmniAnalytics and Store Tracking Data: To enable OmniAnalytics, configure settings that determine whether OmniAnalytics is enabled and whether OmniAnalytics data is stored in OmniTrackingEvent platform events, Decision Explainer Service stores, or both.
Create Inclusion Rules for Event Types: Add an Inclusion Rule to an External Tracking Event Type to determine whether the event is sent to a third-party analytics vendor.
Using OmniAnalytics to Track User Engagement in Omniscripts and Flexcards: Use OmniAnalytics to track user interactions to answer questions such as which advertisements get the most responses and how many users who begin a purchasing process complete it. OmniAnalytics can track user interactions with Omniscripts and Flexcards with or without a third-party system such as Google Analytics.
View Tracked Data in the Tracking Group: After you add tracked components to a Lightning App page, you generate and view reports of the tracked data in the tabs for these components on the Tracking Group page.
Setting Up Third-Party Tracking and Event Types: An External Tracking Definition specifies a third-party analytics account and tag manager that the OmniAnalytics tracking data is sent to. External Tracking Event Types specify data formats for specific events.
Configure Internal OmniAnalytics: OmniAnalytics can track user interactions with Omniscripts and Flexcards without the use of a third-party analytics provider.
Configure OmniAnalytics with Google Analytics: OmniAnalytics tracks user interactions with Omniscripts and Flexcards by integrating with Google Analytics 4 (GA4) and Google Tag Manager.
Adding Ecommerce Data to the Example Omniscript for OmniAnalytics: Google Tag Manager Ecommerce requires specific kinds of data. You must add this data to the Messaging Framework Omniscript properties. When the Omniscript runs, it sends this data to Google Analytics.
OmniForm (Managed Package): For the managed package runtime, OmniForm is an omnichannel tool that enables you to build single-step, dynamic customer interactions.
OmniOut (Managed Package): For the managed package runtime, run LWC Omniscripts and Flexcards off-platform on third-party websites with OmniOut for Omniscripts and OmniOut for Flexcards. Display Omniscripts and Flexcards and connect to Salesforce from a content management system's (CMS) external website. Run an Omniscript or Flexcard on your external site by adding the component to the OmniOut project, integrating OmniOut into your application, and deploying your application to your CMS.
OmniOut Support for Native Mobile (Managed Package): For the managed package runtime, you can use OmniOut to run OmnScripts on native mobile apps for both iOS and Android with a few exceptions for select settings, actions, and functions.
OmniOut Supported Components (Managed Package): For the managed package runtime, as of Summer '24, certain Salesforce and Omnistudio Lightning web components are supported with OmniOut and off-platform. To ensure that your Omnistudio implementations work with OmniOut, use only the supported components.
Customize Omniscript Behaviors, Style, and Elements: To meet your business needs and improve user experience, you can customize Omniscripts for their style and appearance and for their actions. Apply custom styling via static resources, global stylesheets, or SLDS design tokens. Modify Omniscripts to conditionally hide or show elements and errors and to trigger platform events. For more complex customization, you can extend Omniscript elements to add custom behavior and styling. Finally, you can create custom Lightning web components (LWCs) to add custom HTML, JavaScript, and CSS.
Omniscript Action Elements: Use action elements in an Omniscript for executing actions, such as get or update data from one or more Salesforce objects, call a series of actions, send emails or documents for signature, redirect to different pages. Action elements can be either rendered as a button when placed in a Step or Block or run remotely if placed between steps. In either case, you can specify a redirect page, where the user can proceed to the next step or action, or if a button, back to the source step.
Omniscript Basics (Managed Package): For the managed package runtime, a Vlocity Omniscript guides users through complex processes with fast, personalized, and consistent responses. For example, you can create an Omniscript to guide:
Understand Omniscripts: An Omniscript guides users through complex processes with fast, personalized, and consistent responses.
Omniscript Best Practices (Managed Package): For the managed package runtime, enhance the performance and usability of Omniscript by following the Omniscript best practices whenever possible.
Omniscript Best Practices: Enhance the performance and usability of Omniscripts by following the recommended Omniscript best practices.
Omniscript Custom Label Reference (Managed Package): For the managed package runtime, this page contains tables listing the Omniscript element properties for which you must define custom labels and translations for multi-language Omniscripts, such as Omnistudio Data Mapper actions. To use a default translation, clear the property.
Omniscript Custom Label Reference: Review the Omniscript element properties for which you must define custom labels and translations for multi-language Omniscripts. To use a default translation, clear the property.
Omniscript Data and External Integrations (Managed Package): For the managed package runtime, Omniscript handles data and external integrations through Action, Group, and Input elements use Omnistudio Data Mappers, Integration Procedures, HTTP Actions, and Apex to load, transform, and post data.
Omniscript Display Elements: Use the Omniscript Display elements to display rich text and images on the screen to enhance the user interface. The display elements include Line Break and Text Block.
Omniscript Element Reference (Managed Package): For the managed package runtime, this guide contains explanations of the different elements that can be added to an Omniscript, such as Omnistudio Data Mapper actions. Each element uses an extendable Lightning web component or customizable HTML template. There are separate templates used for Lightning Player and Classic Player. Classic Player is no longer supported, however, Classic templates for Summer 17 and v15 are still available.
Omniscript Element Reference: The available elements are Omniscripts are organized as groups, Data Mapper actions, standard actions, display elements, functions, input, and Omniscripts (to embed reusable Omniscripts). Each element uses an extendable Lightning web component (LWC).
Omniscript Event Tracking (Managed Package): For the managed package runtime, for Omniscripts, the following events are tracked. For Outcome events, the user's SaveForLater and Cancel events are logged by default. To configure the value logged for a Done action, set its Outcome property.
Omniscript Function Elements (Managed Package): For the managed package runtime, this page contains a table explaining the available Omniscript elements listed under the Function section.
Omniscript Function Elements: From the Omniscript function elements, use the formula element to preform calculations that require complex calculations. For array input, use the aggregate element for complex calculations. The Messaging element displays comments, requirements, success, and warning messaging depending on whether the validate expression is true or false.
Omniscript Group Elements (Managed Package): For the managed package runtime, this page contains a table explaining the available Omniscript elements listed under the Groups section.
Omniscript Group Elements: From the group category, you can organize Omniscript elements. Use step elements to divide the Omniscript into sections. Use edit blocks to group input elements for users to add, edit, or delete records. Create a questionnaire with the radio group element. Use the type ahead block to display a list of results when a user begins typing in an input field.
Omniscript Input Elements (Managed Package): For the managed package runtime, this page contains a table explaining the available Omniscript elements listed under the Inputs section. Lightning Player and Newport Player templates are available for all Input components.
Omniscript Input Elements: When users to change, add, or delete data, add an Omniscript element for a specific type of data, such as email addresses, files, dates, passwords. You can also show information and allow users to select from a list of options, such as radio, checkboxes, multi-select, select, and disclosure elements.
When to Use Flexcards and Omniscripts: Omniscripts and Flexcards have many basic similarities: Both are user interfaces, can pull data from multiple sources, and can be interactive. To decide when to use Flexcards or Omniscripts, consider if the purpose is to only show data or if users are likely to require complex interactive UIs.
Omniscript ReadMe Reference (Managed Package): For the managed package runtime, this page lists the Lightning web components ReadMes available for Omniscripts. Extend Lightning web components to add custom behavior and styling.
Omniscript ReadMe Reference: This page lists the Lightning web components ReadMes available for Omniscripts. Extend Lightning web components to add custom behavior and styling.
Omniscripts (Managed Package): For the managed package runtime, an Omniscript is an omnichannel customer engagement and a business tool built on the Salesforce platform. Omniscripts allow you to craft dynamic customer interactions without code and deploy to multiple channels and devices. You can define a script once and then deploy the script within a Salesforce application or on a web page.
Omniscripts: Omniscripts help you create dynamic customer interactions with low code and deploy them to multiple channels and devices. You can create an Omniscript and then deploy it on a Salesforce application, a mobile device, an Experience Cloud site, or a web page.
Omniscripts Checkbox Element (Managed Package): For the managed package runtime, enable users to select a checkbox by adding the Checkbox element to your Omniscript. For example, map the user's yes/no answer to a true/false field in a record.
Omniscripts Checkbox Element: Enable users to select a checkbox by adding the Checkbox element to your Omniscript. For example, map the user's yes or no answer to a true or false field in a record. Checkbox is a boolean input control and returns true or false to the Data JSON.
Considerations for Single-Language Omniscripts: Omnistudio provides translations for system labels, such as standard error messages. In your single-language Omniscripts, these translations automatically appear based on the user's locale. For example, if the user’s locale is set to Japanese, all system-generated error messages also appear in Japanese.
Omniscripts Currency Element (Managed Package): For the managed package runtime, enable users to enter a currency amount by adding the Currency element to your Omniscript. Update default format options such as the number of decimal places to display, minimum and maximum currency value, and more.
Omniscripts Currency Element: Enable users to enter a currency amount by adding the Currency element to your Omniscript. Update default format options such as the number of decimal places to display, minimum and maximum currency value, and more.
Omniscripts Date Element (Managed Package): For the managed package runtime, enable users to select a date from a date picker by adding a Date element to your Omniscript. Set the minimum and maximum dates and the date format.
Omniscripts Date Element: Enable users to select a date from a date picker by adding a Date element to your Omniscript. Set the minimum and maximum dates and the date format.
Omniscripts Date/Time Element (Managed Package): For the managed package runtime, enable users to select a date from a date picker and a time from a list by adding the Date/Time element to your Omniscript. Set the minimum and maximum dates, and the date and time formats.
Omniscripts Date/Time Element: Enable users to select a date from a date picker and a time from a list by adding the Date/Time element to your Omniscript. Set the minimum and maximum dates, and the date and time formats.
Omniscripts Disclosure Element (Managed Package): For the managed package runtime, enable users to agree to a disclosure statement by adding a Disclosure element to your Omniscript. Enter the copy in a rich text editor.
Omniscripts Disclosure Element: To allow users to agree to a disclosure statement, add a Disclosure element to your Omniscript. Enter the copy in a rich text editor.
Omniscripts Email Element (Managed Package): For the managed package runtime, enable users to enter an email address by adding the Email element to your Omniscript. Update the default allowable format with Validation Options.
Enter an Email Address in Omniscripts: Enable users to enter an email address by adding the Email element to your Omniscript. Update the default allowable format with Validation Options.
Use and Modify Data in Omniscripts: After an Omniscript retrieves data, it can then work with and transform, rename, or convert the data. You can use a Data Mapper Transform element, an Integration Procedure element, or a formula element. For example, if you have user input and data from an external source, you might need to combine data, remove duplicates, and put the data into a consistent format.
Omniscripts Multi-Select Element (Managed Package): For the managed package runtime, enable users to select from multiple items by adding the Multi-select element to your Omniscript. Display options vertically, horizontally, or as an image.
Omniscripts Multi-Select Element: Enable users to select from multiple items by adding the Multi-select element to your Omniscript. Display options vertically, horizontally, or as an image. Read-only Multi-Select images show in grayscale, but you can use a custom CSS to them in color.
Restore Color for Read-Only Multi-Select Element Images (Managed Package): For the managed package runtime, read-only Multi-Select element images render in grayscale. To restore color for these images, create a .css file, save it as a static resource, then reference it in the Custom Lightning Stylesheet File Name property in Omniscript Setup.
Omniscripts Number Element (Managed Package): For the managed package runtime, enable users to enter a number by adding the Number element to your Omniscript. Limit what the user can enter by setting a mask.
Omniscripts Number Element: Enable users to enter a number by adding the Number element to your Omniscript. Limit what the user can enter by setting a mask.
Omniscripts Password Element (Managed Package): For the managed package runtime, enable users to enter a password by adding the Password element to your Omniscript. Set the minimum and maximum lengths of the password.
Omniscripts Password Element: Enable users to enter a password by adding the Password element to your Omniscript. Set the minimum and maximum lengths of the password.
Omniscripts Radio Element (Managed Package): For the managed package runtime, enable users to select one from multiple items by adding the Radio element to your Omniscript. Display options vertically, horizontally, as an image, or styled based on the Newport Design System.
Omniscripts Radio Element: Enable users to select one from multiple items by adding the Radio element to your Omniscript. Display options vertically, horizontally, or as an image.
Omniscripts Range Element (Managed Package): For the managed package runtime, enables users to select a number from a specified range by adding the Range element to your Omniscript. Specify the increment values and use both dynamic and static values to define the minimum and maximum values for the range.
Omniscripts Range Element: Enables users to select a number from a specified range by adding the Range element to your Omniscript. Specify the increment values and use static values to define the minimum and maximum values for the range.
Omniscripts Select Element (Managed Package): For the managed package runtime, enable users to select from a dropdown by adding a Select element to your Omniscript. Users can enter text to filter the options. Omnistudio pulls the options from an Apex class and method or from a Salesforce object.
Omniscripts Select Element: Enable users to select from a dropdown by adding a Select element to your Omniscript. Users can enter text to filter the options. Omnistudio pulls the options from an Apex class and method or from a Salesforce object.
Omniscripts Telephone Element (Managed Package): For the managed package runtime, enable users to enter a phone number by adding a Telephone element to your Omniscript. Limit the length and format of the number the user can enter.
Omniscripts Telephone Element: Enable users to enter a phone number by adding a Telephone element to your Omniscript. Limit the length and format of the number the user can enter.
Omniscripts Text Area Element (Managed Package): For the managed package runtime, enable users to enter multiple lines of text by adding a Text Area element to your Omniscript. Limit the number of characters the user can enter.
Omniscripts Text Area Element: Enable users to enter multiple lines of text by adding a Text Area element to your Omniscript. Limit the number of characters the user can enter.
Omniscripts Text Element (Managed Package): For the managed package runtime, enable users to enter a line of text by adding the Text element to your Omniscript. Limit the length of the text using minimum and maximum values and set allowable information using the mask property.
Omniscripts Text Element: Enable users to enter a line of text by adding the Text element to your Omniscript. Limit the length of the text using minimum and maximum values and set allowable information using the mask property.
Omniscripts Time Element (Managed Package): For the managed package runtime, enable users to select from a list of times by adding the Time element to your Omniscript. Format the display and set the time intervals.
Omniscripts Time Element: Enable users to select from a list of times by adding the Time element to your Omniscript. Format the display and set the time intervals.
Omniscripts URL Element (Managed Package): For the managed package runtime, enable users to enter a website address by adding the URL element to your Omniscript. For example, a user can enter https://salesforce.com, or https://www.salesforce.com, and so on.
Omniscripts URL Element: Enable users to enter a website address by adding the URL element to your Omniscript. For example, a user can enter https://salesforce.com, or https://www.salesforce.com, and so on.
Omnistudio SLDS 2 Theme: Salesforce provides the Salesforce Lightning Design System (SLDS) as a theme that offers resources for building applications consistent with the Salesforce Lightning principles, design language, and best practices. Starting in Spring ‘25, Salesforce provides the SLDS 2 theme, which is the enhanced version of SLDS with updates to the CSS. With the introduction of the Omnistudio SLDS 2 theme, you can use the advantages of SLDS, SLDS 2, and its enhanced user experience (UI) to improve the UI of your Omnistudio applications at runtime. The Omnistudio SLDS 2 theme fully aligns with the standard SLDS and SLDS 2 theme in your Salesforce org.
Supported Features in Omnistudio and Omnistudio for Managed Packages (Managed Package): For the managed package runtime, this page lists the differences in the available components and supported features in Omnistudio and Omnistudio for Managed Packages. Omnistudio for Managed Packages components are built using custom objects in the Omnistudio managed package runtime. Omnistudio, which uses Salesforce standard objects and the Omnistudio standard runtime, doesn’t support all the features available in Omnistudio for Managed Packages components.
Learn about Omnistudio: Build Service Consoles and Industry Cloud Apps with the basic building blocks of Omnistudio.
Supported Data Mapper and Integration Procedure Data Types: Understand data types to determine the kinds of values you can use with operators and pass to functions. Data types also define the kinds of values that functions can return. Topics related to data types include constants that have special meaning and error cases that you can encounter.
Supported Data Mapper and Integration Procedure Functions: Use functions to evaluate and manipulate data in formulas for Omnistudio Data Mappers and Integration Procedures. For example, functions can perform conditional operations that take different actions depending on the values you pass them. They can invoke queries and other functions, and they can operate on numbers, dates and times, strings, lists and arrays, and JSON objects.
Supported Data Mapper and Integration Procedure Operators: Use operators to develop more complex formulas for Omnistudio Data Mappers and Integration Procedures. For example, operators can perform logical, comparison, or mathematical operations on values in expressions. Operators are evaluated according to a strict precedence.
Omnistudio Data Mappers: Use Omnistudio Data Mappers to declaratively retrieve, write, and modify data between Salesforce and other Omnistudio components. While you can process data with custom code (such as Apex classes), Omnistudio Data Mappers are faster to build, easier to update, and simpler to manage. They’re also reusable, helping you to move solutions quickly from development to production.
Omnistudio Design Assistant: Use Omnistudio Design Assistant to get real-time feedback on component health, design quality, complexity, performance, and best practices during the design stage of your Flexcards and Omniscripts. Use this feedback to create or refine the Omniscript and Flexcard designs, and use the system resources more optimally to prevent issues such as high latency, low throughput, and resource overuse during the design stage, and potential run-time failures.
Recommended Limits: When you approach, reach, or exceed the recommended limits while using Flexcards and Omniscripts, an informational or warning message appears on the Omnistudio UI. For more information, click the informational or warning message icon.
Monitor and Manage Your Flexcards and Omniscripts: Use Omnistudio Design Assistant to monitor and proactively manage the overall health of your Flexcards and Omniscripts during the design stage, and implement best practices.
Enable Omnistudio Data Mapper Versioning: Manage different versions of your Data Mappers by enabling the Data Mapper Versioning setting. Enabling this feature activates existing standard Data Mappers as version 1 and prevents the editing of active components to ensure consistency. Your implementation automatically uses the active version of a referenced Data Mapper. By default, the Data Mapper Versioning setting is disabled.
OmniStudio-First Side-by-Side Package Installation Results: If both OmniStudio Standard and Salesforce Industries packages are installed in that order, both OmniStudio Standard and OmniStudio for Vlocity features are accessible, with a few exceptions.
Omnistudio Flexcards: Build industry-specific UI components and applications on the Salesforce platform by creating Omnistudio Flexcards in a visual editor. Show Salesforce object information with clickable actions that adapt to the context and type of data, helping your team handle tasks more efficiently. Flexcards are built with the Lightning Component framework.
Omnistudio for Managed Packages: Omnistudio for Managed Packages is a set of services, components, and data model objects for creating guided interactions using your Salesforce data, and external sources. (Omnistudio for Managed Packages was formerly called Omnistudio for Vlocity.)
Omnistudio for Managed Packages Basics: Review the basics of Omnistudio for Managed Packages that you use to build Service Consoles and Industry Cloud Apps.
Naming Conventions in Omnistudio for Managed Packages (Managed Package): For the managed package runtime, follow the recommended naming conventions when you create an Omnistudio for Managed Packages component, such as an Omnistudio Data Mapper, a Flexcard, an Integration Procedure, or an Omniscript.
Omnistudio Formulas and Functions: Use operators and functions to create formulas for Omnistudio Data Mappers and Integration Procedures.
Omnistudio Hybrid: Omnistudio Hybrid enables a dual-environment configuration that allows you to access both managed package and Omnistudio standard designers and runtimes within the same org.
Omnistudio Hybrid Compatibility Matrix: Use this matrix to determine the active designer and runtime environment based on your org settings and object type.
Omnistudio Integration Procedures: Use Omnistudio Integration Procedures to declaratively automate data interactions between Salesforce and external third-party applications. Integration Procedures handle complex data transformations, API calls, and event-driven automation, and they can execute multiple actions in a single server call.
Get Started with Omnistudio: Omnistudio provides a comprehensive, low-code suite of services and components, designed to build engaging, industry-specific digital experiences. It accelerates the path from development to production, enabling you to create guided customer interactions by using data from Salesforce and external sources.
Omnistudio Lightning Web Components: Take advantage of Omnistudio's declarative 'clicks not code' approach to building and modifying your applications with the Omnistudio Lightning Web Components. With Omnistudio Lightning Web Components, use standard JavaScript and HTML to modify and extend Vlocity products.
Omnistudio Limits and Considerations: Omnistudio provides a set of tools and components that help you design, automate, and manage digital experiences and guided business processes. These include Omniscripts, Flexcards, Data Mappers, Integration Procedures, and other runtime components that work together to deliver configurable, scalable solutions across industries.
Migration Phase 1: Development Sandbox (Vlocity Industries Managed Package and Standard Data Model): In Phase 1, prepare your development and testing sandboxes, upgrade to the required managed package versions, and provision licenses. Migrate calculation logic to Business Rules Engine. Next, run the Omnistudio Migration Assistant in Assess mode to identify issues and confirm readiness. After resolving any manual interventions, run the tool in Migrate mode to move components and related objects to the Omnistudio standard runtime. Finally, validate the migration by reviewing reports, updating integrations, and testing business workflows in your sandboxes.
Omnistudio Naming Conventions: When creating an Omnistudio component, such as an Omnistudio Data Mapper, Flexcard, Integration Procedure, or an Omniscript, follow the naming conventions on this page.
Omnistudio on Experience Cloud: Use Omnistudio to enhance your Experience Cloud sites by showing key contextual information and creating dynamic interactions.
Omnistudio Permission Sets: Grant permissions to administrators to create and manage Omnistudio objects, such as Flexcards, Omniscripts, Integration Procedures, and Omnistudio Data Mappers. Grant consumers permission to view only Omniscript objects.
Omnistudio Permission Sets: Grant permissions to administrators to create and manage Omnistudio objects, such as Flexcards, Omniscripts, Integration Procedures, and Omnistudio Data Mappers. Grant consumers permission to view only Omniscript objects.
Omnistudio Installation and Upgrade: Install or upgrade Omnistudio in your org with the Omnistudio Foundation package. Your tasks include pre-requisite steps, package installation, and post-install or post-upgrade tasks. If your org isn't automatically updated or if you need to install Omnistudio, download the package with a unique link for each release.
Security Checks for Omnistudio: The security checks for Omnistudio enforce stricter validation of access and permissions. These checks make sure that users, including guest, authenticated, and non-authenticated users, have the appropriate access to objects and fields used within Omnistudio components.
Omnistudio Settings: Enable settings applicable to the entire Omnistudio product suite from the Omnistudio Settings page in your org's Setup. For example, enable Omnistudio metadata API support from the Omnistudio Metadata setting.
Omnistudio sObject Descriptions: The table on this page lists Omnistudio sObjects, their descriptions, and which objects you must grant read access to so that customers can view Omnistudio components.
Omnistudio: Omnistudio provides a suite of services, components, and data model objects that combine to create Industry Cloud applications. Create guided interactions using data from your Salesforce org and external sources. Omnistudio is available to select Industry Cloud customers.
Open Knowledge Base Articles Outside an Omniscript (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, launch Knowledge base articles outside of an Omniscript using the Vlocity Omniscript Knowledge Base component in a Community or Lightning page.
Opening Knowledge Base Articles Outside of a Classic Omniscript (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, launch Knowledge articles outside of an Omniscript using the Vlocity Omniscript Knowledge Base component in a Community or Lightning page.
Override an Edit Block LWC (Managed Package): For the managed package runtime, apply custom code to an Edit Block by extending and overriding the Edit Block's lightning web components. Edit Blocks contain up to three LWC override fields based on the Edit Block's Edit mode.
Override an Edit Block LWC in Omniscripts: Apply custom code to an Edit Block by extending and overriding the Edit Block's lightning web components. Edit Blocks contain up to three LWC override fields based on the Edit Block's Edit mode.
Override an Element's Lightning Web Component (Managed Package): For the managed package runtime, override an element's component using the element's LWC Component Override. The custom LWC must extend the element's component because Omniscript passes in properties specific to the original component that the custom component is overriding.
Overwrite Edit Block Values in Omniscripts: Overwrite the number of children in an Edit Block in an Omniscript. You can also set the Edit Block's value to null in between steps.
Overwrite Global Newport and Lightning Styles for Specific Flexcards (Managed Package): For the managed package runtime, overwrite the global Newport or Lightning styles for a specific Flexcard. Load new custom styles as a static resource from the Setup panel in the Flexcard Designer. For example, apply specific branding requirements across multiple components on a Flexcard.
Page Through Sorted Data Using Data Values (Managed Package): For the managed package runtime, if an Omnistudio Data Mapper Extract is expected to retrieve a lot of records, you can use paging to retrieve a few at a time based on field values. For example, you can page through Accounts by Id.
Use Data Values and Page Through Sorted Data: If an Omnistudio Data Mapper Extract is expected to retrieve numerous records, you can use paging to retrieve a few at a time based on field values. For example, you can page through Accounts by Id.
Page Through Sorted Data Using Offsets (Managed Package): For the managed package runtime, if an Omnistudio Data Mapper Extract is expected to retrieve a lot of records, you can use paging to retrieve a few at a time based on OFFSET values. For example, you can page through Contacts by last name.
Page Through Sorted Data Using Offsets: If an Omnistudio Data Mapper Extract is expected to retrieve numerous records, you can use paging to retrieve a few at a time based on OFFSET values. For example, you can page through Contacts by last name.
Pass Concatenated Strings As Values in Flexcards (Managed Package): For the managed package runtime, pass concatenated strings as the value for supported Flexcard element properties. For example, pass a breadcrumbs path like {Parent.parentPath}>{Parent.type}>{Name} in the Value property of an Attribute of a child Flexcard.
Pass Data From a Child Flexcard to a Parent Flexcard (Managed Package): For the managed package runtime, after embedding a child Flexcard inside another Flexcard, you can pass data from the child to its parent. Pass the data to the parent as input parameters from a Custom Event action on the child. Use an event listener to listen for the event and execute a Set Values action to update data fields on the parent.
Pass Data from an LWC Omniscript to an Embedded Flexcard (Managed Package): For the managed package runtime, to populate data fields and perform actions on a Flexcard embedded in an LWC Omniscript, you can pass data from an Omniscript's data JSON to the Flexcard. Embed a Flexcard inside an LWC Omniscript with the Custom Lighting Web Component element.
Pass Data from an Omniscript to an Embedded Flexcard: To populate data fields and perform actions on a Flexcard embedded in an Omniscript, you can pass data from an Omniscript's data JSON to the Flexcard. Embed a Flexcard inside an Omniscript with the Custom Lightning Web Component element.
Password Properties (Managed Package): For the managed package runtime, password properties are configurable from the Properties panel when you select a Password element. With the Password element, enable users to enter a password in your Omniscript.
Platform Event Data Source (Managed Package): For the managed package runtime, platform Events are part of Salesforce’s enterprise messaging platform. A Platform Event combines PushTopic and Streaming Channel to enable apps to communicate inside and outside of Salesforce. Instead of working with an sObject, Platform Events work with custom objects.
Platform Event Data Source (Managed Package): For the managed package runtime, configure a Platform Event data source to enable apps to communicate inside and outside of Salesforce.
Populate Elements (Managed Package): For the managed package runtime, populate subsequent input elements with values from data JSON, formula operators, functions, concatenations, and static values. Prefill an element directly from an Omnistudio Data Mapper or Action response whenever possible. When a previous element assigns a value to a subsequent input element's Name, the subsequent input element is populated with the assigned value.
Populating Dependent Picklist Values with Apex (Managed Package): For the managed package runtime, you can populate Select, Multi-select, and Radio elements from a Callable implementation. The values for the element are obtained during the Omniscript's activation.
Populating Picklist Values From Apex (Managed Package): For the managed package runtime, you can populate Select, Multi-select, and Radio elements from an Apex class that implements Callable and Vlocity Open Interface. The values for the element are obtained during the Omniscript's activation.
Post Salesforce Data from Omniscripts (Managed Package): For the managed package runtime, create and update sObjects and external objects from an Omniscript using the Omnistudio Data Mapper Post Action. If multiple actions are needed, use an Integration Procedure to host the Data Mapper Post Action and handle the requests.
Posting Data to the Application Object using the Post to Object Action (Managed Package): For the managed package runtime, you can submit an Omniscript directly to the Vlocity Application object using the Post to Object Action Element. The Vlocity Application object enables an in-progress Omniscript to be stored and resumed later. The Omniscript can be resumed by the original user, reviewed, or approved. This can either be a button on a Step or a remote action that runs between Steps. The entire JSON, including attachments, submits.
Prepare to Install the Omnistudio Package: Before you can install an Omnistudio package into an org that doesn't already have an Omnistudio package, you must prepare your browser and your Salesforce org. If you're upgrading Omnistudio, you can skip this task.
Preprocessor Class Example (Managed Package): For the managed package runtime, the following example shows the typical structure of a preprocessor Apex class for a declarative Calculation Procedure.
Preview a Flexcard (Managed Package): For the managed package runtime, preview your Flexcard's appearance and functionality before publishing it to a Lightning page or Experience Builder site. In Preview, test how your Flexcard looks on multiple devices and test the functionality of action links and other interactive elements.
Preview and Debug a Flexcard: Preview a Flexcard's appearance and test its functionality before you publish it to a Lightning page or to a page in an Experience Builder Aura site. Review how the Flexcard looks on multiple devices and test the functionality of interactive elements such as actions. Debug the Flexcard's data output, events, actions, and more.
Preview and Test an Omniscript: View the Omniscript's appearance and functionality by previewing the Omniscript in the Omniscript Designer.
Preview Event Tracking in the Cards Designer (Omnistudio for Managed Packages) (Managed Package): For the managed package runtime, typically, administrators who are tracing Cards Framework triggers want to track only runtime events. The Cards Framework includes a Track.CardPreview trigger for Card Designer Preview tracking entries, which you can disable to screen out preview events.
Preview and Test Data Mappers: You can preview and test the input and output of a Data Mapper in the Data Mapper Designer.
Previewing a Layout (Managed Package): For the managed package runtime, preview a card layout to see how your cards will look once published to a Lightning or Community page.
Previewing Omniscripts (Managed Package): For the managed package runtime, preview your Omniscript by clicking Preview to launch your script. When using an LWC Omniscript, click LWC Preview. From the Preview panel, you can navigate through the steps of the Omniscript, use the Debug console to view an action's request and response data, change the preview layout, or view the JSON data. The Preview view defaults to Lightning Universal Page. To change the layout, click the drop-down menu and select your desired layout from the available list.
Process Arrays Using Loop Blocks (Managed Package): For the managed package runtime, a Loop Block iterates over the items in a data array, enabling the Actions within it to repeat for each item. For example, in Salesforce Industries Communications, Media, and Energy, without a Loop Block, adding four products to a cart would require running four separate Remote Actions. But one Remote Action within a Loop Block can add all four products.
Programmatic Job Invocation (Managed Package): For the managed package runtime, use VlocityBatchFramework methods to start scheduled jobs with a Data Source Type of Query. You can start all jobs, multiple jobs, or a single job. You can also invoke an Integration Procedure or VlocityOpenInterface as a job.
Programmatic Job Invocation: Use VlocityBatchFramework methods to start scheduled jobs with a Data Source Type of Query. You can start all jobs, multiple jobs, or a single job. You can also invoke an Integration Procedure or VlocityOpenInterface as a job.
Publish Data Packs to Connected Orgs (Managed Package): For the managed package runtime, instead of managing data pack files manually, connect two orgs and publish data packs from the source org to a target that you configure as a Salesforce connected app. To connect two orgs and publish data packs from one to the other, you must create, authenticate, and configure the connected app.
Pubsub Component (Managed Package): For the managed package runtime, the Pubsub Component enables data sharing and passing messages between components that aren’t ancestors. Multiple components can register and receive data from the same channel.
PushTopic Data Source (Managed Package): For the managed package runtime, the Streaming Channel API type uses the Streaming API to send notifications of general events that are not tied to Salesforce data changes. Use the Streaming Channel API when you want to send and receive notifications based on custom events that you specify. You can use Streaming Channel API for any application that sends custom notifications, such as a Chat application.
PushTopic Data Source (Managed Package): For the managed package runtime, the Streaming Channel API type uses the Streaming API to send notifications of general events that are not tied to Salesforce data changes. Use the Streaming Channel API when you want to send and receive notifications based on custom events that you specify. You can use Streaming Channel API for any application that sends custom notifications, such as a Chat application. Streaming API is known as Generic Streaming in Salesforce.
Radio Group (Managed Package): For the managed package runtime, Omniscript's Radio Group enables you to create and display questions in a questionnaire format.
Radio Properties (Managed Package): For the managed package runtime, Radio properties are configurable from the Properties panel when you select a Radio element. With the Radio element, enable users to make a selection from one or more options in your Omniscript.
Range Properties (Managed Package): For the managed package runtime, Range properties are configurable from the Properties panel when you select a Range element. With the Range element, enable users to enter an email address in your Omniscript.
Ranges in Calculation Matrices (Managed Package): For the managed package runtime, a range takes a number or text value and assigns it to groups that you've defined. You can use data numeric ranges in calculation matrices and by collating by alphabetic ranges For example, if age is a component of your pricing, you can use a numeric range to map the applicant's age to the correct age group.
Reference Stylesheet Names in an Omniscript's JSON (Managed Package): For the managed package runtime, apply CSS changes to an Omniscript using SLDS or Newport styling by referencing a CSS file static resource in your Omniscript's JSON properties. For example, a CSS sheet can change the text color for every Number element in an Omniscript without using custom Lightning web components to override the Number element.
Register Dynamic Custom and Pubsub Events (Managed Package): For the managed package runtime, register events based on dynamic event and channel names. Use a parent attribute, a recordId, or a session variable within the Channel Name and Event Name of a pubsub event, or the Event Name of a custom event.
Relationship Notation versus Multiple Extract Steps (Managed Package): For the managed package runtime, using relationship notation improves the performance of Omnistudio Data Mappers that retrieve data from a parent of the primary sObject. You use this notation in the Extract JSON Paths for the parent sObject's fields instead of adding a second sObject in the Data Mapper's Extract tab. Two examples illustrate how to use relationship notation.
Relationship Notation versus Multiple Extract Steps: Using relationship notation improves the performance of Omnistudio Data Mappers that retrieve data from a parent of the primary object. Use this notation in the Extract JSON Paths for the parent object's fields instead of adding a second object in the Data Mapper's Extract tab.
Reload a Flexcard After Updating an LWC Omniscript in a Flyout (Managed Package): For the managed package runtime, update information on a Flexcard after saving changes to an LWC Omniscript embedded in a flyout. Add a flyout action on a Flexcard that triggers an event, and create an event listener on the card to refresh. When the card you want to refresh hears the event, it executes a Card Reload action.
Reloading a Card Layout After Updating Profile Attributes (Managed Package): For the managed package runtime, to reload a Card Layout after updating profile attributes, configure a Vlocity Cards Component Events component. Enable a Vlocity Cards Component Events component on a Lightning Page through the Lightning App Builder and on a Community Page through the Community Builder.
Reloading a Smart Card After Updating Profile Attributes (Managed Package): For the managed package runtime, to reload a card with Smart Actions when profile attributes update, add a Vlocity Profiler component on a Lightning or Community page. When profile attributes update, the Vlocity Profiler component fires a smartAction event that reloads Smart Actions on an LWC Card.
Remote Action (Managed Package): For the managed package runtime, call Apex classes from Omniscript using the Remote Action element.
Remote Action for Integration Procedures (Managed Package): For the managed package runtime, the Remote Action element calls the specified Apex class and method or the specified invocable action. You can also pass in invocation options and data. The Apex class must implement the VlocityOpenInterface2 or Callable interface.
Remote Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Remote Actions. A Remote Action calls the specified Apex class and method or the specified Invocable Action. You can also pass in invocation options and data.
Remove an Object from the Customer Story (Managed Package): For the managed package runtime, you can remove any of the preconfigured objects from the Customer Story. The Vlocity Customer Story displays a timeline of all interactions with the customer in a single, chronological feed.
Rename Data JSON Nodes (Managed Package): For the managed package runtime, simplify and rename JSON node names by accessing the values in an Omniscript's data JSON. Access data sent into the Omniscript's data JSON from a parameter, an action's response data, or an element using merge fields.
Repeat Options in the Flexcard Designer (Managed Package): For the managed package runtime, by default, a Flexcard loops through records returned from its data source. The Flexcard displays the list of records in containers called cards. For example, if a data source returns a list of active Cases for an Account, each card displays the Status, Priority, Subject, and any other data field or element added to a state.
Replacing Actions on an LWC Customer Story Card (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, the LWC Customer Story Card supports replacing the preconfigured list of actions with a custom list of actions. Each action creates a new record for a standard or custom sObject.
Response Action for Integration Procedures (Managed Package): For the managed package runtime, the Response Action ends an Integration Procedure and returns data to the entity that called it. It can also add data to the data JSON or end conditionally. Response Actions are useful for debugging Integration Procedures.
Response Action for Integration Procedures: The Response Action ends an Integration Procedure and returns data to the entity that called it. It can also add data to the data JSON or end conditionally. Response Actions are useful for debugging Integration Procedures.
Response Action Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Response Actions. The Response Action ends an Integration Procedure and returns data to the entity that called it.
Restart an Omniscript (Managed Package): For the managed package runtime, navigate a user to a new instance of the same Omniscript using the Navigate Action. Enable a user to start over or repeat a process using the Restart Omniscript Page Reference Type. Place the Navigate Action in a Step to render it as a button or outside of a Step to run it automatically or conditionally.
Restrictions and Limitations for Save and Resume (Managed Package): For the managed package runtime, restrictions and limitations exist for saving and resuming Omniscripts. Some configurations do not support save and resume. Some users are not allowed to perform save and resume, and some users require certain permissions to use the feature.
Retain the Designer Setting on Org Upgrade: When you upgrade the package installation in your org, if you're using the standard runtime and package designer, the designer switches to standard designer after upgrade. To retain the designer of your choice, enable the RetainDesignerSettingOnUpgrade Omni Interaction Configuration.
Review Action (Managed Package): For the managed package runtime, Skip Elements—Hides Steps, Blocks, or individual Elements from the Review page. To configure this element:
Reviewing or Modifying a Submitted Omniscript (Managed Package): For the managed package runtime, to enable a user to review or modify a submitted Omniscript in the Application object, modify the Application page layout to include the Review button and ApplicationDataJSONPage Visualforce section.
Row-Versioned Calculation Matrices (Managed Package): For the managed package runtime, if you're wrangling large calculation matrices that can't be sectioned cleanly into groups and subgroups, you can create calculation matrices that are versioned by row.
Run Flexcards Outside of Salesforce with OmniOut (Managed Package): For the managed package runtime, run Flexcards off-platform on third-party websites with OmniOut for Flexcards. Display Flexcards and connect to Salesforce from a content management system's (CMS) external website. Run a Flexcard on your external site by adding the component to the OmniOut project, integrating OmniOut into your application, and deploying your application to your CMS.
Run OmniOut in Development Mode (Managed Package): For the managed package runtime, view and test your Omniscript and Flexcard before adding it to your application by running it in development mode. Use a jsForce connection to request data from your org.
Run Test Procedures (Managed Package): For the managed package runtime, the Test dashboard lets you run Test Procedures (Integration Procedures that perform unit tests) and analyze the results of the tests.
Running Validation with onChange (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20, LWC Omniscripts run validation when a user clicks out of a field by using the onBlur function.
Sample Apex Code for a Custom Function in Omnistudio for Managed Packages (Managed Package): For the managed package runtime, an Apex class implements methods for three custom functions in Omnistudio for Managed Packages. Integration Procedures and Omnistudio Data Mappers can use these functions to convert a list to an array, replace one character with another, or reformat phone numbers. The class and invokeMethod of custom functions must be global.
Sample Apex Code for Custom Functions: Develop Apex classes to implement custom functions for use with Omnistudio Data Mappers and Integration Procedures. A sample Apex class implements three methods that can be called as custom functions in Omnistudio formulas. The class includes code that passes a list to a custom function.
Sample OmniOut App (Managed Package): For the managed package runtime, download, configure, and run a sample app to view an OmniOut app connection example. After running the sample app, modify it to host your LWC Omniscripts and Flexcards.
Save and Resume an Omniscript (Managed Package): For the managed package runtime, enable users to save and resume Omniscripts by using Omniscript's Save Options property. Users can bookmark links, launch a saved instance from an object page, or email the link. Configure custom URLs to resume saved Omniscript instances in different domains. For example, a customer can initiate an Omniscript inside of a Community, and then a customer service representative can resume the Omniscript inside of the Service Console.
Save and Resume an Omniscript: Enable users to save and resume Omniscripts by using Omniscript's Save Options property. Users can bookmark links, launch a saved instance from an object page, or email the link. Configure custom URLs to resume saved Omniscript instances in different domains. For example, a customer can initiate an Omniscript inside of an Experience Cloud page, and then a customer service representative can resume the Omniscript inside of the Service Console.
Data Save Inside of a Custom Component (Managed Package): For the managed package runtime, when the custom component doesn’t exist in the DOM, store the data in a state. To store data in a state, use the omniSaveState() function. The omniSaveState function accepts three arguments: a data object, a key, and a boolean.
Saving and Deploying an LWC Card in the Card Designer (Managed Package): For the managed package runtime, beginning with Vlocity Insurance and Health, Winter '20 and Vlocity CME Winter '20, use the Deploy feature in the Card Designer to update changes to your card, see the latest preview, and create the Lightning web component to add to a Community or Lightning page.
Seed Data Into an Omniscript (Managed Package): For the managed package runtime, prefill Omniscript fields with data or add hidden nodes to the Omniscript Data JSON using the Seed Data JSON property in the Omniscript's Setup section.
Seed Data Into an Omniscript: Prefill Omniscript fields with data or add hidden nodes to the Omniscript Data JSON using the Seed Data JSON property in the Omniscript's Setup section.
Select an Email Recipient: Select the ID of the Contact to whom the email in the Email Action example is to be sent.
Let Users Update an Omniscript by Selecting Records on a Flexcard (Managed Package): For the managed package runtime, let users select records in a list on a Flexcard by using the Select Cards action. For example, users can add and remove multiple shopping cart items, or select and deselect one or more cases from a list. When users click a Select Cards action, the selectcards_{listname} event fires and the selected record is added to a list whose name you can define. The Omniscript's data JSON is updated with the list of selected records.
Select One Child Across Multiple Parents on a Flexcard (Managed Package): For the managed package runtime, enable users to only select one child card from all child cards across multiple parents with the Select Cards action and the resetselectedcards event. Users can reset just the child cards across multiple parents, or reset all child cards and selectable parent cards as well.
Select Properties (Managed Package): For the managed package runtime, select properties are configurable from the Properties panel when you select a Select element. With the Select element, enable users to make a selection from a dropdown list in your Omniscript.
Send Data to the Error Log (Managed Package): For the managed package runtime, by default, the input to a failed step is sent to the InputData__c field in a Vlocity Error Log Entry SObject record. You can send data to a different Vlocity Error Log Entry field if a step fails.
Send Email from an Integration Procedure: To send email from an Integration Procedure, use an Email Action. You can either specify all the email field values or use a Salesforce email template.
Set a Custom Error Message That Returns as a String (Managed Package): For the managed package runtime, set a Custom Error Message for an error that returns as a string. A Custom Error Message returns based on a defined path and value. Set custom error messages for File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.
Set a Custom Error Message That Returns as an Object (Managed Package): For the managed package runtime, set a Custom Error Message for an error that returns as an object. A Custom Error Message returns based on a defined path and value. Set custom error messages for File elements, Image elements, all Action elements, Omniscript Script Configuration, and Setup.
Set a Default Value for an Element (Managed Package): For the managed package runtime, the Default Value property sets the JSON value of an element to a static value by default and exists on certain elements. The Default Value is overwritten if the element is prefilled from an Omnistudio Data Mapper or JSON response.
Set a Default Value for an Omniscript Element: The Default Value property sets the JSON value of an element to a static value by default. The default value is overwritten if the element is prefilled from an Omnistudio Data Mapper or JSON response. The Default Value property is available for the Input elements (except Custom LWC, Disclosure, File, Image, and Password).
Set a Private Variable at Runtime in a Flexcard (Managed Package): For the managed package runtime, set a private variable in a Flexcard to define and evaluate its value only at runtime, when the Flexcard is accessed in Preview or on a record page. Use the Set Values action to set the value of the Flex.varname private variable. You can then create a condition to display or hide content depending on the variable's value.
Set a Select Mode in Edit Block (Managed Package): For the managed package runtime, select modes enable users to change an Edit Block entry's boolean value in the data JSON by clicking on Edit Block entries.
Set a Select Mode in Edit Block: Select modes enable users to change an Edit Block entry's boolean value in the data JSON by clicking on Edit Block entries.
Set Date and Time Ranges (Managed Package): For the managed package runtime, the Date, Date/Time, and Time elements enable users to input dates and times into an Omniscript form. Each element has different properties that enable you to present a selectable range of dates or times to the User.
Set Date and Time Ranges: The Date, Date/Time, and Time elements enable users to input dates and times into an Omniscript form. Each element has different properties that enable you to present a selectable range of dates or times to the User.
Set Omnistudio Data Mappers to Use Managed Package Runtime and Objects (Managed Package): For the managed package runtime, when the Managed Package Runtime setting and Omnistudio permission set licenses are enabled, Data Mappers use processes on the Salesforce platform. To have them use the Apex processes in the managed package runtime and custom objects, set RollbackDRChanges to true. Each setting applies to all instances of the Data Mapper component.
Set Errors In an Omniscript (Managed Package): For the managed package runtime, put error or validation messaging on one or more elements in a previous step based on conditions from future steps using the Set Errors action element. Using required fields and Formula/Messaging elements, you can set requirements and conditions on elements only in the current step.
Set Errors in an Omniscript: To handle potential end-user errors, add an error or validation message on one or more elements in a previous step based on conditions from future steps with the Set Errors element. For example, an email address isn't required during the initial step, but in a future step, the user states that they wish to be contacted by email. The Set Errors element runs after the step and returns the user to the initial step with custom error messages.
Set Integration Procedures to Use Managed Package Runtime and Objects (Managed Package): For the managed package runtime, when the Managed Package Runtime setting and Omnistudio permission set licenses are enabled, Integration Procedures use processes on the Salesforce platform. To have them use the Apex processes in the managed package runtime and custom objects, set RollbackIPChanges to true. Each setting applies to all instances of the respective Data Mapper or Integration Procedure component.
Set the Default Error Message on an Omniscript Element (Managed Package): For the managed package runtime, replace a Default Error Message with a user-friendly error message when a remote apex call error occurs in your Omniscript. A default message returns when no custom error messages are matched or defined. Update the default error messages for Image, Action, and File elements.
Set the OmniOut Resource Path (Managed Package): For the managed package runtime, load your custom styling resources into your Adobe Experience Manager application by setting the correct resource paths.
Set Up a Flexcard in the Flexcard Designer (Managed Package): For the managed package runtime, configure optional settings for your Flexcard in the Setup panel of the Flexcard Designer. For example, update a data source, create an event listener, add session variables, and so on.
Configure Flexcard Settings: Specify your Flexcard’s behavior with the setup options. For example, add or update a data source, create an event listener, or add session variables.
Configure Omniscript Settings: Configure optional settings for your Omniscript in the Setup panel of the Omniscript Designer, such as making your Omniscript reusable or enabling logging.
Set Up Clean Metadata Deployment: Turn on Clean Metadata Deployment from Omnistudio Settings in Setup. Turn it on in both the source org and the target org.
Set Up Lightning Web Components (Managed Package): For the managed package runtime, to manage and develop Omnistudio Lightning web components, use Visual Studio Code with Salesforce DX or IDX Workbench. Both development approaches have source control. Salesforce DX integrates with Visual Studio Code. IDX Workbench lets you deploy components from one sandbox or dev org to another, such as a production org, and compare source and target files.
Set Up Lightning Web Components: To manage and develop Omnistudio Lightning web components, use Visual Studio Code with Salesforce DX and the SF CLI. Use to deploy components from one sandbox or dev org to another, such as a production org.
Set Values for Integration Procedures (Managed Package): For the managed package runtime, the Set Values action sets values in the data JSON of an Integration Procedure literally, using merge fields, or using formulas. This action has many uses. The example includes the most common uses.
Set Values in an Omniscript (Managed Package): For the managed package runtime, use the Set Values action to set element values in subsequent steps, rename JSON nodes, create dynamic values, and concatenate data. Set Values actions use merge fields to access JSON data in other Omniscript elements.
Set Values in an Omniscript: Use the Set Values action to set element values in subsequent steps, rename JSON nodes, create dynamic values, and concatenate data. Set Values actions use merge fields to access JSON data in other Omniscript elements.
Set Values Properties for Integration Procedures (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Set Values actions. The Set Values action sets values in the data JSON of an Integration Procedure literally, using merge fields, or using formulas.
Enable Autogenerated Numbers: To set up a numbering system and autogenerate numbers for various use cases, enable the Omni Global Auto Number setting on the Omnistudio Settings page.
Enable Enhanced Runtime Performance of Components: Improve component runtime performance by turning on Enhanced Runtime Performance on the Omnistudio Settings page. This setting ensures that Omnistudio communicates with the Salesforce Platform with in-platform capabilities instead of through Apex calls. It also allows Omnistudio components to be executed in user mode. User mode respects the access levels of the person performing an operation.
Settings for Long-Running Integration Procedures (Managed Package): For the managed package runtime, you can use chainable and queueable chainable settings to avoid hitting Salesforce governor limits when invoking long-running Integration Procedures. You can also chain on one or more specific long-running steps.
Settings for Long-Running Integration Procedures: You can use chainable and queueable chainable settings to avoid hitting Salesforce governor limits when invoking long-running Integration Procedures. You can also chain on one or more specific long-running steps.
Setup and Script Configuration Reference (Managed Package): For the managed package runtime, the Script Configuration defines the name, type, subtype, language, and currency of an Omniscript. The Script Configuration also provides multiple configuration options to define both the appearance and behavior of the Omniscript further.
Set Up Omniscript to Work with Salesforce Knowledge (Managed Package): For the managed package runtime, to let users search and view Salesforce Knowledge articles in an Omniscript, integrate Salesforce Knowledge into the Omniscript. Omniscript also supports querying Lightning Knowledge.
Set Up Send on Behalf of Another User for Omniscripts: To send or sign DocuSign on behalf of another user, create a Send On Behalf field in the User object and assign the Send on Behalf named credential from that field in the user’s page. If you want multiple users to send or sign on behalf of another user, assign the named credential to each user. When you log in, Salesforce checks whether a Send On Behalf setup exists. If it doesn’t, Salesforce sends or signs DocuSign using the default admin user.
Set Up Send on Behalf of Another User (Managed Package): For the managed package runtime, to send or sign DocuSign on behalf of another user, create a Send On Behalf field in the User object and assign the Send on Behalf named credential from that field in the user’s page. If you want multiple users to send or sign on behalf of another user, assign the named credential to each user. When you log in, Salesforce checks whether a Send On Behalf setup exists. If it doesn’t, Salesforce sends or signs DocuSign using the default admin user.
Show the Legacy Omnistudio UI: If using Omnistudio's legacy Angular UI is necessary to your implementation, turn on the ShowLegacyOmniStudioUi setting. All new implementations should be done using Omnistudio's LWC designers for future support. However, in rare cases, it may be necessary to turn on the legacy designers.
Add Apex Class Permissions Checkers: Enable specific access to the classes used by remote action APIs for each user profile, permission set, or permission set group. Configure Apex class permissions checkers to ensure that users require explicit access to the Apex class that administers the remote action called from an Omniscript, Flexcard, Integration Procedure, or REST API.
Standard Calculation Matrices (Managed Package): For the managed package runtime, all calculation matrices have the characteristics that standard calculation matrices have. Other types have characteristics that standard calculation matrices lack. All calculation matrices have input columns, output columns, and versions.
Create Interface Objects for a Data Mapper Load: Provide external data, such as a CSV file, as an input to a Data Mapper Load. The external data can be imported into an interface object, which is a custom Salesforce object using a data import tool. Then, map the fields from the custom object to the target Salesforce records using a Data Mapper Load. When you load data to a Salesforce custom object, it fires an Apex trigger that calls a Data Mapper Load. The Data Mapper takes data from the interface object and writes the resulting data to other Salesforce record objects.
Customize Omniscript Elements: Add custom behavior and styling to an Omniscript element by extending the functionality of an Omniscript element. By extending the Omniscript component, you modify its properties and add new properties. Then, replace or override the Omniscript element's Lightning web component with the customized component in the designer to use the customized component at run time.
Working with Omnistudio Data Mappers: Use the Data Mapper Designer to build and configure server-side processes that declaratively retrieve, write, and modify data. You can create Data Mappers from the Omnistudio or Data Mappers app. Or you can create them from Data Mapper elements in Integration Procedures and Omniscripts.
Display Data on Flexcards Based on Conditions: Determine whether to apply conditions to individual Flexcard elements, to the entire Flexcard, or to both. Use states to control what’s available to users at the Flexcard level. For a more granular configuration, apply conditions to specific elements, fields, events, and more. For example, to show an alert icon for escalated cases, apply conditions to that icon. To show different Flexcards based on the payment status of an insurance account, create states for each status.
Example Use Cases for Flexcard Events: Review examples of Flexcard event setup for common use cases such as updating a product list, registering dynamic custom events, or resetting a user selection.
Examples for Flexcard Settings: View examples for Flexcard settings, such as adding an event listener and repeating records of a Flexcard.
Extend an Omniscript Element’s Lightning Web Component: Add custom behavior and styling to an Omniscript element while maintaining its core functionality. Replace an Omniscript element's Lightning web component with a component that re-creates its properties and adds new ones.
Work with Integration Procedures: Use the Integration Procedure Designer to build and configure server-side processes that automate data operations between Salesforce and external systems. Integration Procedures support actions like API calls, data transformations, conditional logic, and chaining in a single server call. The Designer also includes tools for debugging and performance optimization, making it ideal for use with Omniscripts, Flexcards, and external integrations.
Standard Omnistudio Content and Runtime: With the Omnistudio permission set license, standard Omnistudio content runs in standard runtime. From the Lightning App and Experience Builders, add standard content to a Lightning or Experience Cloud site with standard Omniscript and Flexcard components. Standard Omnistudio components built by Salesforce Industries, such as Health Cloud and Financial Services Cloud, are available. You can also use standard components instead of custom-generated components to run custom content in the standard runtime.
Override all Elements of an Omniscript Element Type with a Custom Lightning Web Component: To override all elements of a type in an Omniscript, map the element to the custom Lightning web component. You can't directly drag these components to the Omniscript canvas and map them to their custom Lightning web component. These components include Step Chart, Save for Later Acknowledge, and Modal.
Pass Data to Flexcards by Using Events: When an event occurs, a notification is sent to a Flexcard through an action on an element. Then, execute an action based on the event. Set up events to communicate between a child Flexcard and its parent, between an element and the Flexcard that it's on, or between distinct components. For example, add an action on an embedded child Flexcard that, when clicked, updates a field on the parent Flexcard. Or, add an action on an image that when clicked, updates a merge field value in a text element.
Set Up Omni Global Auto Numbers: Use Omni Global Auto Number to create a custom numbering system that applies to specific information such as versions, years, and product codes.
Steps (Managed Package): For the managed package runtime, each Step element in an Omniscript presents a page to the user that prompts for input or displays information. For navigation, all Steps except the first have a Next button, and all except the last have a Previous button.
Add Steps to an Omniscript: Each Step element in an Omniscript presents a page to the user that prompts for input or displays information. For navigation, all Steps except the first have a Next button, and all except the last have a Previous button.
Streaming Channel Data Source (Managed Package): For the managed package runtime, the Streaming Channel API type uses the Streaming API to send notifications of general events that aren’t tied to Salesforce data changes. Use the Streaming Channel API when you want to send and receive notifications based on custom events that you specify. You can use Streaming Channel API for any application that sends custom notifications, such as a Chat application.
Streaming Channel Data Source (Managed Package): For the managed package runtime, the Streaming Channel API type uses the Streaming API to send notifications of general events that are not tied to Salesforce data changes.
Style Flexcard Elements (Managed Package): For the managed package runtime, configure the look and feel of a Flexcard by styling individual elements, fields inside elements, and entire states. From the Style panel in the Flexcard Designer, design backgrounds, text, and borders; adjust heights, widths, and spacing inside and between elements; apply classes and inline styles; make your element responsive; and more.
Style a Flexcard: Configure the look and feel of a Flexcard by styling individual elements, fields inside elements, and entire states. Configure backgrounds, text, and borders; adjust dimensions and element spacing; apply classes and inline styles; make your element responsive; and more.
Style Omniscripts (Managed Package): For the managed package runtime, add custom styling to Omniscripts by using static resources, extending an Element's Lightning web component, overriding global stylesheets, or using SLDS design tokens. View the behavior of each customization option in this page's table, and choose the solution that meets your requirements.
Custom Styles for Omniscripts: Add custom styling to Omniscripts by using static resources, overriding global stylesheets, or using SLDS design tokens. View the behavior of each customization option in this page's table, and choose the solution that meets your requirements.
Syntax of the Required Permission Property: Omnistudio Data Mappers and Integration Procedures have a Required Permission property, which determines who has runtime access. You can specify roles, profiles, permission sets, custom permissions, or any combination. If Required Permission is blank, any user can run the Data Mapper or Integration Procedure unless the DefaultRequiredPermission property is set.
Syntax of the Required Permission Property: Omnistudio Data Mappers and Integration Procedures have a Required Permission property, which determines who has runtime access. You can specify roles, profiles, permission sets, custom permissions, or any combination. If Required Permission is blank, any user can run the Data Mapper or Integration Procedure unless the DefaultRequiredPermission property is set.
Take Actions with Omniscripts: Besides getting, modifying, and writing data, Omniscripts can take other types of actions. Omniscripts can send messages to users or systems. Users can also provide input to the Omniscript or go to another page or site from an Omniscript. Users can also use DocuSign to sign documents electronically. You can automate decisions in Omniscripts with the Business Rules Engine. You can also extend Omniscript elements for custom behaviors.
Target URL and URL Parameters (Managed Package): For the managed package runtime, to launch Vlocity Omniscripts, Vlocity Cards components, web pages, or external applications from a Vlocity Action, enter an Apex page, or a URL with parameters as the Target URL. LWC components, such as LWC Omniscripts, LWC Cards, and Flexcards, are not URL addressable and so can't be accessed directly from a URL and must embedded on a page.
Target URL and URL Parameters (Managed Package): For the managed package runtime, to launch Vlocity Omniscripts, Vlocity Cards components, web pages, or external applications from a Vlocity Action, enter an Apex page, or a URL with parameters as the Target URL.
Template Designer (Managed Package): For the managed package runtime, Vlocity Templates provide the structure for Omniscript elements and Cards Framework components, such as a layout that includes the associated cards and card states. The template enables you to work directly with HTML to provide organizational structure, CSS/SASS to provide style, and AngularJS to loop through data from data sources.
Test a Calculation Procedure (Managed Package): For the managed package runtime, we recommend that you use the Simulator tab to test the calculation procedure you just created before going on to create other calculation procedures, Integration Procedures, or Omniscripts.
Test Data in the LWC Omniscript Designer (Managed Package): For the managed package runtime, test your Omniscript in the LWC Omniscript Designer by adding test data, viewing the data JSON, and debugging action requests and response data.
Test Data Source Settings on a Flexcard (Managed Package): For the managed package runtime, preview a Flexcard with real data by adding test values to runtime variables. The variables populate the dynamic fields in a data source, such as a contextId from an Omnistudio Data Mapper that gets data from an Account.
Test Data Source Settings on a Flexcard: Preview a Flexcard with real data by adding test values to runtime variables. The variables populate the dynamic fields in a data source, such as a contextId from an Omnistudio Data Mapper that gets data from an Account.
Test Procedures: Integration Procedures for Unit Testing (Managed Package): For the managed package runtime, an Integration Procedure that performs a unit test is a Test Procedure. You can use a Test Procedure to unit test almost anything an Integration Procedure can invoke, such as an Omnistudio Data Mapper, a Calculation Matrix, an Apex class, or another Integration Procedure.
Test Procedures: Integration Procedures for Unit Testing: An Integration Procedure that performs a unit test is a Test Procedure. You can use a Test Procedure to unit test almost anything an Integration Procedure can invoke, such as an Omnistudio Data Mapper, a Calculation Matrix, an Apex class, or another Integration Procedure.
Test the Custom Function (Managed Package): For the managed package runtime, to verify that you have configured the custom function correctly, go to the Omnistudio Data Mapper Designer Formula tab, add a formula, and type the first letter of the function name. The list of available functions is displayed, and if your configuration is correct, your function is listed.
Text Area Properties (Managed Package): For the managed package runtime, Text Area properties are configurable from the Properties panel when you select a Text Area element. With the Text Area element, enable users to enter multiple lines of text in your Omniscript.
Text Properties (Managed Package): For the managed package runtime, Text properties are configurable from the Properties panel when you select a Text element. With the Text element, enable users to enter a line of text in your Omniscript.
The Looping Feature in Calculation Procedures (Managed Package): For the managed package runtime, looping calculations take a starting point, an endpoint, and an interval. At run time, the calculation procedure runs in a loop from start to end per interval. Each run uses the same input variables, plus an index variable that you can use in the calculation.
Tie a Picklist to Salesforce (Managed Package): For the managed package runtime, using Vlocity Omniscript, you can dynamically populate a Select, Multi-Select, or Radio element with values from a picklist in your Salesforce org, or using a custom Apex class.
Using Salesforce Picklists with Omniscript Inputs: You can dynamically populate a Select, Multi-Select, or Radio element in an Omniscript with values from a picklist in your Salesforce org or with a custom Apex class.
Time Properties (Managed Package): For the managed package runtime, time properties are configurable from the Properties panel when you select a Time element. With the Time element, enable users to select a time from a dropdown list in your Omniscript.
Track Custom Data on a Flexcard (Managed Package): For the managed package runtime, track custom data to publish with OmniAnalytics. The tracked information is sent from the Flexcard element to the Vlocity Tracking Service which is then published by OmniAnalytics.
Tracked Flexcard Events (Managed Package): For the managed package runtime, Flexcards support tracking Card Load, Card Unload, and State Load events from parent and Child Flexcards, and the UI Action event from the Action element.
Tracking Data Preprocessor (Managed Package): For the managed package runtime, before the tracking service executes its own logic, it calls any interface implementations named TrackOmniScript or TrackCard, enabling you to preprocess tracking data. For example, this implementation uses the customer ID submitted by an Omniscript to add customer detail to the event data.
Tracking Session Interaction Id (Managed Package): For the managed package runtime, to associate all the events tracked for a single session, the tracking system logs an Interaction Id that is unique for the session. To provide this Id from an Omniscript or Integration Procedure, add a key/value pair to the Tracking Custom Data field in the Configuration section.
Translate Custom Labels for Date and Time Components (Managed Package): For the managed package runtime, define custom label translations for date and time pickers using JSON strings and Omniscript custom labels. For example, if a Spanish translation is defined, the date picker displays Spanish translations for the months and days of the week.
Translate Custom Labels for Date and Time Components: Define custom label translations for date and time pickers using JSON strings and Omniscript custom labels. For example, if a Spanish translation is defined, the date picker displays Spanish translations for the months and days of the week.
Translate Tooltip Help Text in Omniscripts (Managed Package): For the managed package runtime, display tooltip help text with multiple translations in multi-language LWC Omniscripts. You must use custom labels to add help text in multi-language Omniscripts. If a custom label is not defined for a help text tooltip, an error renders.
Translate Tooltip Help Text in Omniscripts: Display tooltip help text with multiple translations in multi-language Omniscripts. You must use custom labels to add help text in multi-language Omniscripts. If a custom label is not defined for a help text tooltip, an error renders.
Trigger a Custom Event from an Action on a Flexcard (Managed Package): For the managed package runtime, notify a Flexcard of an event occurring from an action on an element. Then execute an action based on the event. Custom Events are used to communicate between a child to its parent, whether it's between a child Flexcard and its parent, or between an element and the Flexcard it's on.
Trigger a Pubsub Event from an Action on a Flexcard (Managed Package): For the managed package runtime, enable an action on a Flexcard to notify another component, such as another Flexcard on a page or application, of an event occurring. For example, update a list of products on one Flexcard from a filter on another Flexcard on the same page or application.
Trigger Actions on Record Change (Managed Package): For the managed package runtime, from an Event Listener, enable a Flexcard to listen for changes on a record the Flexcard is on, then trigger actions.
Trigger Actions with the Toggle Element on a Flexcard (Managed Package): For the managed package runtime, trigger an action when a user clicks a toggle element on a Flexcard. Let a user pick between two states, enable or disable an option, or select multiple options. When a user selects the element, its value is sent as a parameter to the action as true or false, or a comma-separated list of user-selected options with the {element.value} merge field.
Trigger Sequential Actions from an Event Listener on a Flexcard (Managed Package): For the managed package runtime, enable an event listener to execute multiple actions sequentially on a Flexcard. When an event listener has multiple actions, the first action fires, completes, and triggers the next action in the sequence. You can use the response from the previous action to perform subsequent actions. For example, create an event listener that updates to the value of a data field with a Set Values action, then passes the updated value to an Omniscript with an Update Omniscript action.
Trigger Sequential Actions on an Actionable Element on a Flexcard (Managed Package): For the managed package runtime, enable an element to execute sequential actions from a Flexcard. When an element has multiple actions, the first action fires, completes, and triggers the next action in the sequence. You can use the response from the previous action to perform subsequent actions. Enable sequential actions on clickable display and input elements such as Action, Image, or Checkbox.
Triggering Lightning Events in Omniscript (Managed Package): For the managed package runtime, it is possible to trigger Lightning events from within an Omniscript. For example, you may wish to update an item on a Layout when an Omniscript is completed.
Try-Catch Block: A Try-Catch Block lets you "try" running the steps inside it and then "catch" the error if a step fails.
Try-Catch Block Properties (Managed Package): For the managed package runtime, these properties are unique to or function in a unique manner in Try-Catch Blocks. A Try-Catch Block lets you "try" running the steps inside it and then "catch" the error if a step fails.
Turn Off the Scale Cache: Turn off the Scale Cache globally when working with sensitive or user-specific data. This prevents such data from being cached and ensures real-time access control and data accuracy.
Type Ahead Block (Managed Package): For the managed package runtime, display a list of results when a user begins typing in an input field by using the Type Ahead Block. When a user selects a record, the Type Ahead Block can retrieve additional information related to the record. For example, a Type Ahead Block can be used with an Omnistudio Data Mapper to list Accounts in the results.
Update a Data Source from an Action on a Flexcard (Managed Package): For the managed package runtime, with a Card Action, create an action that changes the data source, or updates parameters of an existing data source. For example, create an action that updates the pagination limits on a list of returned records.
Update an Omniscript from a Flexcard (Managed Package): For the managed package runtime, create an action that updates an Omniscript's data JSON from the Flexcard embedded in the Omniscript. You can embed a Flexcard inside an Omniscript as a Custom LWC.
Update an Omniscript's JSON Code from a Flexcard: Specify the JSON node that Omnistudio updates in response to a user action on the Flexcard by embedding the Flexcard in the Omniscript as a custom Lightning web component.
Update Components Deployed on Lightning Pages: To ensure that your components deployed on Lightning pages work as expected after you migrate from Omnistudio for Managed Packages to Omnistudio, check your Lightning page for all Omniscripts and Flexcards using the Vlocity LWC Wrapper or any custom Lightning web components (LWC), and replace those with the standard components.
Update Components Deployed on Experience Cloud Site or Community Pages: To ensure that your components deployed on Experience Cloud sites or Community pages work as expected after you migrate from Omnistudio for Managed Packages to Omnistudio, replace all Omniscripts and Flexcards using the Vlocity LWC Wrapper or any custom Lightning web components (LWC) with the standard components.
Data JSON Update (Managed Package): For the managed package runtime, update the custom Lightning Web component element, map responses to the Omniscript’s data JSON, and create and map data inside the custom Lightning Web component element.
Update Filter Logic for Vlocity Actions (Managed Package): For the managed package runtime, Vlocity Action filters and the Applicable Type setting determine which action appears for an instance of an object. You can use AND or OR conditions with the attributes in the Applicable Type setting. For example, Applicable Type=Policy__c, Filter=PolicyType__c='Auto' AND Status__c='Active', means this action appears only on the Action toolbar for the Policies with policy type ='Auto' and status is 'active'.
Update Profile Settings for Contract Actions (Managed Package): For the managed package runtime, Vlocity Actions control the actions and operations that are allowed in each state on a particular Contract Document record. Vlocity Actions also control which users can perform actions and operations.
Update Remote Site Settings to Preview Your Flexcard (Managed Package): For the managed package runtime, grant access to your org domains to enable LWC features such as Preview. When spinning a new org or new installation, the Tooling API calls necessary for LWC may fail if the Remote Site Settings page in your org does not include the URLs required. The required URLs are your org's lightning.force.com URL and the vf.force.com URL of the Visualforce page that contains the Flexcard Designer.
Open a Flexcard in a Canvas Instead of the Record Page Detail: Omnistudio provides an intuitive canvas to easily set up Flexcards. If canvas view isn't available when you open a Flexcard, update the default Lightning record page for the Omni UI Card object. For example, the default record page is sometimes different after you migrate from the custom object data model to the standard object data model.
Upgrade an LWC Omniscript's Property Set (Managed Package): For the managed package runtime, when using an existing Omniscript in the LWC Omniscript Designer, create a new version of the Omniscript to update the Omniscript's property set.
Upgrade an Omniscript's Property Set: When using an existing Omniscript in the Omniscript Designer, create a new version of the Omniscript to update the Omniscript's property set. In an org with multiple developers, errors could appear in the designer when using the same Omniscript without a new version. Prevent or resolve this error by upgrading the Omniscript's property set.
Upload a CSV File to Create a Calculation Matrix (Managed Package): For the managed package runtime, you can upload a CSV file to create a new calculation matrix. You can also upload a CSV file to an existing calculation matrix, such as a new version of an existing matrix, to update and add to the headers and data.
Upload Files and Images in Omniscripts (Managed Package): For the managed package runtime, to upload files in an Omniscript, add a File input element. To upload an image, add an Image input element. Details about uploads are added to the Files node of the Omniscript's Data JSON.
Upload Files and Images in Omniscripts: To upload files in an Omniscript, add a File input element. To upload an image, add an Image input element. Details about uploads are added to the Files node of the Omniscript's Data JSON.
Upload New Versioned Rows (Managed Package): For the managed package runtime, you must create a new version of a row-versioned calculation matrix before you upload new data from a .csv file.
URL Properties (Managed Package): For the managed package runtime, URL properties are configurable from the Properties panel when you select a URL element. With the URL element, enable users to enter a web address in your Omniscript.
Omnistudio Usage: Omnistudio usage is governed by the consumption of Omnistudio calls. Understand how different activities and components contribute to your usage to better manage your org’s entitlements.
Use Apex to Define Pricing Logic (Managed Package): For the managed package runtime, to use Apex to define pricing logic, create a class-based Calculation Procedure. The Calculation Procedure name and action class name must be the same as the name of the Apex class. (To define pricing logic without using an Apex class, create a declarative Calculation Procedure.)
Use Cases for Calculation Procedures (Managed Package): For the managed package runtime, here are ways to set up the possible use cases for calculation procedures that use or don't use attribute-based pricing or volume-based pricing.
Use Formulas in Omnistudio Data Mappers (Managed Package): For the managed package runtime, to add data to the output of a Data Mapper, define formulas. Several types of Data Mapper (Extract, Transform, and Load) support formulas. When you define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).
Use Formulas in Omnistudio Data Mappers (Managed Package): For the managed package runtime, to add data to the output of a Data Mapper, define formulas. Several types of Data Mappers (Extract, Transform, and Load) support formulas. When you define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).
Use Formulas in Omnistudio Data Mappers: To add data to the output of a Data Mapper, define formulas. Several types of Data Mappers (Extract, Transform, and Load) support formulas. When you define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).
Use the Newport Design System: The Newport Design System allows you to customize the appearance and behavior of Omniscript elements. Newport includes Storybook.js, a browser-based preview tool, that enables you to see your design changes in action.
Use Quick Match to Map Data (Managed Package): For the managed package runtime, quick Match is a handy way to map input and output data in an Omnistudio Data Mapper Transform when the names match.
Use Quick Match to Map Data: Quick Match is an easy way to map input and output data in an Omnistudio Data Mapper Transform.
Use the Applications Together (Managed Package): For the managed package runtime, use the Omnistudio applications together. Create guided interactions with Omniscripts; get and post data with Omnistudio Data Mappers and Integration Procedures; and display data and launch actions with Classic Cards or Flexcards.
Use the Applications Together: Use the Omnistudio applications together. Create guided interactions with Omniscripts; get and post data with Omnistudio Data Mappers and Integration Procedures; and display data and launch actions with Flexcards.
Use the Omnistudio Project Explorer to Group Related Components for Deployment (Managed Package): For the managed package runtime, the Omnistudio Project Explorer lets you include a set of Salesforce Industries components in a project so you can deploy the components between orgs as a group using the recommended deployment tool. The Omnistudio Project Explorer is a Google Chrome browser extension—you can't use it with other browsers. You can use Omnistudio Project Explorer in Salesforce orgs with Salesforce Industries Communications, Media, and Energy or Vlocity Insurance installed.
Use Type Ahead Block With Data JSON (Managed Package): For the managed package runtime, a Type Ahead Block can use a JSON node as its source instead of an Omnistudio Data Mapper, API, HTTP, or Remote action. This JSON node can store data from any action that outputs a list. The response from a Type Ahead Block that uses a JSON node is made client-side, eliminating the need to make server calls.
Use Type Ahead Block with Omnistudio Data Mapper (Managed Package): For the managed package runtime, retrieve an object record using a Type Ahead Block with a Data Mapper. For example, type a few letters of an Account Name in the Type Ahead Block, and the Data Mapper finds the Account records with Names containing those letters.
Using Actions with Cards (Managed Package): For the managed package runtime, cards use Vlocity Actions, OS Actions, and Custom Actions to launch procedures. For example, a card can launch an Omniscript, run an Apex class, redirect to a URL endpoint, and so on.
Using Actions with LWC Cards (Managed Package): For the managed package runtime, LWC Cards use Vlocity Actions, OS Actions, Custom Actions, Smart Actions, and PubSub Actions to launch procedures. For example, a card can launch an Omniscript, run an Apex class, redirect to a URL endpoint, launch an Integration Procedure, fire a pubsub event, and so on.
Using Omniscript with Adobe Experience Manager (Managed Package): For the managed package runtime, Adobe Experience Manager is a web deployment option for Omniscript. AEM can be useful for keeping your Omniscripts in line with your organization's designs and implementing custom elements and behaviors for use across Omniscripts presented by your AEM Instance.
Using Right-To-Left Languages (Managed Package): For the managed package runtime, Vlocity supports right-to-left languages using the Lightning Player and via_core implemented in a separate ".rtl.css" file.
Use the DocuSign Envelope Action to Email Documents for Signature (Managed Package): For the managed package runtime, after you prepare the DocuSign template and map the fields from the Omniscript to the template using an Omnistudio Data Mapper Transform, you can create a DocuSign Envelope Action in the Omniscript. When the action runs, a DocuSign Envelope containing the prefilled document is emailed to one or more recipients for signing or reviewing.
Use the DocuSign Envelope Action to Email Documents for Signature: Send an email with prefilled documents for signing or reviewing. It can be sent to one or more recipients. After you prepare the DocuSign template and map the fields from the Omniscript to the template using an Omnistudio Data Mapper Transform, you can create a DocuSign Envelope Action in the Omniscript. When the action runs, a DocuSign Envelope containing the prefilled document is emailed to one or more recipients for signing or reviewing.
Use the DocuSign Signature Action to Sign Documents From Within an Omniscript (Managed Package): For the managed package runtime, after you prepare the DocuSign template and map the fields from the Omniscript to the template using an Omnistudio Data Mapper Transform, you can create a DocuSign Signature Action in the Omniscript. When the action runs, a DocuSign window opens containing the prefilled document. The user must sign or decline to sign the document before continuing the Omniscript.
Use the DocuSign Signature Action to Sign Documents From Within an Omniscript: Users can sign a document from an Omniscript and download the signed document for their records. After you prepare the DocuSign template and map the fields from the Omniscript to the template using an Omnistudio Data Mapper Transform, you can create a DocuSign Signature Action in the Omniscript. When the action runs, a DocuSign window opens containing the prefilled document. The user must sign or decline to sign the document before continuing the Omniscript.
Automated Testing with UTAM for Omnistudio: Omnistudio now supports automated UI testing for Omniscripts and Flexcards by using the UI Test Automation Model (UTAM) framework. Automated testing is crucial for ensuring the stability and integrity of Omnistudio deployments.
Sample Flexcard Test (Java): This example demonstrates the complete end-to-end user journey, including setup, navigation, and interaction with Flexcards.
Sample Omniscript Test (Java): This example demonstrates the complete end-to-end user journey, including setup, navigation, interaction, and assertion across two steps.
UTAM Testing Workflow: The UI Test Automation Model (UTAM) testing workflow focuses on preparing the testing environment, writing UTAM Page Objects (POs), and running end-to-end tests for UI components.
Validate the Component (Managed Package): For the managed package runtime, learn how to add validation to the OmniScriptBaseMixin component by redefining the checkValidity() function.
Variables and Constants in Calculation Procedures (Managed Package): For the managed package runtime, you must create variables, constants, and matrices before you can use them in a Calculation Procedure. After you create them, they will be available to use in Calculation Procedures.
Version Omniscripts (Managed Package): For the managed package runtime, create multiple versions of an Omniscript to develop and test scripts in preview mode before activating scripts for production deployment. We don’t recommend making changes to a production Omniscript. Any time you plan to alter a production script, create a new, inactive version and make all updates in the latest version before activating.
Versioning in the Cards Framework (Managed Package): For the managed package runtime, creating a version of a component creates an exact copy of the record with a Version equal to the latest version number plus one.
View a Flexcard at Different Viewport Breakpoints (Managed Package): For the managed package runtime, adjust the size of your Flexcard's canvas to test for responsiveness. Use the Viewport Dropdown in the Flexcard Designer to mimic the sizes of a desktop, laptop, and smaller mobile devices.
View a Flexcard's Data JSON (Managed Package): For the managed package runtime, view your Flexcard's data JSON from the Preview tab of the Flexcard Designer. Look for potential issues in how your data source populates elements before publishing your Flexcard or sending data to another component. The Data JSON panel updates when you interact with the Flexcard, such as when entering data in an input field or clicking an action.
View In-Progress and Completed Omniscripts: Enable users to view in-progress Omniscripts that have been saved for later by using Visualforce pages and the Vlocity Omniscript Workbench.
View the Tracking Data in Google Analytics (Managed Package): For the managed package runtime, in the Workflow to Configure OmniAnalytics with Google Analytics documentation, after you view the example Omniscript and Card, you can view the data in Google Analytics. This is the final step in the workflow.
View the Tracking Data in the Vlocity Tracking Group Page (Managed Package): For the managed package runtime, after you have interacted with the example Omniscript and Flexcard, tabs for these components are added to the Vlocity Tracking Group page. On these tabs, you can generate reports of the interaction data being tracked.
View the Vlocity Tracking Entry Records (Managed Package): For the managed package runtime, you can view tracking data in Vlocity Tracking Entry records by creating a custom tab, filtering the list of records, then copying the Data field contents into a JSON formatter.
View the Namespace and Version of Managed Packages: Omnistudio can be installed as a managed package. The package might be for a Cloud product (such as Insurance or Communications) or Omnistudio Foundation. You can check the namespace and version of your managed package, which you might need for planning upgrades or troubleshooting.
Vlocity Actions (Managed Package): For the managed package runtime, Vlocity Actions are automatically generated URLS that launch Vlocity Omniscripts, Vlocity Cards components, web pages, or external applications. Actions are typically specific to a given object type, such as Account, Contact, Policy, or Asset.
Flexcards and Vlocity Cards Framework (Managed Package): For the managed package runtime, the Vlocity Cards Framework provides a set of tools to build customer-centric, industry-specific UI components and applications on the Salesforce platform. Create dynamic and engaging omni-channel customer experiences, rich in information and actions relevant to the customer's context with cards.
Vlocity Cards Framework Basics (Managed Package): For the managed package runtime, the Vlocity Cards Framework provides tools for building customer-centric, industry-specific UI components and applications on the Salesforce platform. Cards are rich in information and actions relevant to the customer's context. Create your cards in a declarative design tool and add them to your Lightning or Community pages.
Vlocity Cards LWC ReadMe Reference (Managed Package): For the managed package runtime, this page lists the Lightning web component ReadMes available for LWC Cards. For details about the layout for each card and card layout component, see Base LWC Card and Layout Templates.
Vlocity Components Event Tracking (Managed Package): For the managed package runtime, tracking data is stored in the VlocityTrackingEntry__c object. Some data, listed here, is tracked for all components and event types. Vlocity OmniAnalytics tracks many additional fields for all of its events. You can also add custom fields to the data being tracked.
Vlocity Conversation UI (Managed Package): For the managed package runtime, Vlocity Conversation UI combines the familiar experience of online chat, with the robust transactional capabilities of Vlocity’s Industry Cloud solutions.
Vlocity Customer Story (Managed Package): For the managed package runtime, a Customer Story is a history of events for an Account or a Contact. Customer stories are driven by metadata configuration. It displays a timeline of all interactions with the customer in a single, chronological feed.
Vlocity Intelligence (Managed Package): For the managed package runtime, Vlocity Intelligence can help you better understand how your customers respond, to make your marketing and client support efforts more effective. For example, while a contact center agent is answering a customer’s question about their cable service, the agent can be presented with material to assist in upselling the customer to a new Professional Sports package based on the customer’s interest in football and baseball.
Vlocity Layouts (Managed Package): For the managed package runtime, Vlocity layouts consist of rectangular canvases that act as containers for cards. Cards display information and clickable actions to support efficient navigation through complex CRM interactions.
Vlocity Lightning Web Components (Managed Package): For the managed package runtime, take advantage of Vlocity's declarative 'clicks not code' approach to building and modifying your applications with the Vlocity Lightning Web Components. With Vlocity Lightning Web Components, use standard JavaScript and HTML to modify and extend Vlocity products.
Vlocity OmniAnalytics Event Tracking (Managed Package): For the managed package runtime, OmniAnalytics tracking data is stored in the VlocityTrackingEntry__c object. Some data is tracked for all event types of all OmniAnalytics components: Flexcards, Omniscripts, and Integration Procedures.
OmniAnalytics for Managed Packages Overview (Managed Package): For the managed package runtime, using OmniAnalytics, you can track user interactions to answer questions such as which advertisements get the most responses and how many users who begin a purchasing process complete it. OmniAnalytics can track user interactions with LWC Omniscripts and Flexcards with or without a third-party system such as Google Analytics.
Vlocity Scheduled Job Fields (Managed Package): For the managed package runtime, to create batch jobs, go to the Vlocity Scheduled Jobs tab. For each job you want to schedule, add a record by clicking New. Then specify the settings you need in the Vlocity Scheduled Job fields.
Vlocity Streaming API Data Sources (Managed Package): For the managed package runtime, streaming API lets you push a stream of notifications from Salesforce to client apps based on criteria that you define. It has a persistent connection that continues to deliver new data as it becomes available, rather than using client polling.
Vlocity Streaming API Data Sources (Managed Package): For the managed package runtime, streaming API lets you push a stream of notifications from Salesforce to client apps based on criteria that you define. It has a persistent connection that continues to deliver new data as it becomes available, rather than using client polling. Polling is the most traditional way to get data from a data source that produces the stream of events and updates. The client makes requests periodically, and the server sends data if there is a response. In case there is no data to be sent by the server, an empty response is returned.
Tracking Service in Omnistudio for Managed Packages (Managed Package): For the managed package runtime, the Tracking Service in Omnistudio for Managed Packages is an event-tracking service that captures details of actions that users perform. You can use the service to track any type of event. For example, you can track the time it takes to complete the steps in an Omniscript to identify process improvements.
Ways to Create a Standard Calculation Matrix (Managed Package): For the managed package runtime, a standard calculation matrix isn't part of a group, and doesn't have row versioning. You can create a standard calculation matrix in three different ways.
When to Use Multiple Extract Steps (Managed Package): For the managed package runtime, how many extract steps you need depends on how the object types you are extracting from are related. There are three basic scenarios: single, single with relationship notation, and multiple.
When to Use Multiple Extract Steps: The number of extract steps that you need depends on how the object types that you’re extracting from are related. There are three basic scenarios: single, single with relationship notation, and multiple.
Which Version of Omnistudio Do You Have? (Managed Package): For the managed package runtime, determine which version of the Omnistudio application suite you’re using. The name of the managed package you installed may not correspond to Omnistudio or Omnistudio for Managed Packages.
Wildcards in Calculation Matrices (Managed Package): For the managed package runtime, starting in Winter '20, you can make it possible for calculation procedures and other Vlocity features that call calculation matrices to use a wildcard in place of a value for one column.
Work With Data in the Flexcard Designer (Managed Package): For the managed package runtime, in the Flexcard Designer, you can get data from a variety of data sources and view the data JSON returned. You can then display the data automatically using specific elements, such as a datatable, or manually using variables.
Work with Formulas in Edit Block (Managed Package): For the managed package runtime, perform equations and combine strings by using Formula Elements. Place formulas within an Edit Block to access element values within a specific Edit Block entry.
Work with Formulas in Edit Block: Perform equations and combine strings by using Formula Elements. Place formulas within an Edit Block to access element values within a specific Edit Block entry. Place Formula outside of the Edit Block in the same Step to access an element value for all of the Edit Block entries.
Workflow for Adding Ecommerce Data to the Example Omniscript and Card (Managed Package): For the managed package runtime, Google Analytics Ecommerce requires specific kinds of data. You must add this data to the Messaging Framework Omniscript properties and the Flexcard Custom Fields. Then when the Omniscript runs and the Flexcard is used, they send this data to Google Analytics.
Workflow for Batch Action Example (Managed Package): For the managed package runtime, one Integration Procedure uses a Batch Action to invoke a Vlocity Scheduled Job, which invokes a second Integration Procedure on a schedule.
Workflow for Calculation Action Example (Managed Package): For the managed package runtime, an Integration Procedure invokes a calculation procedure, which invokes a calculation matrix. The calculation procedure applies a 15% discount to a quoted amount for an age between 16 and 24 and a GPA of 3.0 or greater.
Workflow for Chatter Action Example (Managed Package): For the managed package runtime, an Integration Procedure sends a Chatter post to a user. This post includes text, an image, and mentions of two other users.
Workflow for Creating a Grouped Calculation Matrix (Managed Package): For the managed package runtime, you can create a calculation matrix that's part of a group of matrices. You create grouped calculation matrices so that a calculation procedure (or another calling process) can search all the matrices using only one SOQL query. This speeds up Vlocity processing and frees up SOQL queries for other purposes.
Workflow for Creating a Row Versioned Calculation Matrix (Managed Package): For the managed package runtime, creating the first version of a row-versioned calculation matrix follows most of the same steps as creating a standard calculation matrix. Then, as you need to make changes to these matrices, you can upload new individual rows. This creates new versions of the replaced rows with new start dates and end dates.
Workflow for Creating a Tracking Configuration and Adding Event Types (Managed Package): For the managed package runtime, a Vlocity Web Tracking Configuration specifies a third-party tag manager and account to which to send tracking data. Vlocity Web Tracking Event Types specify data formats for specific events. In the workflow example, Event Types pass Omniscript data to Google Analytics.
Workflow for Email Action Example with Template (Managed Package): For the managed package runtime, an Integration Procedure uses an Email Template and includes the sent email in the recipient's Activities list. No Email Templates exist by default, so this example includes steps for creating one.
Workflow for HTTP Action Example (Managed Package): For the managed package runtime, an Integration Procedure retrieves the astronomy picture of the day from NASA using NASA's publicly available REST API.
Workflow for List Merge Action Examples (Managed Package): For the managed package runtime, three Integration Procedures with List Merge Actions demonstrate a basic list merge, an advanced list merge, and a list merge with dynamic output fields. Each example builds on the previous example.
Workflow for Matrix Action Example (Managed Package): For the managed package runtime, an Integration Procedure invokes a calculation matrix. The matrix applies a 15% discount to a quoted amount for an age between 16 and 24 and a GPA of 3.0 or greater.
Workflow for Setting Up Google Analytics and Google Tag Manager (Managed Package): For the managed package runtime, you can configure Vlocity OmniAnalytics to send data to Google Analytics with Enhanced Ecommerce. To do so, you must prepare Google Analytics and Google Tag Manager to receive the data. You must configure an account, property, and view in Google Analytics, then configure variables, triggers, and tags in Google Tag Manager.
Workflow for Using a Static Resource Instead of a Visualforce Page (Managed Package): For the managed package runtime, the code that a Vlocity Web Tracking Configuration uses to communicate with a third-party analytics vendor can reside in either a Visualforce page or a static resource. If you use the Safari browser, your Vlocity Web Tracking Configuration must reference a static resource.
Working with Lookup Query Configurations (Managed Package): For the managed package runtime, when using the Lookup Element in Omniscript, the filtering of results is performed by the Lookup Query Configuration properties section. There are three main types of queries that can be built using this the Lookup Query Configuration properties section: AND join, OR join, and Deep query.
XML in Omnistudio Data Mappers (Managed Package): For the managed package runtime, in addition to JSON, Data Mappers can have XML input and output. The XML format in Data Mappers is an unordered key/value, JSON-like structure.
XML and JSON in Omnistudio Data Mappers: In addition to JSON, Data Mappers can have XML input and output. The XML format in Data Mappers is an unordered key-value, JSON-like structure.
What Is Salesforce?: Salesforce is your customer success platform, designed to help you sell, service, market, analyze, and connect with your customers.
Get Started with Developer Edition with Agentforce and Data Cloud: Developer Edition with Agentforce and Data Cloud offers the same allocations as Developer Edition (Legacy). It has certain limits and guidelines for large language model (LLM) generation requests and Data Cloud usage. To use Agentforce and Data Cloud in a Developer Edition, follow a few quick steps to set up these features in the org.
Salesforce Editions: We offer bundles of features and services, each geared toward specific business needs.
Lightning Experience–Only Editions: Customers using Lightning Experience are more productive than customers working in Salesforce Classic. To ensure that our customers benefit from these productivity gains, selected trials and purchased subscriptions for several editions offer Lightning Experience as the exclusive user interface for end users without admin permissions.
Find Your Edition: Your Salesforce edition affects which features and functionality are available in your org.
License Updates and Your Org: When you purchase Salesforce, you receive licenses, permissions, and profiles that shape your org and what users can do in it. You can also create permission sets to help with permission management. Understand the impact of license updates on permissions in your profiles and permission sets.
Push Updated Licenses to Sandbox Orgs: As your organization’s needs change, your licensing needs evolve. When you update licenses, you want your production and sandbox orgs to be in sync. Often you can refresh your sandbox to ensure that its licensing information matches your production org’s. Or, to ensure that your sandbox orgs receive updated license information, you can use the Match Production Licenses to Sandbox tool.
Member Engagement Widgets: Engage with members of your loyalty program and your customers on your company’s website and external portals by using member engagement widgets. Create widgets by using widget templates provided by Loyalty Management and customize the widgets based on your company’s branding and design requirements. You can configure your widgets by using either the Widget Designer within the Loyalty Management app or the OmniStudio’s Flexcard Designer.
Salesforce Editions That Are No Longer Sold: Some Salesforce editions are no longer sold. You can continue to use your Contact Manager, Group, Personal, Performance, or Database.com Edition org or purchase one of the editions that are currently sold: Professional, Enterprise, and Unlimited. Developer Editions are also still available for free.
Salesforce Security Basics: The Salesforce security features help you empower your users to do their jobs safely and efficiently. Salesforce limits exposure of data to the users that act on it. Implement security controls that you think are appropriate for the sensitivity of your data. We'll work together to protect your data from unauthorized access from outside your company and from inappropriate usage by your users.
Data and File Storage Allocations: Storage allocation per Salesforce edition and number of standard licensed users in your organization.
What Happens When You Purchase Salesforce: New to Salesforce, or maybe you’re not so new? In either case, to get the most out of Salesforce, it helps to know how your org is created and the types of licenses, permissions, and profiles that you receive. Understanding how these elements interact and impact what users can do saves you time.
Package an External Client App with First-Generation Managed Packages: Use first-generation managed packages to distribute external client apps to other orgs. Create an external client app with Packaged distribution state, add it to your managed package, and install the package in subscriber orgs.
Assign Licenses Using the API: Admins can use the API to assign or revoke licenses for any managed package installed in their org.
Partner Deal Registration Overview: Partner Deal Registration lets partner users submit deals on the partner site and lets channel managers review, approve, or reject submitted deals in Salesforce.
Partner Deal Registration Prerequisites: Before you turn on Partner Deal Registration, verify that Partner Cloud setup, approver routing, and lead page requirements are in place.
Partner’s Conversion Factor for Currencies: A loyalty program can have multiple currencies. Members can accrue or redeem points of multiple currencies for each partner transaction. To calculate the partner’s credited or debited points, the loyalty program and the partner decide the conversion factor for the currencies that are used in partner transactions. The conversion factor applies to both prepaid billing and postpaid billing.
Provide Partners Access to Partnership Details on Their Site: Admins can provide partners access to a loyalty program’s Experience Cloud site so that partners can view their partnership details. Partners can view their transaction journals, partner ledgers, partner currencies, joint promotions, and products. Prepaid partners can also view the prepaid packs that they purchased.
Partner Ledgers: Partner transactions generate Loyalty Program Partner Ledger records. For prepaid billing, the ledger debits points from the partner's points balance or adds points to the partner's credited points. For postpaid billing, the ledger debits the amount from the partner's balance or adds the amount to the partner's bill amount.
Create Partner Ledgers and Update Partner Balances Definition: The Create Partner Ledgers and Update Partner Balances Data Processing Engine definition template creates partner ledgers and updates partner balances based on the processed partner transactions.
Partner Transactions: Loyalty programs track expenses incurred by a program or a partner for member redemptions, accrual cancellations, and custom processes. These calculations can be used to determine the value a partner brings to the loyalty program.
Reset Password (Disambiguation): When you use Salesforce, "reset password" can mean different things. Salesforce users can initiate a process that resets their own password. Administrators of most Salesforce products can reset a password for someone else. Some Salesforce products require authentication that's separate from your Salesforce login credentials.
Partner Cloud | Find Record Types: Retrieves all available record types that the partner user can use when creating a new lead. Use this action when a partner user creates a lead and wants to know which record types are available. This action returns a list of record type IDs, names, and descriptions for creating leads.
Partner Cloud | Get Deal Registration Flow Details: Retrieves metadata for the preconfigured deal registration flow, including required and optional Lead fields, field types, labels, picklist values, and configured constraints. Use this action after selecting the Lead record type and before collecting deal information to determine what information to request from the partner and how to validate each value. No user-provided input is required.
Partner Cloud | Get Referral Codes: Retrieves the referral codes associated with a user's contact. Use this action when a user wants to apply a referral code during deal registration. This action returns a list of referral codes including code name, description, and relevant details that the user can select from.
Partner Cloud | Create Case: Creates a detailed support case with a structured summary, relevant conversation history, and a linked chat transcript when triggered from supported messaging channels. This context helps reps resolve issues efficiently and avoid repeated interactions.
Partner Success Agent: Partner Success Agent delivers AI-powered, personalized support for partners. It helps partners resolve issues quickly, access enablement resources, and receive contextual recommendations. With vendor-specific customization, case handoff, and quick setup, Partner Success Agent drives partner engagement, productivity, and ecosystem growth.
B2B Referral Management Flows: B2B Referral Management uses flows to automate the tracking of referrals and rewards throughout the lead and opportunity lifecycles. These flows handle event processing when leads are created or converted and when referred opportunities are won.
Calendar Scheduler for Partners: Use external calendars to show partner availability when customers schedule appointments through an Experience Cloud site.
Channel Revenue Management: Channel Revenue Management is a suite of robust features built on the Salesforce Platform that help your business elevate channel partner engagement, track channel inventory, and drive channel sales with incentives. It's a unified suite that helps you manage channel partner operations, protect margins, report market opportunities, and strengthen partner collaboration and trust.
Create a Joint Business Plan: Align your company and Salesforce on shared goals, objectives, and activities, and track progress toward agreed business outcomes.
Create a Portability Policy: Use Portability policies to compile data from both default and custom objects linked to the Individual, Account, Contact, Lead, or User objects. You can select individual fields on these objects that contain the data subject’s PII for inclusion in the policy. The fields are then compiled into a file.
Create Data Library for Partner FAQ: Summary of the configuration steps required to make the Partner FAQ topic work with the partner context in the authentication-based MIAW setup.
Set Up Partner Cloud: Learn how Partner Cloud Initial Setup prepares your Salesforce org for partner collaboration by combining automated and manual configuration steps. Executed exclusively by admins from Salesforce Go, this setup lays the foundation (permissions, site visibility, and app access) for both channel managers and external partners.
What Can You Do with Joint Business Plans: Joint Business Plans provide a workspace where channel managers and partners can set a shared strategy, create measurable objectives, build action plans, and collaborate with partners.
Joint Business Plan Objectives: Define measurable objectives for a joint business plan and track progress toward shared goals.
Considerations for Managing Objectives for Joint Business Plans: Before you create or edit objectives for joint business plans, review how records are selected, when scheduled jobs update them, and how eligible records are automatically linked or unlinked.
Joint Business Plans: Collaborate with partners to align on goals, track progress, and grow your indirect business.
Who Uses Joint Business Plans: Joint Business Plans bring internal teams and external partners together to drive growth.
Set Up Joint Business Plans: Before channel managers can create joint business plans, admins must complete a few steps.
Manage the Full Partner Lifecycle with Partner Cloud: Partner Cloud helps companies recruit, enable, collaborate with, support, and incentivize partners in Salesforce. Partner Cloud unifies Partner Ecosystem Management (PEM), Partner Relationship Management (PRM), and Channel Revenue Management (ChRM) to manage the full partner lifecycle with secure access, automation, collaboration, incentives, and analytics for scaling indirect sales.
Link Records to a Joint Business Plan Objective: Link records to a joint business plan objective to track the records that contribute to the objective’s calculated metric. Salesforce can link qualifying records automatically, or you can manage the linked records manually.
Cultivate Partner Loyalty with Loyalty Programs: Build lasting relationships with partners by creating compelling loyalty programs. Amplify your growth targets by incentivizing desired behaviors with rewards. Automate the loyalty journey and gain comprehensive visibility into program performance.
Market Development Funds for Partners: Fund partner marketing activities, manage requests and claims, and track approvals with Market Development Funds (MDF).
Partner Connect (Beta): Partner Connect lets vendors and partners work on account, opportunity, lead, contact, and case together, providing visibility on shared business across Salesforce orgs. Partner users log in to a vendor’s Experience Cloud partner site to export records from approved objects to the partner's Salesforce org. Exported records remain connected across orgs, giving users from both companies a read-only glimpse of how records progress independently for each company.
Partner Cloud: Start managing the full partner lifecycle in one place with tools built directly into Salesforce. Use Partner Cloud to recruit, onboard, enable, and co-sell with partners while giving them secure access to the data and workflows they need. Bring together key capabilities like deal registration, incentives, training, and performance tracking so your team can scale indirect sales and improve partner relationships. Partner Cloud helps you do more with the partners you already have—faster, and with less manual work.
Partner Case Management: Use the Partner Case Management topic to handle partner inquiries and actions related to support cases, including providing case information, updating existing cases, and creating new cases.
Partner Deal Registration: Use this topic to help partners register new deals by creating leads with proper record types, collecting all required information through conversation, and applying referral codes when applicable.
Partner Enablement Management: Use this topic to help partners find and enroll in enablement programs by providing recommendations based on their role, experience level, and learning needs, with a focus on training tracks and learning paths that align with their goals.
Partner FAQ: Use this topic to search knowledge articles to answer partner questions about the company, its products, policies, or business procedures, and provide relevant information from those articles.
Plan with Partner Cloud: Align with partners on shared goals, track progress, and grow your indirect business. Channel managers and partner users work together in Salesforce and Partner Central.
How Partner Connect Helps Vendors and Partners Integrate Shared Business: Vendors and partners already work together to sell complementary products and services. Why not incorporate technology that makes collaboration easier? Partner Connect lets vendors and partners automate object management between their Salesforce orgs to save time, collaborate transparently, and increase revenue.
Partner Connect Object and Field Integration Considerations for Partners: Review your vendor’s plan for integrating objects and fields. Then decide how you want to map your objects and fields to your vendor’s selections. Sometimes, you can decide not to import or store fields that you don’t want, even if your vendor opted to share them. To import data into your Salesforce org successfully, make sure that you understand how your vendor uses each shared field. And verify that your selections meet the mapping requirements.
Partner Connect Object and Field Integration Considerations for Vendor: Share key details about your object and field integration with your partner admin. Sometimes you must adjust objects, fields, or customize other settings to accommodate discrepancies in how each Salesforce org stores data.
Partner Connect Security and Design: The MuleSoft framework lets Partner Connect use APIs and security protocols to connect vendor and partner Salesforce orgs securely. As vendor and partner admins complete Partner Connect setup, Partner Connect deploys a dedicated app to each org. Each app uses OAuth 2.0 client credentials to integrate the two orgs securely. After Partner Connect establishes a secure connection, partners can export approved records from the vendor’s Experience Cloud site to their partner org. Vendors and partners both track progress in the other org through a read-only child record that Partner Connect creates automatically.
Planning for Object and Field Integration: To avoid revisiting the Partner Connect setup, we recommend that vendors and partners agree on a clear plan to integrate objects and fields across Salesforce orgs. Vendor admins kick off planning by creating a list of the items that they want to integrate into the partner’s org. Sometimes admins from either org need to customize their Lead or Opportunity objects to integrate records smoothly.
Partner Connect Roles and Responsibilities: After a vendor company selects a partner company with whom they want to integrate records, companies must designate a vendor admin and partner admin. Admins must have the bandwidth to collaborate on Partner Connect planning, setup, and maintenance. If record export, import, or update issues occur, an IT professional at the partner company can also offer support.
Partner Connect Setup Prerequisites: Vendors and partners must work together to complete several prerequisites before beginning Partner Connect setup in Salesforce.
Verifying Object, Field, and Record Access for Partner Users: For partner users to export records, partners must have permission to access the record from the vendor’s Experience Cloud partner site. Before you begin Partner Connect setup, we recommend that vendor admins check that partner users have the level of access that the vendor wants.
Partner Product Pricing: Use this topic to help partners address and resolve queries related to obtaining specific product pricing information and requesting detailed price comparisons across products.
Considerations for Partner Success Agent: Before setting up the Partner Success Agent, consider supported functionality, usage, limitations and allowances, limits, and other issues.
Set Up Partner Success Agent: Use the default Agentforce Service Agent template to create the Partner Success Agent designed to resolve common support cases and requests.
Set Up Calendar Scheduler for Partners: Connect partner users' external calendars so that Salesforce Scheduler returns appointment times when partners are available.
Setting Up Partner Connect: After the vendor and partner agree on a plan to sync records between orgs, the admins can start the setup. The partner admin must complete Partner Connect setup in their org first, then the vendor admin completes setup in the vendor org.
Setting Up Partner Connect as a Vendor: After the partner admin completes the setup in their org, use the email link to create a password for the integration user and then proceed with the setup in your org.
Set Up Channel Manager Experience: Configure roles, sharing settings, and permissions so your channel managers can manage partner accounts and opportunities. Complete this setup after Partner Cloud Initial Setup runs its five automated steps.
Set Up Partner Experience: Configure your Salesforce partner ecosystem by reviewing org-wide sharing settings, building and publishing your site, and granting user profile access before activating the site for your channel managers.
Share Data with Portability Policies: Fulfill customer requests to access their data. Create portability policies to compile relevant customer PII in various objects and fields. Or use the Portability API to compile the targeted PII for your customer programmatically. Use the Portability Log to view the history and status of customer requests.
Turn On Partner Cloud Initial Setup: Turn on Partner Cloud Initial Setup to prepare your Salesforce org for partner collaboration. Salesforce automatically runs five configuration steps, including enabling Digital Experience Cloud and creating a partner community site.
Set Up Account Plans with Partners: Set up account plans with partners to align on shared goals, track strategic initiatives, and drive mutual growth. This feature helps improve collaboration, visibility, and execution on key customer accounts across internal teams and partner organizations.
Account Planning with Partners: Collaborate with partners on strategic customer accounts directly within Salesforce using Account Plans in PRM. Share access to account goals, metrics, and insights to create structured plans that drive growth, strengthen alignment, and build long-term customer value. This feature extends Sales Account Planning tools to the Partner Community.
Co-Branded Emails for Partners: Co-Branded Emails for Partners extends Distributed Marketing capabilities to channel partners so they can conduct their own email outreach while ensuring brand consistency and compliance. Partners can use pre-approved email templates to engage with leads and contacts, personalizing key sections while maintaining brand standards and messaging guidelines.
Configuring and Executing Co-Branded Email Campaigns: The co-branded email experience consists of two main workflows: vendor setup and partner execution. Vendors create and configure marketing campaigns with pre-built email content, then publish these campaigns to the partner Campaign Marketplace. After campaigns are published, partners can browse the marketplace and enroll in campaigns that align with their business goals. After enrollment, partners can send personalized, brand-compliant emails to their leads and contacts directly from the partner portal.
Discovering and Executing Campaigns: After vendors configure and publish campaigns, partners can browse the Campaign Marketplace, enroll in campaigns, and send co-branded emails to their leads and contacts.
Manage Partner Tracks: Use Partner Tracks to guide your partners through structured enablement programs that align with your business goals.
Configuring Campaigns for Partner Users: Channel managers create marketing campaigns by using Marketing Cloud capabilities. Each campaign includes essential details such as a name, description, and clear campaign objectives that help partners understand the campaign's purpose and intended outcomes.
Manage and Automate Incentive Payouts for Partners: Automate incentive payouts based on sales activity to make them easy and clear for partners—build trust, cut down manual work, and help partners stay motivated and close deals faster.
Proactive Asset Service (CRMA): The Asset Health Score indicates the overall condition and performance of an asset. Use this metric to understand the current state of your assets and predict potential issues before they become critical. The Proactive Asset Service creates the Asset Health Score dashboard and related Calculated Insights (CIs). The combination of customer data, key performance indicators (KPIs), and AI help your service team improve operations and reduce costs.
Embed Dashboards: The Service Cloud data bundle and Field Service data bundles create the Field Service data streams and data mappings. When you install Proactive Asset Service, the Field Service data model objects provide the data for visualization in CRM Analytic dashboards.
Asset Health Score Dashboard: Proactive Asset Service monitors asset usage, age, and maintenance history to assign an asset an overall health score. The score is based on the Recent Repairs KPI, Total Usage KPI, and Asset Age KPI calculated insights. Based on the score, the insight is also assigned a badge, Looking Good, Warning, or Critical, to help quickly assess the asset’s performance.
Trigger Flows with Data Cloud Data: A flow initiated by the Data Cloud begins operating once specific criteria within a Data Model Object (DMO) or Calculated Insight Object (CIO) are satisfied.
Install and Deploy the Service Cloud Data Kit: The Service data kit includes the Service data bundle and provides the necessary data streams and data mappings for Proactive Asset Service.
Proactive Asset Service Setup: Use the Proactive Asset Service Setup page to walk through the steps for Data Cloud prerequisites, installation prerequisites, and then install Proactive Asset Service.
Before You Install an AppExchange Package: Before you install a managed package from AppExchange, review any limits or requirements, and consider trying a Test Drive first.
Determine Which Users Can Access a Package: If you use an Enterprise, Unlimited, Performance, or Developer Edition organization, you can choose which users have access to the package.
Allow Third-Party Access to a Package: If the package you install contains a remote site setting, you must approve access to websites outside of Salesforce. Remote site settings allow the package to transmit data to and from a third-party website.
Salesforce Platform Cookies: The Salesforce Platform uses cookies to improve functionality and accelerate processing times. By saving a user’s settings, cookies can enhance the user’s experience and the Salesforce Platform’s performance.
Point Balance Calculation: The point balance calculation job calculates and updates a member’s point balance by aggregating the points for all qualifying and non-qualifying currencies credited to the member since the job was last run.
Point Expiration Calculation: The point expiration calculation job quantifies and expires non-qualifying points for members based on the expiration date on the ledger or the member’s last activity date.
Policy Center Agent Actions: Agent Actions for Policy Center summarize even your most complex policies and can compile lists of policies based on your criteria.
Agentforce for Policy Center: Use Policy Center to its full potential with Agentforce. Quickly get information about any policy, and compile lists of policies based on different criteria. Then let Einstein give you useful insights from that information.
Get Policy Insights with Einstein: Let Einstein use the information generated by your agent actions to create insights into your policies in plain language. Get detailed insights for policy summaries generated with the Get Policy Details Agent Action. Or get one-sentence insights for policy lists generated with the Get Policies by Object and Get Policies by Policy Type Actions.
Price Protection Warnings: Price protection warnings automatically flag potential issues with claims by checking ledger statuses, transaction dates, reconciliation (PIIR) status, and pending ship and debit claims. These warnings require no setup. To clear a warning, resolve the underlying issue, and rerun the DPE. The updated status appears on a page refresh.
Assign Standard Permission Sets: Assign the standard permission sets that ship with Penny Perfect Pricing to grant administrators and sales users access to pricing tasks — you don't need to build these from scratch.
Assign Permission Set Licenses: Assign permission set licenses (PSLs) to administrators and sales representatives so they can configure and use pricing features.
Pricing Components and Data Model: See how Penny Perfect Pricing separates the metadata that defines pricing logic from the condition data loaded from your ERP.
Considerations and Limitations: Review the system limits, feature boundaries, and operational requirements before you design and configure Penny Perfect Pricing.
Create a Pricing Key Type: Create pricing key types that tell the system how to search for pricing rules.
Create a Procedure Plan: Configure the schema determination engine that maps order pricing type and Internal Organization Unit to a Calculation Schema.
Penny Perfect Pricing: Calculate precise, ERP-consistent prices for complex B2B sales transactions, so quoted orders match final ERP invoices.
Price an Order: Generate accurate order prices in Salesforce while connected to the network.
Price Orders and View Results: Calculate accurate prices for orders in Salesforce and inspect the pricing waterfall to see how each price was determined.
Apply a Product's List Price: Configure a fallback search so an order uses a customer-specific price when one exists, and the product's standard list price otherwise.
Load Pricing Data from a Backend ERP System: Export pricing condition data from an ERP system and consolidate it for runtime pricing lookups — the load-and-consolidate procedure shared by the pricing scenarios in this section.
Pricing Scenarios: Walk through common business scenarios end to end, from configuration to loading pricing data to seeing the calculated result on an order.
Set Up Penny Perfect Pricing: Build the pricing metadata in order — key types, search strategies, specifications, and calculation schemas — then load your condition data.
Verify Required Add-Ons: Ensure that the required add-on licenses are active in your Salesforce organization.
Verify the Data Processing Engine: Penny Perfect Pricing uses the Data Processing Engine (DPE) to consolidate large volumes of ERP pricing conditions into optimized lookup tables.
Verify Permission Set Licenses: Confirm that your organization has the required system-level license definitions provisioned.
View the Pricing Waterfall: Inspect the step-by-step breakdown of which conditions were evaluated, applied, or excluded during price determination, including scale-tier details.
Loyalty Program Process Aliases: Field aliases correspond to the object fields that are used as variables in loyalty program process rules.
Create Preference Forms with Apex: Use the Preference Builder to configure a preference form by selecting elements to populate onto a blank workspace.
Create a Data 360 Subscription Consent Template and Preference Form: Create a Data 360 consent template, activate the template, and use the consent template to create a preference form. Use the form to collect consent from users for email and SMS engagement channel types.
Generate Tokens for User Contact Points: To associate consent forms with individual users, generate access tokens from email or phone contact points. Access tokens are embedded in consent form URLs, allowing users to view their personalized forms without logging in.
Set Up Data 360 for Preference Manager: Stream customer consent information from Data 360 to use in Preference Manager and to ingest customer consent information from preference forms into your Salesforce org.
Use Preference Manager to Gather Communication Preferences: As privacy law continues to define individual data rights and data use regulations, it’s important to establish consent with your customers. Use the Preference Manager app within Privacy Center to meet regulatory requirements and build trust with your customers. Securely capture their preferences for how, why, and when you can contact them.
Preference Forms: Preference Manager offers two methods for creating preference forms. You can create forms that work with Apex or forms that are populated from customizable templates.
About Consent Templates: Create reusable templates to capture preferences based on the objects that you want to use to store the consent information. You can also structure how your preference forms collect consent based on your brands, data use purposes, and subscriptions.
Preference Form Access: After you create and publish a preference form, you’re ready for customers to complete and submit it. You can host your form on an Experience Cloud site, an external website, or a static web page. After you publish the form, create tokens to give your users access to it.
Create an Apex Class for Preference Manager: Use Preference Builder along with the Pref_center Apex namespace to create forms with advanced customizations. The Pref_center Apex namespace represents the former name of the Preference Manager feature.
Create Reusable Consent Templates: In the Preference Manager app, you can create and publish as many consent templates as you want with the different template types. Then you use the activated templates to create the preference forms.
Configure Your Domain to Host Preference Forms: Add the domain where your preference form is hosted to the Cross-Origin Resource Sharing list so that your users can access your form. Complete this step before you host your form on an external website or before you use the default method with hosting on a static web page.
Create Preference Form Access Tokens: Create preference form access tokens in Preference Manager so that your users can view and edit your preference forms from an external site, a static web page, or an Experience Cloud site without logging in.
Host Preference Forms on a Static Web Page: Host your preference form online from Salesforce by using a static web page. Send the web page’s URL directly to your users without creating an external website or Experience Cloud site.
Set Your Preferred Language: Supported languages are English, Dutch, German, Portuguese, Japanese, Swedish, Chinese, French, Spanish, Korean, and Italian.
Preview a Data Management Policy: Generate and acknowledge a preview of your Data Management Policy configuration. Previews estimate the number of records and files that are affected by your policy, helping you evaluate its impact on the data in your org.
Capabilities of Price Protection: Use Price Protection to create a robust, scalable price protection process to protect your partners’ margins against price fluctuations. Review the capabilities of Price Protection and see how you can achieve various business outcomes with it.
Legacy Privacy Center: Satisfy Customer Requests and Data Privacy Laws: Manage components of data privacy law such as the General Data Protection Regulation (GDPR), and fulfill customer requests on how their personally identifiable information (PII) is stored, deleted, and transferred.
Agentforce in Privacy Center: Discover and resolve potential compliance and risk issues in your Salesforce org with an AI-powered experience. Agentforce in Privacy Center monitors your org against a configurable compliance framework, surfaces issues before violations occur, and recommends remediation actions for your review and approval.
Manage Your Compliance Framework: Update the regulations in your compliance framework to control what Agentforce in Privacy Center monitors in your org.
Discover and Resolve Compliance Issues: Review compliance issues identified by Agentforce in Privacy Center and apply AI-recommended solutions to bring your org into compliance.
View Compliance Rules: Review the compliance rules generated from the regulations in your framework on the Rules tab.
Set Up Agentforce in Privacy Center: When you first open the app, a Welcome page opens. Use the setup assistant to configure your compliance environment.
Privacy Center and Data Governance Laws: Data protection and privacy guidelines change depending on where your customers are located. Privacy Center helps you comply with data governance laws such as the General Data Protection Regulation (GDPR) in Europe and the California Consumer Privacy Act (CPPA) in the United States.
Migrate Privacy Center from Heroku to Hyperforce: To prepare for the retirement of the legacy Heroku-based store, transition your data governance to the secure Hyperforce architecture. Recreate your policies and migrate your records to Privacy Center 2.0 or Archive to take advantage of faster performance, advanced filtering, and seamless sandbox testing.
Considerations for Processing Objects: To achieve your data management goals more effectively, review key concepts around ordering objects and deleting data with privacy policies. And be aware of how errors or missing data can affect your implementation.
Considerations for Privacy Center Data Retention: When you process Salesforce records with Data Management or Right to Be Forgotten policies, you can copy the records to an external data store for retention. Review these guidelines and limitations when implementing data retention with Privacy Center.
Grant Access to Privacy Center: You give users access to Privacy Center through user permissions. Users with the System Administrator profile have access to Salesforce Privacy Center by default. All other profiles require specific permissions. The specific permissions that you define for your users depend on user-access requirements and roles. Depending on your setup, some Privacy Center users require access to Salesforce consent data model objects or custom objects that you use for consent management.
Optimize Privacy Policy Performance: To optimize the performance of your Data Management and Right to Be Forgotten policies, customize your policy settings.
Delete Data with Privacy Requests: Fulfill Right to Be Forgotten (RTBF) requests from your customers using Privacy Requests. Find and delete relevant records in your Salesforce org and in Data 360.
Manage Privacy Request Settings: Configure the search criteria and scope of Privacy Requests. Control which objects are scanned in your Salesforce org and in Data 360 when users execute searches.
Establish an Inbound Connection with AWS: An inbound connection allows you to send traffic into Salesforce from your AWS Virtual Private Cloud (VPC) using the standard APIs.
Establish an Outbound Connection with AWS: An outbound connection allows you to send traffic from Salesforce to your AWS Virtual Private Cloud (VPC) using Named Credentials.
Secure Cross-Cloud Integrations with Private Connect: When you integrate your Salesforce org with applications hosted on third-party cloud services, it’s essential to be able to send and receive HTTP/s traffic securely. With Private Connect, increase security on your Amazon Web Services (AWS) integrations by setting up a fully managed network connection between your Salesforce org and your AWS Virtual Private Cloud (VPC). Then, route your cross-cloud traffic through the connection instead of over the public internet to reduce exposure to outsider security threats.
Getting Started with Partner Cloud: Getting started with Partner Cloud is about designing your ideal partner experience. Plan your site strategy, establish your partner users, partner accounts, and external account hierarchy, create an Experience Cloud site, and set up some basic features.
Considerations for Partner Cloud: Get to know the potential caveats for Partner Cloud before you set up and start using Partner Cloud.
Collaborating With Partners Using Partner Cloud for Slack: Enhance productivity with real-time collaboration, automate business processes with key AI-infused insights, and grow your channel with actionable analytics in operational dashboards, all without leaving Slack.
Set Up Einstein Lead Scoring for Partners: Give channel managers and partners access to scores that help to prioritize leads. Turn on Einstein Lead Scoring, assign permission sets, and verify whether your site developer must add the Einstein Scoring component to the Lead detail page in your Experience Cloud site.
View Partner Relationship Management Dashboards: A glance at the predesigned dashboards that are included with Partner Relationship Management (PRM) gives channel managers a comprehensive overview of KPIs for partners.
Set Up Einstein Opportunity Scoring for Partners: Give your partners access to scores that help them focus on the right deals. Turn on Einstein Opportunity Scoring, assign permission sets, and verify whether your site developer must add opportunity scores to your Experience Cloud site pages and list views.
View Partner Relationship Management Reports: Channel managers can stay on top of partner performance with the predesigned reports that are included with Partner Relationship Management (PRM).
User License and Experience Cloud Template Support for Partner Cloud: Partner Cloud provides channel managers and partners with productivity features that help everyone work together. To gain access to Partner Cloud features, you must purchase the required licenses for each feature and your partner site must be built using Experience Cloud templates that support those features. Learn more about license requirements and feature availability in templates.
Process Member Benefit Action: The Process Member Benefit Action is a flow action used to execute the Benefit Action associated with a benefit in a Member Benefit record.
Examples of Promotion Setup: Here are two examples of loyalty program processes. One of them processes Accrual-type transactions and the other one processes Redemption-type transactions.
Debit Points for Member Redemptions (Example): The program manager of Cloud Kicks Inner Circle has set up a loyalty program process that processes Redemption type transactions in real time. The process must debit points from the member's points balance and issue a voucher if members buy a promoted product.
Credit Points for Member Accruals (Example): The program manager of Cloud Kicks Inner Circle has set up a loyalty program process that processes Accrual type transactions in real time. The process must credit points to the member's points balance and update the member's usage of a cumulative promotion if the promotion is associated with the transaction journal. If the member reaches the promotion's target, points must be credited to the member.
Create a Loyalty Program Process Parameter: Parameters store static values, dynamic values, and formulas. You can use parameters to define conditions or actions. Parameters can store multiple value types depending on the type and data type of the parameter.
Transaction Journal Processing: Promotion Setup can process incoming and new Acrrual and Redemption-type transaction journals either in real time or in batches. You can also use both methods simultaneously for a loyalty program process.
Process Transaction Journals in Batches by Using Flow Action: Use the Run Program Process for Transaction Journal action in Flows to process transaction journals in batches. This action only processes the transaction journals whose status is Pending.
Process Transaction Journals in Batches: You can either use a Flow action or use Batch Management jobs to process pending Transaction Journal records in batches.
Process Transaction Journals in Batches Using Batch Management: Schedule Loyalty Program Process type Batch Management jobs to process pending Transaction Journal records in manageable batches. Loyalty Program Process type jobs select and process transaction journals based on the filter criteria that you define for the job.
Process Transaction Journals in Real Time: The Transaction Journal Execution Business API lets you process transactions in real time as soon as members make a transaction. You can integrate the Connect API with apps that generate transactions for a sale or service.
Loyalty Program Process Rule Actions: Trigger a range of actions for transaction journals that are processed by a rule. Depending on the business scenario of the rule, you can either trigger actions independent of any conditions or add actions as child steps of conditions.
Loyalty Management Flow Type: To create flows that the Run a Flow action triggers, use the Loyalty Management Flow type in the Flow Builder. You can use a restricted number of elements in flows of the type Loyalty Management Flow.
Verify Member’s Data Cloud Segment: Rules related to promotions in loyalty program processes can filter member transactions based on whether the member belongs to the promotion’s Data Cloud segment. The Promotion Eligibility component on Loyalty Program Member, Contact, and Account records can categorize promotions based on whether the member belongs to the promotion’s Data Cloud segment. You can segment based on the loyalty program members or contacts in your org in Data Cloud. Admins can decide how loyalty program process rules and the Promotion Eligibility component verify a member’s Data Cloud segment before processing transactions and categorizing promotions.
Loyalty Program Process Rule Conditions: A condition determines whether a transaction journal is eligible for an action. You can also create a condition group and define a set of conditions together. A condition can have a child action or a child condition.
Add Conditions and Actions to a Rule: Add conditions and actions in a rule to decide how you want a transaction journal to be processed by the rule. Use conditions to decide the transaction journals that you want the rule to process. Use actions to get information about the member, update member records, and run flows and standard type decision tables that are created by admins.
Create a Formula in Loyalty Program Process: You can use a formula to determine either the value of a parameter, the resource or value of a condition, or an input field of an action.
Provide Access to Data 360 Preference Forms: Give customers access to your preference form by adding the domain where it’s hosted to the Cross-Origin Resource Sharing list. Publish the form, create tokens to give your users access to the form, and host your Data 360 preference form on a static web page.
Quip: Quip helps you collaborate and create, all in one place. With Quip, your users can project manage with living documents and spreadsheets that centralize teamwork. It doesn’t matter if people are in the same room or on the other side of the globe. They can work in tandem and focus on what matters.
Quip Actions in Process Builder: Create documents, chat rooms, and folders when important events occur. Attach a document to a record so that your users have information in context. Update your spreadsheets with the latest Salesforce data. Send a message to a chat room or document. Add new slides to a deck, copy documents, add members to a document or chat, lock document edits, and more.
Salesforce Activities in Quip: Log calls, set up tasks, and schedule events from a Quip document. Get credit for your activity in the same place that you take notes, track your progress, and collaborate on your Account Plans.
Add a Competitive Analysis Section to an Existing Account Plan: Use Flow Builder to automatically add a section to the document associated a record each time the record is updated. For example, if you create an Account Plan template and associate it with the Account object, you can use the Edit Quip Document action to add a Competitive Analysis section.
Add a Salesforce Data Mention: Use Salesforce data seamlessly in your documents and spreadsheets with Salesforce Data Mentions. Mention live data from Salesforce to see dynamic fields that stay updated with the latest Salesforce data. Update fields from your documents and spreadsheets and sync them to Salesforce.
Automate Pricing Proposals with Flow Builder: Save time manually creating and filling out Pricing Proposals with templates in Flow Builder. Use Process Builder and Flow Builder to automatically add a Pricing Proposal template to an Opportunity and generate an auto-populated proposal when the Opportunity stage is set to Proposal/Quote. When the Opportunity is set to Closed/Won, export the proposal to a PDF and attach it to the Opportunity for record keeping.
Quip Actions in Flow Builder: Quip provides several core actions for organizing, creating, and copying your Quip content in flows. To add one of these actions to your flow, drag an Action element onto the canvas. Then select the Quip category, and search for the appropriate action.
Area Charts: Use an area chart to spot trends in data over time. Use a stacked area chart to visualize parts of a whole in datasets over time.
Bar Charts: Quip provides these types of bar charts: bar, stacked bar, and bar stacked to 100 percent. Use a bar chart to compare related values. Use a stacked bar chart to compare parts of a whole and show values across one or more categories. Use a bar chart stacked to 100 percent to compare the proportions between values in one or more categories.
Bubble Charts: Bubble charts use the size and coloring of bubbles to show multiple dimensions and measures. Use a bubble chart to illustrate the relationship between two columns of numerical data in your spreadsheet. A third numerical column represents the size of each bubble in the chart.
Column Charts: Quip provides these types of column charts: column, stacked column, and column stacked to 100 percent. Use a column chart to compare related values. Use a stacked column chart to compare parts of a whole and show values across one or more categories. Use a column chart stacked to 100 percent to compare the proportions between values in one or more categories.
Combo Charts: Combine a bar chart and a line chart to show more than one data series.
Donut Charts: Use a donut chart when you have a grouping and want to show not only the proportion of a single value for each group member against the total, but also the total amount itself.
Customization Options for Charts: After you create a chart, use the Chart Editor to customize the data the chart uses, select a new chart type, update the chart labels, and more.
Line Charts: Use a line chart when you have one important grouping representing an ordered set of data and one or more values to show.
Pie Charts: Use a pie chart when you have multiple groupings and want to show the proportion of a single value for each grouping against the total.
Scatter Charts: Use a scatter chart to show correlation between two groups of data.
Create Charts with Spreadsheet Data: Turn any range of your spreadsheet data into a chart. Charts dynamically update to reflect changes to your spreadsheet data.
Connect Quip User Engagement Metrics to Salesforce Records: To associate Quip user engagement metrics with a Salesforce record, link the Collaboration User Engagement Metric object to the Collaboration Document Metric Record object.
Comments: Keep collaboration in context with embedded comments in Quip. Comments change color after you read them so you can focus on the content that still needs your attention.
Configure Your Template: After you finish gathering your template requirements, build a template in Quip and add the Salesforce data that your company needs.
Quip Templates and Automation Limits: These limits govern the use of Quip templates and automation. Make sure to stay within them for best performance.
Create a Collection: If you have lots of Favorites, organize them into Collections to make them easier to find.
Create a Folder: Organize your documents into groupings that make sense to you.
Create a Task: Track action items for yourself and others.
Salesforce Data Mentions: Add live Salesforce data to your documents, spreadsheets, and Account Plans without getting in the way of your formatting. With in-line data mentions, data reads like normal text but stays up to date and syncs with Salesforce. Edit the record fields from the data mentions, making it easier to keep your Salesforce work in Quip.
Decide Between a Quip Managed Site and Your Main Quip Site: To test out your new Quip features with a sandbox org before you roll them out to your users, you have two options: use the same main Quip site with your sandbox and production Salesforce orgs or use a Quip managed site.
Mark a Salesforce Org as the Default: To redirect users to a specific Salesforce login page when they log in to their Quip site, mark the Salesforce org as the default. Then the Salesforce Single Sign On (SSO) users can automatically connect the default Salesforce org to Quip.
Org Removal Considerations: Before you remove Salesforce orgs from your Quip allowlist, keep in mind these considerations. You can add a removed org to your allowlist again later.
Documents: Bring your documents to life with real-time collaboration in Quip documents.
Use Dropdown Lists in Spreadsheet Cells: Create a dropdown list for a cell or series of cells to let users choose from a group of defined values when entering data.
Templates and Dynamic Fields: Templates save time copying and pasting, standardize your business practices, and help you get the most out of your Salesforce data. To auto-fill your embedded templates with data from a Salesforce record, you can use Salesforce Template Data Mentions or mail merge syntax.
Dynamically Filter Live Salesforce Reports from Quip: Save time tailoring your master report to each individual by automatically filtering your reports based on your users, region, and more. Add a filtered Salesforce report to a document embedded in a Salesforce record. Embedded reports dynamically filter based on the record’s data.
Edit a Comment or Message: Did you mix up your emojis, @mention the wrong teammate, or change your mind about what you wrote? No worries. Edit comments and messages from the conversation pane. You can also edit comments inline.
Edit a Template: Safely update templates from the Template Library.
CRM Analytics Dashboards in Quip: Add live CRM Analytics dashboards to your documents and templates. You can update dashboard filters, interact with the components, and collaborate with your team on live Salesforce data.
Set Up the CRM Analytics Live App in Quip: Set up your organization to use CRM Analytics dashboards in Quip. After you set it up, users can see and update filters directly in their documents and slides.
Emojis and GIFs: Add some fun to your comment, conversation message, document, or spreadsheet with emojis and GIFs.
Report on Quip Engagement with CRM Analytics: Get metrics on how your users engage with templates and documents embedded in Salesforce and connect them to other data sources in CRM Analytics.
Use Favorites and Collections: Keep important documents accessible with Favorites. Group Favorites by topic with Collections. All your Favorites appear in the Home tab of the sidebar.
Filter a List View in Quip: To see only the data that’s relevant to you, add filters to your list views in Quip.
Customize Your Salesforce Report Filters in Quip: Apply your Salesforce report’s custom filters in Quip. Edit filter values to create a customized report view that you can share and collaborate on with your team.
Filtered Salesforce Reports in Quip: Apply your Salesforce report’s custom filters to tailor your report view in Quip. Use filters to sort your reps’ open opportunities by region or track your reps’ progress. You can even dynamically filter live Salesforce reports based on the record they’re embedded in.
Sort and Filter Spreadsheet Data: See only the data that you want to see with filters and filter views. Sort to see your data how you want to see it.
Folder Limits: To keep your Quip folders reliable and consistent, there are limits on the number of items and members that you can add, depending on the folder type.
Get Started with Quip: Review some important information about products, features, and accessibility to get the most out of Quip.
Insert Elements into Documents: Use the @ symbol to mention people, documents, and more. Or, insert a range of elements such as spreadsheets, media, and data.
Install the Quip Setup Starter Managed Package: Get a taste of Salesforce integration features with the Quip Setup Starter managed package. After you connect your Quip site to Salesforce, install the managed package to set up Quip Lightning components, add templates to Salesforce records, and set up automation.
Quip Associated Documents Component: Keep your documents in context with the Quip Associated Documents component. Associate related documents to records in Salesforce to make important information easy to find. See documents linked to related records and child accounts so you’re always getting the complete picture. Get smart document suggestions of documents that may be related to a record based on the record’s name.
Link a Document Based on a Template: Access the Quip Template Library in Salesforce to quickly create a new Quip document that’s automatically linked to a Salesforce record. If the template contains mail merge syntax, it’s populated with Salesforce data automatically.
Salesforce List Views in Quip: See your Salesforce list views and related lists in Quip. You can do bulk updates, sync your changes to Salesforce, and add list view filters. You can even add notes and next steps that you can share with your team.
Add a Salesforce List View in Quip: Bulk update your Salesforce list views, add next steps, and keep your team in the know. The Salesforce List live app uses live Salesforce data so that your list views are always current.
Add Lists in Spreadsheet Cells: Format a Quip spreadsheet cell as a bulleted list, a numbered list, or a checklist. You can include one list type per cell.
Live Apps and Live Data: Create alignment, prioritize backlogs, and track progress with live data in Quip. Keep your team up to date with native Quip live apps, use third-party live apps, or create your own live apps to meet your business’s custom needs.
Live Data in Quip: See which live data applications work in Quip. Learn more about live apps, like the Salesforce Record live app or the Calendar live app, as well as other live data, like Salesforce reports or Salesforce data mentions.
Lock Edits in Documents: Prevent other users from making accidental changes or deleting document content. Keep entire documents secure, or only lock specific sections.
Lock Data in Quip Spreadsheets: Lock individual cells, a spreadsheet tab, or an entire spreadsheet to prevent accidental edits to spreadsheet data. Locking spreadsheet data prevents you and other users from making edits.
Decide Between Template Data Mentions and Mail Merge: Templates save time copying and pasting, standardize your business practices, and help you get the most out of your Salesforce data. To auto-fill your embedded templates with data from a Salesforce record, you can use Salesforce Template Data Mentions or mail merge syntax.
Manage Notifications: Determine the kinds of notifications that you receive and when you get them.
Manage Quip Permissions: Give your team access to Quip with permission sets in Salesforce. Add your users to your Quip site, manage your users’ access to Salesforce data in Quip, and more.
Mark a Document as a Template: To differentiate documents that your team uses as templates, mark your documents as templates in Quip. See what documents are embedded in Salesforce based on the object, convert your embedded documents to templates, and access them from the Template Library in Quip.
What Time Zone Is Used for Quip Metric Reporting?: Quip metrics are aggregated for a given day in Coordinated Universal Time (UTC), but Salesforce reports show metrics in your local time zone. At certain times of day, UTC differs by 1 day from your time zone. For this reason, Quip metrics from a single date sometimes appear incorrectly in your Salesforce reports. To see more accurate metric dates, report on the Metric Date Only and Last Updated Date Only fields.
Migrate Your Sandbox Templates to Production: After you finish testing your templates in sandbox and get feedback from your pilot users, update your templates to work in your Salesforce production org.
Enable Mirrored Salesforce Permissions: To let users access only the same Salesforce data in Quip as in Salesforce, enable Mirrored Salesforce Permissions.
Mirrored Salesforce Permissions: Manage access to Salesforce data in Quip with Mirrored Salesforce Permissions. After it’s enabled, users can access only the same Salesforce data in Quip as in Salesforce.
Monitor Folders for Limits: You can monitor folders that approach or reach their item and member limits.
Add a Document to a Folder: Relocate documents and spreadsheets to make them easier to find or to change who they’re shared with quickly. When you move or add a document to another folder, the document members change to reflect the folder members.
Move a Folder: Reorganize your folders by dragging and dropping them in the Folders tab or by using a Folder menu option.
Multi-Org Allowlisting in Quip: Use allowlists to manage what Salesforce data your users can access from Quip. Add preapproved orgs to your allowlist or disallow orgs that you don’t want your users to pull data from. Allowlists ensure that company-critical data stays secure and users access only the Salesforce data in Quip that you approve.
Multi-Org Allowlist Considerations: When setting up your Salesforce org allowlist in the Quip Admin Console, keep these allowlist action considerations in mind. Also, some actions have more considerations that are described in their reference topics.
Navigation and Folders: Learn how to use the Quip sidebar, search, and keep your files organized with folders.
Notifications: Get notified about the Quip changes and documents that you care about.
Open Documents in the Quip Desktop App: Set up Quip so that all document links to your Quip site open in the Quip desktop app instead of your web browser.
Learn About Quip Permissions: Quip Advanced and Quip for Customer 360 enable permissions from two different permission sets.
Preview Documents in Quip: Quickly preview and navigate between cross-referenced documents with Quick Peek. Without opening new tabs, view document content and respond to activity in linked documents.
Private Folder: By default, each Quip site member has a Private folder. When you create a document, it appears in your Private folder.
Publish Templates to the Template Library: To publish company-wide templates to your Quip site’s Template Library, create a company gallery and publish templates to it.
Salesforce Records in Quip: See your Salesforce records and customize your record views in Quip. You can do bulk updates and sync your changes to Salesforce. You can even add notes and next steps that you can share with your team.
Add a Salesforce Related List in Quip: Add record-specific related lists to a document with the updated Salesforce List live app. Stay on top of deals and cases with in-line editing, comments, and bi-directional syncing to Salesforce.
Relationship Map Live App: Add lightweight org charts and relationship maps to your documents. Build relationship maps in your Account Plans with imported Salesforce record data. Create custom and Salesforce cards to manage customer relationships, key stakeholders, and relationship health from an Account Plan.
Rename or Delete a Collection: Remove collections that you don’t need, or rename collections to better reflect the documents in them. When you delete a Collection, the documents in the Collection are no longer marked as Favorites.
Report on Quip Engagement: Run reports in Lightning Experience that show how and which users engage with documents and templates associated with Salesforce records. Go further with templates and see what’s working for your team, and what needs your attention.
Request Historical Engagement Metrics: Quip captures 30 days of historical engagement metrics automatically. If you want a more comprehensive view of your user engagement, you can request additional historical metrics from the Quip Admin Console.
Restrict External Sharing from Your Quip Site: When you restrict external sharing, your users can’t share documents or folders with people outside your site. Restricting external sharing also prevents your users from creating publicly shared links and adding documents or folders to shared folders that are owned by other companies.
Restricted Sharing in Quip: Quip makes it easy to balance security with collaboration. To keep your content secure, you can prevent users from sharing content with external organizations. You can also limit sharing to a trusted allowlist. Restricting sharing doesn’t change users’ access to documents or folders that are already shared.
Test and Roll Out Your Quip Site: Use these tips to plan your Quip rollout from start to finish. Build templates, test Salesforce and Quip permissions, and get feedback from your pilot users, all from the safety of your sandbox org. Then, when you’re ready to share with your users, migrate your changes to production.
Test Your Quip and Salesforce Configuration with Health Check: Use the Quip Health Check to run automated tests on your Quip site and Salesforce org connection. When Health Check identifies a problem, get on-the-spot results and solution recommendations.
Connect Quip VPC to Salesforce: Connect your Quip VPC site to Salesforce to get your users in sync, use Quip Lightning components, and more, all while keeping your data secure.
Quip in a Sandbox: Set up and test your Quip features with a sandbox Salesforce org.
Let Sandbox Users Log In to Quip with SSO: Add your sandbox orgs to the Quip Admin Console so that your sandbox users can automatically use Salesforce Single Sign-On to log in to Quip.
See Referenced Documents in Quip: See the links to and from a given document in one place. View all the documents that reference the document that you’re working in, or see all the documents that are mentioned within the current document. Don’t worry about document security: You see only the documents that you have access to.
Set Up the New Document Global Action: To let your users create a document no matter where they are in Lightning Experience, add the New Document global quick action to your global publisher layouts.
Add a Blank Document: Create a blank Quip document that’s automatically linked to a Salesforce record.
Add an Existing Document: Search for or provide the link to an existing Quip document to link it to a Salesforce record.
Add a Document Based on a Template: Access the Quip Template Library in Salesforce to quickly create and embed a new Quip document that’s automatically linked to a Salesforce record. If the template contains mail merge syntax, it’s populated with Salesforce data automatically.
Keep Users Working in Lightning Experience: Remove the Open in Quip button from Lightning Experience so that your users always collaborate within the context of your Salesforce records.
Create a Salesforce Relationship Map: Use Salesforce data to build a lightweight relationship map in your documents. Create a map with Salesforce record data or add custom cards to build a hybrid map.
Share a Comment or Message: Let your teammates know about an important part of the document conversation by broadcasting, forwarding, or linking to it.
Share a Document or Folder with a Link: Link sharing allows you to share a document or folder with a wide audience quickly. Instead of sharing a document or folder with individuals, you broadcast a link to it. Anyone with access to the link has view and edit access to the document or folder.
Shared Folders: Shared folders are folders that you can add members to. Quip includes three types of shared folders—standard, group, and workspace.
Sharing and Access: Learn how to share your documents and control who has access to your documents, spreadsheets, and folders in Quip. Only members of your organization’s Quip site can see the Share settings.
Navigate Quip Using the Sidebar: Use the Quip sidebar to quickly find your documents, browse folders, see notifications, and more.
Solution Kits for Quip: Get the most out of Salesforce with your Quip integrations by implementing one or more solution kits. Get feature recommendations, workflow details, and instructions to help you implement the solution from start to finish.
Create a Spreadsheet Filter View: Create a filter view to filter spreadsheet data without affecting your teammates’ views. Any member of the spreadsheet can use or edit your filter views.
Create a Spreadsheet Filter: Filter data in your spreadsheet. When you turn on filtering, you filter the view for everyone who’s a member of the spreadsheet.
Reference Data in Spreadsheets: Show the values in a cell, range of cells, or sheet from one spreadsheet in another spreadsheet. Referenced data retains the source formatting, and it refreshes automatically when you load the spreadsheet or when the source data is updated.
Spreadsheets: Organize your data in spreadsheets, and view it in context in Quip documents.
Supported Browsers and Devices for Quip: You can use Quip in a web browser, in the desktop app, or on a mobile device. See the compatible browsers, operating systems, and mobile devices.
Supported Languages for Quip: See the languages that Quip supports, and learn how to update your language settings.
Synced Sharing: Streamline user access to embedded documents with synced Salesforce record sharing permissions. Set access at the org level for all documents linked to a Salesforce record rather than manually granting access to individual documents.
Standardize Team Collaboration with Synced Sharing: Use Synced Sharing to set access to documents linked to Salesforce records at the org level. Set Synced Sharing to Comment Access so that your users can comment on a Mutual Close Plan linked to an Opportunity and close deals as a team.
Enable Restrict Synced Sharing Document Access: Make document access granted through Synced Sharing dynamic. Users who can access a document with Synced Sharing aren’t permanent document members. When their Synced Sharing access level changes, so does their document access.
Restrict Synced Sharing Document Membership: Make document access granted through Synced Sharing dynamic by preventing users from joining documents as members when they edit or comment on a document. Enable Restrict Synced Sharing Access to block users from becoming permanent document members regardless of their document activity. Ensure that when a user's Synced Sharing access level changes, so does their document access.
Tasks: Manage your work across documents and teams with tasks.
Template Configuration: Learn about templates, identify your template requirements, and create a template in Quip.
Template Library: Make it easy to find and create templates in Quip. With the Template Library, users can create and share templates in private galleries, like the Created by Me and Shared with Me galleries, or get started with example templates.
Automate Close Plans with Flow Builder: Save time manually creating and filling out Mutual Close Plans with templates in Flow Builder. Use Process Builder and Flow Builder to automatically add a Mutual Close Plan template to a record and generate an auto-populated Close Plan when the Opportunity stage changes. Add the copied document to a folder and send a message to @everyone to notify users that a document was created.
Manage Templates in Salesforce: Surface documents embedded in Salesforce records from the Template Manager. Open a preview of the document in Quip and mark it as a template.
Quip Engagement Metric Objects and Fields: Use Quip engagement metrics in Lightning reports to measure which users are interacting with documents associated with Salesforce records, and how those users are interacting with them.
Report on Quip Usage with Salesforce Reports: Get metrics on how your users engage with templates and documents embedded in Salesforce. Create custom Quip reports and add them to your Lightning dashboards.
Add a Salesforce Template Record in Quip: As you set up your templates, use Template Records. When a user creates a document from your embedded template, the Salesforce template records automatically populate with the record’s data and continue to stay up to date. Control the fields that your users see to keep information relevant and boost Account Plan adoption.
Add a Salesforce Template Related List: As you set up your templates, use Template Related Lists. When a user creates a document from your embedded template, the Salesforce template related lists automatically populate with the record’s data and continue to stay up to date. Configure the Salesforce List live app in Quip to auto-populate with a list of Opportunities related to an Account.
Templates: Use document templates to streamline your business practices within the context of your Salesforce data, without compromising on customization.
Template Requirements Gathering: Turn your best practices into standard processes and apply them at scale with templates. Here are some things to keep in mind as you decide what templates your users must be successful.
Trash Folder: Do away with content that you no longer need.
Turn Off Live Paste Automatic Updates: You can turn off automatic updates for content that users paste with Live Paste. When automatic updates are off, only members of the source document can update Live Pasted content.
Live Data in Quip: Learn about the different live data integrations you can add to your documents, spreadsheets, and templates.
Use Live Paste in a Quip Document: Use Live Paste to duplicate information across documents, gather distributed content in a central document, or reference pertinent information across related documents.
Quip in a VPC: Let your users collaborate and stay productive while keeping your Salesforce data secure. Control what Salesforce data your users can access and where.
Set Up the CRM Analytics Live App in a VPC: Set up your organization to use CRM Analytics dashboards in Quip VPC. After you set it up, users can see and update filters directly in their documents.
Enable Live Apps in a Quip VPC: Give your new VPC users access to first-party live apps in a document, like the Salesforce List, Salesforce Record, or CRM Analytics live app.
Event Log File Browser: Event Log File (ELF) Browser in Setup gives you quick access to event log files so you can explore and download all of your event log file data.
Analyze Log Data with Salesforce Direct: Transform your log data into clear, insightful visualizations. Explore Event Log Objects in CRM Analytics with Salesforce Direct using a variety of engaging chart types.
Event Log Objects Analytics: The new suite of analytic dashboards provide deep, actionable insights across the three critical sectors of an organization: Platform Performance, Data Security, and User Adoption. By providing unprecedented visibility into org activities, users can shift from reactive problem-solving to proactive platform management.
Performance & Health Analytics: These analytic dashboards focus on proactively identifying, troubleshooting, and resolving performance bottlenecks to ensure platform stability. Users can pinpoint specific slow Lightning pages, inefficient Apex code, and problematic API integrations, allowing them to optimize the user experience.
Threats & Access Analytics: This analytics dashboard monitors for threats, such as session hijacking, credential stuffing, high-risk activities, data exfiltration, and authentication patterns. Highlighting these risks and activities allows users to respond quickly to threat incidents and simplify compliance audits.
User Behavior & Adoption Analytics: This analytic dashboard provides deep insight into how users are engaging with an application, which features they use most, where they get stuck, providing valuable data for driving adoption and refining training.
Store and Query Log Data with Event Log Objects: The Event Log Object framework surfaces event data stored in standard objects called Event Log Objects. They store critical event data that you can query via Salesforce Platform APIs. Event log objects contain many but not all events currently represented in the Event Log File framework. Unlike Event Log Files, which surface event data as CSV files, Event Log Objects allow querying of similar data via SOQL.
View Threat Detection Events and Provide Feedback: Launch the Threat Detection app and view all the detected threats that occurred in your Salesforce org. Threats include anomalies in how users run reports, session hijacking attempts, and credential stuffing. Use the same app to easily provide feedback about the severity of a specific threat.
Make the Threat Detection App Visible to Users: Before you can view the Threat Detection events in Salesforce and provide feedback, you must make the app visible to users. You also specify which of the tabs are visible to different user profiles.
View Events and Provide Feedback: View recent or all Threat Detection events using the Threat Detection app in the Salesforce UI. The displayed events are stored in their corresponding storage objects: ReportAnomalyEventStore, SessionHijackingEventStore, and CredentialStuffingEventStore. Associate a feedback object with a particular event to record the severity of the threat, such as Malicious or Not a Threat.
API Anomaly: An anomaly is any user activity that is sufficiently different from the historical activity of the same user. We use the metadata in Salesforce Core application logs about API generation and surrounding activities to build a baseline model of the historical activity. We then compare any new API generation activity against this baseline to determine if the new activity is sufficiently different to be called an anomaly. We don't look at the actual data that a user interacts with— we look at how the user interacts with the data.
Credential Stuffing: Credential stuffing is a type of cyber attack that uses stolen account credentials. It’s also known as “password spraying” or “credential spills”. Attackers obtain large numbers of usernames and passwords through data breaches or other types of cyber attacks. They then use these credentials to gain unauthorized access to user accounts through large-scale automated login requests against a web application such as Salesforce.
Threat Detection: Threat Detection uses statistical and machine learning methods to detect threats to your Salesforce org. While Salesforce identifies these threats for all Salesforce customers, you can view the information in the events with Threat Detection in Event Monitoring and investigate further if necessary. Threat Detection events do not count towards standard object storage limits.
Best Practices for Investigating API Request Anomalies: Keep these tips and best practices in mind when you investigate unusual user behavior. Find the information you require to make a well-informed evaluation of your data’s safety.
Best Practices for Investigating Report Anomalies: Keep these tips and best practices in mind when you investigate unusual user behavior. They can help you find the information you require to make a well informed conclusion about your data’s safety.
Report Anomaly Detection Examples: Here are several examples that illustrate how you can investigate anomalous report events thoroughly.
Guest User Anomaly: An anomaly is any user activity that is sufficiently different from the other users. We use the metadata in Salesforce Core application logs to build profiles representing guest users’ data access activities. This threat detection event identifies suspicious attempts by guest users to access organization data.
Investigate API Request Anomalies: It's often necessary to further investigate an API request anomaly to either determine if a data breach occurred or to rule it out as benign.
Login Anomaly: An anomalous login refers to the detection of a potential attacker attempting to gain unauthorized access to a legitimate user's account. This threat detection event identifies login attempts that deviate significantly from a user's typical login behavior, such as unusual times of day, unfamiliar devices (endpoints), or unexpected locations. Detecting these anomalies early is critical as a successful login is often the first step in broader malicious activities like data exfiltration or the deployment of malware and phishing campaigns.
Investigate Login Anomalies: It's often necessary to further investigate a login anomaly to determine if a login was unauthorized or to rule it out as benign.
Investigate Report Anomalies: It's often necessary to further investigate a report anomaly to either rule it out as benign or to determine if a data breach occurred.
Training and Inference Steps: Similar to other machine learning or statistical models, our detection model has a familiar two-step process: a training step and an inference or detection step. As a customer, you don't perform either of these steps—Salesforce performs them for you. You only review the detection events generated by our detection mode and take further action if necessary.
Investigate Guest User Anomalies: It's often necessary to further investigate a guest user anomaly to determine if a data breach occurred or to rule it out as benign.
Detection Event Is Definitely Anomalous but Maybe Not Malicious: Alice is a sales rep based in St. Louis. She’s often on the road to meet with clients. When she travels, she generally, but not consistently, use her company’s VPN to log into Salesforce.
API Detection Event Is an Anomaly but Isn’t Clearly Malicious: Alice is a sales rep based in St. Louis. She’s often on the road to meet with clients. When she travels, she generally, but not consistently, uses her company’s VPN to log into Salesforce.
API Detection Event Is Confirmed Malicious: Alan, a Salesforce user, employs an API to query the Opportunity object and extracts 10 million records. It’s the first time that Alan queries the Opportunity object and uses this IP address to log in.
API Detection Event Possibly Anomalous: Rob, a relatively new Sales Operation Lead, uses an API to query the Opportunity object and extracts 10 million records. He previously queried the same object using a different browser and from a different IP address.
Detection Event Is Confirmed Malicious: John, a sales rep based in San Francisco, often travels for work. He regularly downloads reports of his leads for his weekly sales presentations. John has access to 500-1,000 leads and his weekly report downloads typically contain 500–1,000 rows.
Detection Event Possibly Anomalous: Rob recently joined the company as a customer success representative. On Jan 15, 2019, Rob’s account was used to generate a report. Tony, the org’s Salesforce admin, noticed a ReportAnomalyEvent about this report generation activity.
Detection Event Isn’t Anomalous: Jason is a sales data analyst who reports to the regional sales manager. It’s Jason’s job to generate reports for his manager’s sales calls. On March 27, 2019, Jason’s account was used to generate a report. Alia, the administrator for Jason’s org, noticed a ReportAnomalyEvent about this report generation activity.
Report Anomaly: An anomaly is any user activity that is sufficiently different from the historical activity of the same user. We use the metadata in Salesforce Core application logs about report generation and surrounding activities to build a baseline model of the historical activity. We then compare any new report generation activity against this baseline to determine if the new activity is sufficiently different to be called an anomaly. We don't look at the actual data that a user interacts with— we look at how the user interacts with the data.
Session Hijacking: Session Hijacking is a customer-focused attack where attackers try to steal information from using a client’s access to a web application. In our case, this application is Salesforce. When a client successfully authenticates with Salesforce, they receive a session token. The attacker tries to hijack the client’s session by obtaining their session token.
Features of the Browser Fingerprint: A browser fingerprint is a collection of features that together identify a device. Salesforce uses these features to build a model of the user’s original browser fingerprint when they logged in. Salesforce uses this model to detect whether a user’s session was hijacked.
Salesforce Platform Events Connector (Beta): The Salesforce Platform Event Connector lets organizations easily stream event data from Salesforce Real-Time Event Monitoring to Data 360. This helps analyze user patterns for proactive security and meeting compliance needs.
Real-Time Events: Subscribe to real-time Events published by Salesforce to monitor activity in your org. You can store the event data for auditing or reporting purposes. You can also create transaction security policies by using Condition Builder—a point-and-click tool—or Apex code. You can subscribe to this data from an external data system of your choice.
Event Monitoring: Event Monitoring gives you access to detailed performance, security, and usage data on all your Salesforce apps. See who is accessing critical business data when, and from where. Understand user adoption across your apps. Troubleshoot and optimize performance to improve the end-user experience. Event Monitoring data is tracked via the API and surfaces many event logs in the Event Log Browser. You can directly query event log objects, visualize event data in dashboards, or import logs into data visualization or application monitoring tools like CRM Analytics, Splunk, or New Relic. To get started, check out our Event Monitoring training course.
Quick Start: Event Monitoring: If you're new to Event Monitoring, this quick start guide walks you through the most direct path to get set up. Event Monitoring gives you access to detailed performance, security, and usage data on all of your Salesforce apps.
Real-Time Event Monitoring Data Storage: With Real-Time Event Monitoring, you can store and query event data in Salesforce objects. Many of the storage events are Salesforce big objects, which are ideal for storing large volumes of data for up to six months. A big object stores the data natively in Salesforce so you can access it for reporting and other uses. Some storage events, such as for Threat Detection, are standard Salesforce objects.
Real-Time Event Monitoring Data Streaming: Use Real-Time Event Monitoring to subscribe to standard events published by Salesforce to monitor activity in your org. You can subscribe to this data from an external data system of your choice using a Pub/Sub API client, or use event relays to send the real-time events to Amazon EventBridge.
Einstein Discovery for Rebate Analytics (Beta): Use the Einstein Discovery for Rebate Management app to view the rebate-driven sales predictions, identify high-potential accounts to add to rebate programs, and recommend top rebate programs to your customers.
Rebate Management: Rebate Management gives businesses complete control on their rebate’s lifecycle to reward their partners when their partners meet an agreed-upon sales target. Manufacturers give rebates to partners to build deeper loyalty and drive the desired channel purchasing behavior. Use Rebate Management to create rebate programs and define an incentive structure with benefits and corresponding qualification thresholds.
Allocate Budget to Program Members: Allocate portions of the total or sub-budget to program members to prioritize high-performing partners or specific regions.
Define Program Budget: Define a program budget to set the total amount of funds available for a specific incentive, such as a Rebate Program, Ship and Debit, Price Protection, or Stock Rotation.
Debug Your Data Processing Engine Definitions for Rebate Management: Use the Data Processing Engine Debug prebuilt app to add debug nodes to Data Processing Engine (DPE) definitions, and visualize the connections of nodes in a DPE definition. You can add debug nodes to specific nodes in a DPE definition to track the number of records processed by that node in a DPE definition. You can also get a visual representation of a DPE definition that shows how each node is connected with other nodes. The Data Processing Engine Debug app helps you monitor a DPE definition’s performance and plan customizations.
Analyze a Data Processing Engine Run in Explainability Mode: View how records flow through a Data Processing Engine (DPE) definition by analyzing a run in Explainability mode. Use detailed counts for checkpoints or output nodes to validate the setup and confirm that eligibility criteria are applied correctly.
Learn About Rebate Management: Review the features of Rebate Management. See the overall workflow for program management and payout calculation. Explore the data model for Rebate Management.
Manage Budgets: Set, allocate, and track financial budgets to maintain control and visibility over your rebate program commitments. Effective budget management allows you to prevent overspending, ensure funds are available for payouts, and accurately forecast liabilities.
Manage Payout Calculations in Rebate Management: Aggregate transactions, transform orders, calculate rebate payouts, and perform other data processing operations by using Data Processing Engine (DPE). Automate the rebate payout calculation and processing by using flows. Process a large number of records in manageable chunks by using Batch Management. Clone and use the DPE templates, flow templates, and preconfigured batch jobs as-is, or extend them to meet your business needs.
Check Rebate Calculations Using a Flow: Eliminate guesswork and rework by checking which transactions are considered in the rebate calculations by the Rebate Orchestration flow. Use the Check Rebate Calculations prebuilt app to quickly run a screen flow and find out which Transaction Journal records qualify for the final payout for a specific rebate member enrolled in a rebate program, and for a specific payout period. You can also find out which rebate types are applied to the transactions that qualify for payout.
Install the Rebate Transaction Qualification Check Package: To get access to the screen flow for the Calculate Forecasts for Accounts in a Hierarchy prebuilt app, first install the Rebate Transaction Qualification Check package in Salesforce. You can clone and customize the Rebate Transaction Qualification Check flow as per your business requirements.
Use the Check Rebate Calculations Flow: Run the Check Rebate Calculations screen flow to see the list of rebate types and the related transaction journals that are eligible for payout. Based on the results, you can understand how the rebate orchestration flow calculates the payout because you already know the type of transactions that qualify for a specific period. The flow also helps you identify whether the rebate program, the rebate types and their benefits, or the payout period is active or not.
Comparison of Rebate Management and Ship and Debit Process Management: Rebate Management helps manufacturers proactively incentivize partners to achieve predefined sales targets and drive specific purchasing behaviors. Ship and Debit Process Management helps manufacturers reactively compensate partners for price reductions they offer to win competitive deals and protect partners' margins.
Open Items You've Recently Viewed: In the Recent Items section of the Salesforce sidebar, you’ll find a list of up to 10 items (records, documents, custom objects, and the like) you’ve most recently added, edited, or viewed.
Records Import Numbers and Types: The number of records you can import depends on your permissions and the type of data you’re importing. You can import as many records as allowed, as long as you don’t exceed the overall data storage limits for your org.
Recycle Bin: All users can view and restore records in their own Recycle Bin. If you have admin permissions, you can access and manage your own Recycle Bin and the org Recycle Bin, including permanently deleting records.
Manage the Recycle Bin in Lightning Experience: As an admin, you have access to your own Recycle Bin and the Salesforce org’s Recycle Bin. You can view, restore, and permanently delete records in the Org Recycle Bin and your own Recycle Bin. Use list view functionality to sort and filter to find the records you need.
Redemption Process: A redemption transaction occurs when a member redeems non-qualifying points for an award. It’s a real-time process, where the member’s points are deducted from their point balance. You can define redemption processes in Flow using Loyalty Actions or in Apex using Loyalty APIs.
Style Your Surveys Using Custom CSS: Use Custom CSS to design surveys that align with your company style and branding. Customize your survey theme by using Custom CSS for flexible styling, adjusting the font, progress bar, background color, button color and so on.
Survey Question Types: Use a variety of question types to collect the information and feedback you seek.
Surveys Resources: Check out these resources to learn more about how to best use Salesforce Feedback Management.
Relate Records to Survey Invitations and Responses: Relate Salesforce records to survey invitations manually or automatically. When participants respond, their response record is automatically related to their invitation and to their Salesforce record.
Register a Design in Partner Site: Register a design in the partner site, which is then automatically submitted for approval. Channel managers then review and either approve or reject it.
Create a Passkey: For a secure, fast, and easy login with multi-factor authentication (MFA), create a passkey, also known as a built-in authenticator. With passkeys, you have multiple ways to log in: fingerprint or facial scanners on your device, physical security keys, a device PIN or password, or password managers. Some passkeys work only on the device where you set them up. If you set up a device-bound passkey on your laptop, you can’t use it to log in from your phone. If you log in to Salesforce from multiple devices, set up your passkeys so that you can access your account anywhere.
Salesforce Release Manager (Beta): Preview and test features that are in development. With Salesforce Release Manager, you can provide feedback on features that are available only in the Development (Dev) channel for sandboxes. Opt in to Dev channel and switch back to production (Standard channel) at any time.
Manage Release Channels: With Salesforce Release Manager (SRM), your organization can preview and test upcoming features before their wider release. Opt in to the Development (Dev) channel in sandboxes for features that are in active development. Organizations use the standard channel by default.
Manage Channel Features: Preview and test features that are in active development in the Dev channel, which is available in sandboxes. You get to try out new features before their wider release, provide feedback, and help shape the product roadmap.
Release Updates: Salesforce periodically releases updates that improve the performance, security, logic, and usability of your Salesforce org, but that can affect your existing customizations. When these updates become available, Salesforce shows them in the Release Updates node in Setup.
Manage Release Updates: Act on release updates to keep your Salesforce org functioning at its best. Release updates replace the Critical Updates console and include more detailed information about upcoming changes.
Access Tokens: Access tokens are your key to Salesforce APIs. When a client successfully completes an authorization flow, whether it’s a standard OAuth 2.0 flow or a headless identity flow, Salesforce issues an access token that can be used to access protected Salesforce data. Salesforce supports two types of access tokens: opaque tokens and JSON Web Token (JWT)-based access tokens. Each type has its own merits and limitations based on your use case.
Demo the Asset Token Flow: For a quick demo of asset tokens, you can use the Asset Token Explorer demo app. The demo app simplifies your initial experience of getting an access token and exchanging it for the asset token.
Demo the Asset Token Flow: For a quick demo of asset tokens, you can use the Asset Token Explorer demo app. The demo app simplifies your initial experience of getting an access token and exchanging it for the asset token.
OAuth 2.0 for First-Party Applications: Configure Experience Cloud Settings: Before you build headless username-password login, passwordless login, and registration flows using the OAuth 2.0 for First-Party Applications draft protocol, configure Experience Cloud settings on the Login & Registration page.
OAuth 2.0 for First-Party Applications: Generate a Client Attestation JWT: When using headless identity flows that implement the OAuth 2.0 for First-Party Applications draft standard, use a client attestation JWT to prove that apps sending requests to Salesforce are first-party apps created by your company.
OAuth 2.0 for First-Party Applications: Headless Passwordless Login for Private Clients: With headless passwordless login, users log in to your off-platform app via their email address or phone number and a one-time password. To set up passwordless login for an off-platform app developed by your company, use this headless passwordless login flow, which implements the OAuth 2.0 for First-Party Applications draft protocol. With this flow, you can entirely control the front-end login experience in your first-party app while Salesforce handles the backend work of authenticating users and granting access to protected resources. This flow is supported only for private clients, such as client-server apps, and is supported only for external users.
OAuth 2.0 for First-Party Applications: Headless Registration Flow for Private Clients: To set up a headless user registration process for an off-platform app developed by your company, use this flow, which implements the OAuth 2.0 for First-Party Applications draft standard protocol. This flow is supported only for private clients, such as client-server apps. With this flow, you can entirely control the front-end registration experience in your first-party app while Salesforce handles the backend work of authenticating users and granting access to protected resources. This flow is supported only for private clients, such as client-server apps, and is supported only for external users.
OAuth 2.0 for First-Party Applications: Headless Username-Password Flow for Private Clients: To set up username-password login for an off-platform app developed by your company, use this headless username-password login flow, which implements the OAuth 2.0 for First-Party Applications draft standard protocol. With this flow, you can entirely control the front-end login experience in your first-party app while Salesforce handles the backend work of authenticating users and granting access to protected resources. This flow is supported only for private clients, such as client-server apps, and is supported only for external users
Query SAML Authentication Settings: You can query the authentication configuration endpoint for information about an org's or Experience Cloud site's SAML single sign-on (SSO) and authentication provider settings. Use this functionality when you’re developing apps that need this information on demand.
Headless Identity APIs: Authorization Code and Credentials Flow for Public Clients: For public clients such as single-page apps or mobile apps, you can set up headless login for customers and partners by using the Authorization Code and Credentials Flow. This flow is built on the OAuth 2.0 Authorization Code grant type. With the Authorization Code and Credentials Flow, you control the front-end login experience in a third-party app. You call Salesforce Headless Login APIs via your Experience Cloud site to handle the back-end work of authenticating users and granting access to protected Salesforce resources. With separate front-end and back-end processes, your users can log in and access Salesforce data without leaving your app. For single-page apps, you use a server-side callback endpoint to extract the authorization code, and you perform the code exchange from the browser via client-side JavaScript.
Authorize Apps with OAuth: OAuth is an open protocol that authorizes a client application to access data from a protected resource through the exchange of tokens. OAuth tokens are essentially permissions given to a client application.
Block Authorization Flows to Improve Security: The OAuth 2.0 user-agent and username-password flows are considered insecure and aren’t recommended. For better security, we strongly recommend that you block these flows in Salesforce to prevent developers from using them to build new integrations. If your org is created in Summer ‘23 or later, the username-password flow is blocked by default. You can enable the username-password flow if needed. If you have existing integrations that use the user-agent or username-password flow, update them to a more secure OAuth 2.0 flow. You can also block the Authorization Code and Credentials Flow, which is used to securely configure a headless login process. And you can block certain flows that don’t use the PKCE extension.
Block Authorization Flows to Improve Security: The OAuth 2.0 user-agent and username-password flows are considered insecure and aren’t recommended. For better security, we strongly recommend that you block these flows in Salesforce to prevent developers from using them to build new integrations. If your org is created in Summer ‘23 or later, the username-password flow is blocked by default. You can enable the username-password flow if needed. If you have existing integrations that use the user-agent or username-password flow, update them to a more secure OAuth 2.0 flow. You can also block the Authorization Code and Credentials Flow, which is used to securely configure a headless login process. And you can block certain flows that don’t use the PKCE extension.
OAuth 2.0 DPoP Guide: To secure your client apps, implement the Demonstrating-Proof-of-Possession (DPoP) extension for OAuth integrations. DPoP cryptographically binds OAuth access and refresh tokens to your client. To use a token, clients must prove that they own the private key. Even if a token is leaked or stolen, a threat actor can’t use it without the private key.
OAuth 2.0 DPoP Supported Flows and Endpoints: The OAuth 2.0 Demonstrating Proof-of-Possession (DPoP) extension protects access to your Salesforce data. It works by cryptographically binding OAuth access and refresh tokens to the client that requested them. Even if an attacker gets access to a token, they can’t use it to access your data. You can use DPoP with most OAuth flows, and you can use DPoP-bound access tokens to request access to Salesforce resources for supported endpoints.
OAuth 2.0 for First-Party Applications: Configure an External Client App for Headless Identity Flows: To develop headless identity flows that use the OAuth 2.0 for First-Party Applications draft standard, configure an external client app. For these flows, you must configure your external client app via Metadata API. Use these steps to configure an app for headless username-password login, passwordless login, and registration.
OAuth 1.0.A Authorization Error Codes: Errors can occur during authorization. For example, the callback URL is invalid. When errors occur during the OAuth 1.0.A flow, Salesforce returns an error code.
Headless Login Without a Username: Use headless user discovery to develop a flow where users log in with any identifier, such as an email address, phone number, or order number, instead of a username. Headless user discovery is supported for login, passwordless login, and forgot password flows.
Configure Experience Cloud Settings for Headless User Discovery: With headless user discovery, develop headless authorization flows that don’t require users to enter a username. To use headless user discovery for login, passwordless login, and forgot password flows, configure settings on the Experience Cloud Login & Registration page.
Use Multiple Email Templates for Headless Flows: By default, for the verification email sent to end users, the Headless Registration Flow, Headless Passwordless Login Flow, and Headless Forgot Password Flow use the email template specified in your Experience Cloud site’s email settings. To expand your email template options, create an email template allowlist using Metadata API. For example, create an allowlist with multiple, custom email templates that each provide a different branding experience.
Headless Identity APIs: Headless Forgot Password Flow for Customers and Partners: Set up a headless password reset process on your app using the Headless Forgot Password Flow, which calls Headless Forgot Password API. Use this flow along with other headless flows to provide native identity experiences. With this flow, a user who has forgotten their password can verify their identity and create a password without ever leaving the branded experience of your app.
Headless Identity APIs: Extending the Headless Guest Flow into a Named User Flow: When you complete a headless guest flow in your off-platform app, you get a guest JWT-based access token with the user’s unique visitor ID (UVID) minted into it. To bring the UVID and all of its associated context into a named user session, you can pass the UVID into a new authorization flow, like a headless login or registration flow.
Headless Identity APIs: Headless Guest Flow for Private Clients: For users who interact with your off-platform app but aren’t necessarily logged in, you can use the Headless Guest Flow to identify users with a unique visitor ID (UVID). When the user logs in or registers, you can carry the UVID forward and maintain any contextual information associated with it, like a user’s preferences. This flow is a variation of the Authorization Code and Credentials Flow.
Headless Identity APIs: Headless Guest Flow for Public Clients: Some users interact with your off-platform app but don’t log in or register. You can issue identifiers in the form of unique visitor ID (UVIDs) for these unknown visitors with the Headless Guest Flow. If the user decides to log in or register, you can pass the identifier into a named user flow, like a headless login flow. Use guest user identity as a tool for carrying context from guest user sessions to named user sessions. This flow is a variation of the Authorization Code and Credentials Flow.
Headless Identity Flows: You can use Headless Identity APIs to configure login, registration, passwordless login, and more for an off-platform app. Headless Identity flows are available only for external users, also known as customers and partners.
Headless Identity APIs: Headless Passwordless Login Flow for Private Clients: To simplify the login process for your off-platform app, configure the Headless Passwordless Login Flow. Users log in to your app by entering their email address or phone number and verifying their identity with a one-time password (OTP). On the front end, you control the user experience in your app. On the backend, your app calls Headless Passwordless Login API via an Experience Cloud site to log the user in. These steps show you how the flow works with a private client, like a traditional client-server app, that can keep information confidential.
Headless Identity APIs: Headless Passwordless Login Flow for Public Clients: Make it easy for customers and partner users to log in to an off-platform app with the Headless Passwordless Login Flow. With this flow, users log in by entering their email address or phone number and verifying their identity with a one-time password (OTP). You control the front-end experience in your app. On the backend, your app calls Headless Passwordless Login API via an Experience Cloud site to log the user in. These steps show you how the flow works with a public client, like a single-page app, that can’t keep information private.
Headless Identity APIs: Headless Registration Flow for Private Clients: For apps that are able to keep confidential information, such as web apps with a client-server architecture, you can set up headless registration for customers and partners using the Headless Registration Flow. The Headless Registration Flow extends the Authorization Code and Credentials Flow, which is built on the OAuth 2.0 Authorization Code grant type. With this flow, you control the front-end user registration experience in a third-party app. You call Salesforce Headless Registration API via your Experience Cloud site to create users, log them in, and give them access to Salesforce resources. By separating these two processes, your users can register for your app and access Salesforce data without leaving the app.
Headless Identity APIs: Headless Registration Flow for Public Clients: For apps that can’t keep confidential information, such as single-page apps, you can set up headless registration for customers and partners using the Headless Registration Flow. The Headless Registration Flow extends the Authorization Code and Credentials Flow, which is built on the OAuth 2.0 Authorization Code grant type. With this flow, you control the front-end user registration experience in a third-party app. You call Salesforce Headless Registration API via your Experience Cloud site to create users, log them in, and give them access to Salesforce resources. By separating these two processes, your users can register for your app and access Salesforce data without leaving the app.
Create a Native Single Sign-On Experience in Your App: With an optional parameter in the OAuth 2.0 web server flow and user-agent flow, you can build a single sign-on (SSO) experience that feels like your third-party app is integrated with an external identity provider. With this process, you link an OAuth flow to an SSO flow while maintaining control of the experience within your app. This parameter is supported for Experience Cloud sites, so you can use this capability to add SSO to a Headless Identity implementation. This parameter is also supported for My Domain.
OAuth 1.0.A Flow: If your org uses the OAuth 1.0.A protocol, use this authorization flow to integrate a client—via a connected app—with the Salesforce API.
OAuth 2.0 SAML Bearer Assertion Flow for Previously Authorized Apps: With the OAuth 2.0 SAML bearer assertion flow, a client—via a connected app—can use previous authorization by supplying a signed SAML 2.0 assertion to request an OAuth access token. The digital signature applied to the SAML assertion authenticates the authorized app. A SAML assertion is an XML security token issued by an identity provider and consumed by a service provider. The service provider relies on its content to identify the assertion’s subject for security-related purposes.
OAuth 2.0 Asset Token Flow for Securing Connected Devices: To integrate IoT devices with the Salesforce API, use the OAuth 2.0 asset token flow. Asset tokens are an open-standards-based JWT authentication token for verifying and securing requests from connected devices. Asset tokens identify the device to a backend service that processes the stream of data and events from the device. These tokens allow registration of device data with the Salesforce platform and linking the device to Salesforce CRM data about the customer, account, or contact.
OAuth 2.0 Asset Token Flow for Securing Connected Devices: To integrate IoT devices with the Salesforce API, use the OAuth 2.0 asset token flow. Asset tokens are an open-standards-based JWT authentication token for verifying and securing requests from connected devices. Asset tokens identify the device to a backend service that processes the stream of data and events from the device. These tokens allow registration of device data with the Salesforce platform and linking the device to Salesforce CRM data about the customer, account, or contact.
OAuth 2.0 Client Credentials Flow for Server-to-Server Integration: Sometimes you want to directly share information between two applications without a user getting in the way. For these scenarios, you can use the OAuth 2.0 client credentials flow. In this flow, the client app exchanges its client credentials defined in the external client app—its consumer key and consumer secret—for an access token. This flow eliminates the need for explicit user interaction, though it does require you to specify an integration user to run the integration. You can use this flow as a more secure alternative to the OAuth 2.0 username-password flow.
OAuth 2.0 Client Credentials Flow for Server-to-Server Integration: Sometimes you want to directly share information between two applications without a user getting in the way. For these scenarios, you can use the OAuth 2.0 client credentials flow. In this flow, the client app exchanges its client credentials defined in the connected app—its consumer key and consumer secret—for an access token. This flow eliminates the need for explicit user interaction, though it does require you to specify an integration user to run the integration. You can use this flow as a more secure alternative to the OAuth 2.0 username-password flow.
OAuth Custom Scopes: An external client app can use the OAuth authorization protocol to access protected resources. As part of the protocol, OAuth default scopes fine-tune the app’s permissions to access protected resources in Salesforce. However, these default scopes are insufficient when an external entity hosts the protected resource. In this scenario, Salesforce plays the role of OAuth authentication and authorization provider, but it has little knowledge about the resource it’s protecting. To define an external client app’s permissions to access protected resources hosted by an external entity, create an OAuth custom scope. The custom scope tells the external entity which information the external client app is authorized to access.
Assign an OAuth Custom Scope to an External Client App: After you create an OAuth custom scope in your Salesforce org, you can assign it to an external client app to set data-access permissions for the app. For example, an external client app with an order_status custom scope has the correct permission set to access order status data from the external entity.
Create an OAuth Custom Scope: To define permissions about the data that an external client app can access from an external entity, create an OAuth custom scope in Salesforce. The custom scope tells the external entity which information the external client app is authorized to access.
Edit an OAuth Custom Scope: You can change the name and description of a custom scope, and update your selection to include the custom scope in the OpenID Connect discovery endpoint.
OAuth 2.0 Device Flow for IoT Integration: To integrate apps that run on devices with limited input or display capabilities, such as Smart TVs, appliances, and other IoT devices, use the OAuth 2.0 device flow. Command-line apps can also use this flow. Users can connect these apps to Salesforce by accessing a browser on a device with more advanced input capabilities, such as a desktop or mobile device.
OAuth 2.0 Device Flow for IoT Integration: To integrate apps that run on devices with limited input or display capabilities, such as Smart TVs, appliances, and other IoT devices, use the OAuth 2.0 device flow. Command-line apps can also use this flow. Users can connect these apps to Salesforce by accessing a browser on a device with more advanced input capabilities, such as a desktop or mobile device.
OAuth 2.0 Echo Endpoint: Use the OAuth 2.0 echo endpoint to simplify development when you configure the Authorization Code and Credentials Flow for public clients, such as single-page apps. You can also use this endpoint for variations of the Authorization Code and Credentials Flow, including headless registration, passwordless login, and guest user flows.
OAuth Endpoints: OAuth endpoints are the URLs that you use to make OAuth authorization requests to Salesforce. Each OAuth flow defines which endpoints to use and what request data to provide.
Enable CORS for OAuth Endpoints: Web applications use Cross-Origin Resource Sharing (CORS) to request resources from origins other than their own. For example, a web page can use CORS to request information about a user from your My Domain login URL or Experience Cloud site URL. In addition to public and allowlisted web pages, Salesforce supports CORS for certain OAuth endpoints when requested from a My Domain login URL or Experience Cloud site URL.
OAuth 2.0 Authorization Errors: Errors can occur during OAuth authorization. For example, a user denies access to the connected app or request parameters are incorrect. When errors occur, the authorizing server sends an error to the callback URL with an error code.
OAuth Authorization Flows: OAuth authorization flows grant a client application restricted access to protected resources on a resource server. Each OAuth flow offers a different process for approving access to a client app, but in general the flows consist of three main steps. To initiate an authorization flow, a client app requests access to a protected resource. In response, an authorizing server grants access tokens to the client app. A resource server then validates these access tokens and approves access to the protected resource.
OAuth Authorization Flows: OAuth authorization flows grant a client application restricted access to protected resources on a resource server. Each OAuth flow offers a different process for approving access to a client app, but in general the flows consist of three main steps. To initiate an authorization flow, a client app requests access to a protected resource. In response, an authorizing server grants access tokens to the client app. A resource server then validates these access tokens and approves access to the protected resource.
OAuth 2.0 Authorization and Session Management for Hybrid Apps: Managing web sessions for hybrid apps is complex with a typical user-agent or refresh token flow. In these flows, a hybrid app sets requested domain cookies and bridges an access token into a web session. But the access token and web session aren’t connected in these flows. Instead you must track when the access and refresh tokens expire and when the web session expires, and then manually rebridge the session to avoid interrupted service. To avoid this complex process, use the OAuth 2.0 hybrid app flows. These flows connect the access and refresh tokens with the web session to give hybrid apps direct web session management.
OAuth 2.0 Authorization and Session Management for Hybrid Apps: Managing web sessions for hybrid apps is complex with a typical user-agent or refresh token flow. In these flows, a hybrid app sets requested domain cookies and bridges an access token into a web session. But the access token and web session aren’t connected in these flows. Instead you must track when the access and refresh tokens expire and when the web session expires, and then manually rebridge the session to avoid interrupted service. To avoid this complex process, use the OAuth 2.0 hybrid app flows. These flows connect the access and refresh tokens with the web session to give hybrid apps direct web session management.
OAuth 2.0 Hybrid App Flow Cookie Management: When you use the OAuth 2.0 hybrid app token flow, you use scopes to request session IDs (SID) and domain values. You then use these SIDs and domain values to set browser cookies and establish sessions in your hybrid app. When you refresh your access token, you receive new SIDs and domains to reset the browser cookies.
OAuth 2.0 Hybrid App Refresh Token Flow: Use the OAuth 2.0 hybrid app refresh token flow to give hybrid apps direct management of web sessions after an initial session expires. When the authorizing server grants a new access token using the hybrid_refresh grant type, it includes the session IDs (SID) of the requested domains in its response. The hybrid app can set Lightning, Visualforce, and content domain cookies and use frontdoor.jsp to bridge the access token into a web session, providing uninterrupted service. The hybrid app refresh token flow renews access tokens issued by the OAuth 2.0 web server, user-agent, and hybrid app token flow.
OAuth 2.0 Hybrid App Refresh Token Flow: Use the OAuth 2.0 hybrid app refresh token flow to give hybrid apps direct management of web sessions after an initial session expires. When the authorizing server grants a new access token using the hybrid_refresh grant type, it includes the session IDs (SID) of the requested domains in its response. The hybrid app can set Lightning, Visualforce, and content domain cookies and use frontdoor.jsp to bridge the access token into a web session, providing uninterrupted service. The hybrid app refresh token flow renews access tokens issued by the OAuth 2.0 web server, user-agent, and hybrid app token flow.
OAuth 2.0 Hybrid User-Agent Token Flow for Web Session Management: Use the OAuth 2.0 hybrid user-agent token flow to give hybrid apps direct management of web sessions. When the authorizing server grants an access token, it includes session IDs (SID) for the requested domains in its response. After authorization, the hybrid app can set Lightning, Visualforce, and content domain cookies and bridge an access token into a web session, providing uninterrupted service.
OAuth 2.0 Hybrid User-Agent Token Flow for Web Session Management: Use the OAuth 2.0 hybrid user-agent token flow to give hybrid apps direct management of web sessions. When the authorizing server grants an access token, it includes session IDs (SID) for the requested domains in its response. After authorization, the hybrid app can set Lightning, Visualforce, and content domain cookies and bridge an access token into a web session, providing uninterrupted service.
OAuth 2.0 Hybrid Web Server Flow: Use the OAuth 2.0 hybrid web server flow to give hybrid apps direct management of web sessions. When the authorizing server grants an access token, it includes session IDs (SID) for the requested domains in its response. The hybrid app can then set Lightning, Visualforce, and content domain cookies and bridge an access token into a web session, providing uninterrupted service.
OAuth 2.0 Hybrid Web Server Flow: Use the OAuth 2.0 hybrid web server flow to give hybrid apps direct management of web sessions. When the authorizing server grants an access token, it includes session IDs (SID) for the requested domains in its response. The hybrid app can then set Lightning, Visualforce, and content domain cookies and bridge an access token into a web session, providing uninterrupted service.
OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration: Sometimes you want to authorize servers to access data without interactively logging in each time the servers exchange information. For these cases, you can use the OAuth 2.0 JSON Web Token (JWT) bearer flow. This flow uses a certificate to sign the JWT request and doesn’t require explicit user interaction. However, this flow does require prior approval of the client app.
OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration: Sometimes you want to authorize servers to access data without interactively logging in each time the servers exchange information. For these cases, you can use the OAuth 2.0 JSON Web Token (JWT) bearer flow. This flow uses a certificate to sign the JWT request and doesn’t require explicit user interaction. However, this flow does require prior approval of the client app.
OAuth Tokens and Scopes: OAuth tokens authorize access to protected resources. Connected apps receive tokens on behalf of a client after authorization. Scopes further define the type of protected resources that the connected app can access. You assign scopes to a connected app when you build it, and they’re included with the OAuth tokens during the authorization flow.
OAuth 2.0 User-Agent Flow for Desktop or Mobile App Integration: With the OAuth 2.0 user-agent flow, users authorize a desktop or mobile app to access data by using an external or embedded browser. Client apps running in a browser using a scripting language such as JavaScript can also use this flow. This flow uses the OAuth 2.0 implicit grant type.
OAuth 2.0 User-Agent Flow for Desktop or Mobile App Integration: With the OAuth 2.0 user-agent flow, users authorize a desktop or mobile app to access data by using an external or embedded browser. Client apps running in a browser using a scripting language such as JavaScript can also use this flow. This flow uses the OAuth 2.0 implicit grant type.
OAuth 2.0 Username-Password Flow for Special Scenarios: You can use the username-password flow to authorize a client via a connected app that already has the user’s credentials. However, we recommend avoiding this flow because it passes credentials back and forth. Use it only if there’s a high degree of trust between the resource owner and the client, the client is a first-party app, Salesforce is hosting the data, and other grant types aren’t available. In these cases, set user permissions to minimize access and protect stored credentials from unauthorized access.
OAuth 2.0 Username-Password Flow for Special Scenarios: You can use the username-password flow to authorize a client via a connected app that already has the user’s credentials. However, we recommend avoiding this flow because it passes credentials back and forth. Use it only if there’s a high degree of trust between the resource owner and the client, the client is a first-party app, Salesforce is hosting the data, and other grant types aren’t available. In these cases, set user permissions to minimize access and protect stored credentials from unauthorized access.
OAuth 2.0 Web Server Flow for Web App Integration: To integrate an external web app with the Salesforce API, use the OAuth 2.0 web server flow, which implements the OAuth 2.0 authorization code grant type. With this flow, the server hosting the web app must be able to protect the external client app’s identity, defined by the client ID and client secret.
OAuth 2.0 Web Server Flow for Web App Integration: To integrate an external web app with the Salesforce API, use the OAuth 2.0 web server flow, which implements the OAuth 2.0 authorization code grant type. With this flow, the server hosting the web app must be able to protect the connected app’s identity, defined by the client ID and client secret.
SAML Assertion Flow for Accessing the API: The SAML assertion flow is an alternative for orgs that use SAML to access Salesforce and want to access the API the same way. Clients can federate with the API using a SAML assertion, the same way they federate with Salesforce for Web Single Sign-On (Web SSO). You can use this assertion flow without a connected app.
OpenID Connect Dynamic Client Registration for External API Gateways: Although not a typical authorization flow, you can use OpenID Connect dynamic client registration to enable your Salesforce instance as an independent OAuth authorization server to protect resources hosted on an external API gateway.
OpenID Connect Dynamic Client Registration for External API Gateways: Although not a typical authorization flow, you can use OpenID Connect dynamic client registration to enable your Salesforce instance as an independent OAuth authorization server to protect resources hosted on an external API gateway.
Generate an Initial Access Token: OpenID Connect dynamic client registration lets OAuth 2.0 clients—connected apps—directly register connected apps with Salesforce. To authenticate these client registration requests, Salesforce requires an initial access token.
OpenID Connect Token Introspection: As part of the authorization process, token introspection allows all OAuth connected apps to check the current state of an OAuth 2.0 access or refresh token. The resource server or connected apps send the client app’s client ID and secret to the authorization server, initiating an OAuth authorization flow. As part of this flow, the authorization server validates, or introspects, the client app’s access token. If the access token is current and valid, the client app is granted access.
Proof Key for Code Exchange (PKCE) Extension: To improve the security of your OAuth and authentication provider implementations, use the OAuth 2.0 Proof Key for Code Exchange (PKCE) extension. You can require PKCE at an org-wide level, require it for a specific connected app, and automatically enable it for supported authentication providers.
Manage OAuth-Enabled Connected Apps Access to Your Data: All users can manage a OAuth-enabled connected app’s access to their Salesforce data from their personal settings. The apps that have permission to access Salesforce data are listed under advanced user details. Users can get information about each app and revoke the app’s access.
Revoke OAuth Tokens Programmatically: Revoke an OAuth token if you don’t want a client to access Salesforce data or if you don’t trust the client to discontinue access on its own.
Connected App and OAuth Terminology: What’s a token? Consumer? Callback URL? To better understand OAuth-enabled connected apps, familiarize yourself with a few terms.
Set Up the Token Exchange Flow: Some use cases require you to integrate Salesforce with an external identity provider along with multiple apps and microservices. To simplify these integrations, use the OAuth 2.0 token exchange flow. With this flow, exchange tokens from an external identity provider for Salesforce tokens.
Create a Token Exchange Handler Apex Class: A token exchange handler consists of an Apex class that extends the Oauth2TokenExchangeHandler abstract class and a token exchange handler definition. To get started, create an Apex class to reference in the handler definition.
Token Exchange Flow Diagram and Process: The OAuth 2.0 token exchange flow can simplify integrations for use cases with a central identity provider serving multiple apps and microservices. To understand how the flow works, review this step-by-step overview.
Enable Apps for a Token Exchange Handler: To enable a connected app or external client app for a token exchange handler, use the Token Exchange Handlers page in Setup, or edit its metadata definition.
Define a Token Exchange Handler: To finish creating a token exchange handler, define the handler on the Token Exchange Handlers page in Setup, or use Metadata API to define a new OauthTokenExchangeHandler metadata type.
Integrate an App for the Token Exchange Flow: To integrate an app with Salesforce for the OAuth 2.0 token exchange flow, create a Salesforce connected app or an external client app.
OAuth 2.0 Token Exchange Flow: When Salesforce is just one component of an architecture that includes a central identity provider along with multiple apps and microservices, use the OAuth 2.0 token exchange flow to simplify your integration patterns. With this flow, exchange tokens from external identity providers for Salesforce tokens and grant access to Salesforce data.
Token Exchange Flow Use Cases: To decide if the OAuth 2.0 token exchange flow is the right solution for your company, learn more about when to use it.
Identity URLs: The identity URL is the gateway to the Salesforce Identity Service that can be accessed using the OAuth 2.0 user-agent or web server flows. In these flows, when a connected app with the id scope is successfully authorized, it receives an identity URL along with the access token. The connected app can then send a GET request with the access token to the identity URL. In response, Salesforce returns details about the queried user and org.
Query for the OpenID Connect Configuration: Use the OpenID Connect discovery endpoint to query for information about the Salesforce OpenID Connect configuration. Salesforce returns basic information about endpoints, supported scopes, and other values used for OpenID Connect authorization.
Query for User Information: A connected app can query the UserInfo endpoint for information about the user associated with the connected app’s access token. Salesforce returns basic personal information about the user and important endpoints that the connected app can talk to, such as photos and accessible API endpoints. This UserInfo endpoint provides access to information only for the current user. It doesn’t give access to other users in the org.
Remove an Email Address: If you no longer use an email address, you can remove it from the list on the Welcome Back page.
Remove Trust Notifications: When you don't want to receive notifications about events and instances for an existing subscription from Trust Status, remove your Trust notifications.
Reorder App Launcher Apps in Lightning Experience: As a Salesforce admin, you can change the order in which apps appear in the Lightning Experience App Launcher. Users can then reorder their personal view of the App Launcher to their liking.
Reorder the App Menu and App Launcher in Salesforce Classic: You can change the order in which apps appear in the app menu and App Launcher. The app menu is a dropdown in the upper-right corner of every page in Salesforce Classic. If enabled, the App Launcher is listed in the dropdown menu.
Set the Default Sort Order for Apps: As a Salesforce admin, you control the initial sort order of the Salesforce standard, custom, and connected apps that your users see in your org. You can also hide apps so that they don’t show in the App Launcher.
Report Insights: Use on-demand insights to identify slow reports and improve their performance.
Create a Custom Report Type in the Legacy Custom Report Type Builder: Build a custom report type on any object, even objects that you don’t have permission to view. A custom report type provides more flexibility with object relationships and can include fields from objects with lookup relationships to expand the data available for report users.
Reporting With Divisions: If your organization uses divisions to segment data, you can customize your reports to show records within specific divisions.
Create a Custom Report Type in the Enhanced Custom Report Type Builder: A custom report type provides more flexibility with object relationships. It can include fields from objects with lookup relationships to expand the data available for report users. You can build a custom report type in the Enhanced Custom Report Type Builder on any object, even objects that you don’t have permission to view.
Edit or Delete a Custom Report Type: You can update or delete a custom report type. When you delete a custom report type, you can’t restore it.
Limits on Report Types: Custom report types are subject to some limits for high performance and usability.
Custom Report Types: A report type defines the set of records and fields available to a report based on the relationships between a primary object and its related objects. Salesforce provides standard report types for objects. You can also create custom report types to include additional objects and fields that your users need to see in a report.
Sort Report Results: Sort a report by the data in a particular column by clicking that column’s heading. Clicking a column header sorts data according to that column’s ascending order: text is sorted from A to Z, numerical data is sorted from lowest to highest, and time/date data is sorted from earliest to latest.
Let Users Attach Files to Report Subscriptions: Let users who subscribe to reports choose to receive report results as a formatted spreadsheet (.XLSX) or a comma-separated (.CSV) file attached to the subscription email. The email itself includes the report name in the subject line, but there is no email body. Row-level record details are included in the attached file instead.
Reset Your Password With Your Email Address: If you forgot your password and your username, you can reset the password with the new Use Your Email Address button on the Reset Your Password page. You need your MFA method to verify your identity. In some cases, you're asked to answer your security question instead of using MFA.
Reset Qualifying Points: The Reset Qualifying Points Data Processing Engine definition calculates and resets the qualifying points balance to zero for members based on the tier model.
Reset Passwords for Your Users: As an admin, you can reset a user’s password for better protection or if they’re locked out.
Restrict Data Processing for Loyalty Management: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restriction of Processing: Restrict How to Process Personal Data: Prevent the processing of your customers’ data when situations require you to do so. We give guidance on how to restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restriction of Processing for Analytics: Prevent the processing of your customers’ data when situations require you to do so. We give guidance on how to restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for B2C Commerce: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Experience Cloud Sites: Some situations require you to prevent the processing of your customers’ data. We give you actions to consider so that you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Financial Services Cloud: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Health Cloud: When situations require you to do so, you can prevent the processing of your patients’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Heroku: Some situations require you to prevent the processing of your customers’ data. We give you actions to consider so that you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Marketing Cloud Engagement: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing in Account Engagement: Various laws and regulations require you and your company to sometimes restrict the processing of your customers’ data, such as the EU General Data Protection Regulation and the U.S. Federal Rules of Civil Procedure. To comply with data protection and privacy regulations, you can prevent the processing of your customers’ data. Review this guidance to help you restrict forms of data processing. You can then address the compliance regulations that apply to your company.
Restrict Data Processing for the Salesforce Platform: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Quip: Some situations require you to prevent the processing of your customers’ data. We give you actions to consider so that you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Sales Cloud: When situations require you to do so, prevent the processing of your customers’ data. We give guidance to help you restrict forms of data processing. That way, you can work toward complying with the laws that are important to your company.
Restrict Data Processing for Service Cloud: When needed, prevent the processing of your customers’ and employees’ data in your customer service center. We give guidance to help you restrict forms of data processing to help comply with the laws that are important to your company.
Retaining Customer Data: Heroku Connect syncs your data to your Heroku data store, which can affect storage usage and run time.
Retain Records on an Object: Choose whether you want to copy records to an external data store for retention.
Reset Your Forgotten Password: If you forgot your password, you can easily reset it using the forgot password link on the login page. You need your username and access to your email address. You also need your MFA method to verify your identity. In some cases, you're asked to answer your security question instead of using MFA.
Review and Approve Deal Registrations: As a channel manager, review submitted deal registrations from Leads, check duplicates, and approve or reject each deal with Orchestration Work Guide.
Review and Approve Registered Designs: Use the new Design Registrations Awaiting Approval report to review and approve the design registrations done on partner sites.
Delete Data with Right to Be Forgotten Policies: For data subjects who want their data removed, create Right to Be Forgotten policies to run on individual customer records. Create policies that capture the objects you want to delete, then manually run the policy on a specific record at any time.
Create a Right to Be Forgotten Policy: For data subjects who want their data to be erased, create Right to Be Forgotten policies to run on individual customer records. Create policies that capture the objects that you want to be deleted, then manually run the policy on a specific record at any time. Right to Be Forgotten policies are created at the object level to ensure all customer data is removed.
Run Loyalty Program Processes by Using a Flow Action: Loyalty program processes can be created for various transactional, nontransactional, and tier-processing tasks in loyalty management. Processes are run based on defined parameters and rules. After you activate a process and the process's rules, you can find the processes in the Flow Builder actions in the Loyalty category.
Run Your Retention Policy: Put your policy into practice by executing it. You can only run activated policies, and retention policy executions aren’t reversible.
Mobile Publisher for Salesforce App: Use Mobile Publisher to create a customized and branded version of the Salesforce mobile app. When your users can identify the app with your brand, they’re more likely to use it, which increases adoption.
Request a Binary of Your App: Google and Apple provide programs that give your organization the ability to thoroughly test your Android and iOS apps before publishing them.
Build Your Branded App: Create a Mobile Publisher project, enter details about your app, and upload your custom branded assets to Salesforce.
Create a Binary Handoff Project for the Salesforce Mobile App: Use the binary handoff distribution method to have Salesforce build your app and provide you with the binary file (.ipa or .aab) for manual signing and distribution. This method is ideal for organizations with security protocols that require in-house code signing or specific internal distribution processes. Use the binary handoff distribution when you’re certain you don’t want to change the distribution method, because you can't change it to fully managed or binary upload.
App Distribution: Choose how you want to get your app into the hands of your users.
App Distribution Methods: Choose whether you want Salesforce to manage the release of your branded app, or if you want to manage the release of the app on your own.
Enter Information and Upload Assets for Your App: Customize your app’s appearance, including app icon, loading page logo, and header background color, and much more so that the app matches your company’s branding.
Get Started: Learn everything about the Mobile Publisher program, such as how it works, what information to gather to distribute your app to users, and the assets required to create your branded app.
How It Works: Let’s look at the overall process so you know what to expect when creating your branded app with Mobile Publisher.
Create a New Version of Your Mobile Publisher for Experience Cloud App: When you want to edit the visual appearance of an app that’s already been published, you have to create a version of the app. For example, you can create a version of your app if you want to change the visual appearance with a new app icon and branding assets.
Types of Maintenance: There are two types of maintenance: updates that Salesforce initiates and updates that your organization initiates.
Playground App Virtual Device Builds: The Playground App Virtual Device Builds enable you to review and debug your Experience site on your local desktop machine. You can use Playground App Virtual Device Builds to test your Experience site’s iOS and Android app implementations.
Debug on Android Using Chrome DevTools: To debug your components running on Android, use Chrome DevTools. Then, to debug a mobile component, connect your desktop instance of Google Chrome to the Playground App running on your virtual device.
Debug on iOS Using Safari Developer Tools: To debug your components running on iOS, use Safari Web Inspector. Then, to debug a mobile component, connect your desktop instance of Safari to the Salesforce mobile app running on your virtual device.
Prepare Your App’s Information: Preparing your branded assets is the most important part of this process. Let’s discuss some of the branding details so you can get started with your Mobile Publisher project.
Submit the App for Approval: After testing of the beta version of your app is complete, the next step is to submit the app to the application stores for approval.
Test and Submit the App: Request a binary and submit for your branded app to the application stores for approval.
Create a New Version of Your Salesforce App: When you want to edit the visual appearance of an app that’s already been published, you have to create a version of the app. For example, you can create a version of your app if you want to change the visual appearance with a new app icon and branding assets.
What Is Quip in Salesforce?: There are two Quip feature sets in Salesforce: Quip Advanced (previously Salesforce Anywhere Advanced) and Quip for Customer 360.
Salesforce Mobile App: The Salesforce mobile app is Salesforce on the go! This enterprise mobile experience gives you access to the same information you see in the office, but organized for getting work done between customer meetings, while waiting for a flight, even when you’re in line for coffee. The mobile app includes many of your org’s customizations, so it’s tailored to your business needs. Salesforce for iOS is available from the App Store, and Salesforce for Android is available from Google Play. The Salesforce mobile app is included with all Salesforce orgs.
Salesforce Mobile App Accessibility Considerations: The Salesforce mobile app provides users working with screen readers and other accessibility features a fully accessible mobile experience. If you use the Salesforce mobile app with an assistive device, keep these tips in mind.
Message Customers in the Salesforce Mobile App: The messaging experience in the Salesforce mobile app is similar to the messaging experience on the desktop site. You can message from a smartphone or tablet. Review the relevant messaging documentation for agents to learn more.
Customize Agentforce Mobile Responses (Beta): Deliver a tailored Agentforce experience on mobile devices with full administrative control over how AI-powered responses appear to your users.
Use Mobile Builder for Agentforce (Beta): The Mobile Builder for Agentforce is a drag-and-drop tool that lets you customize how Agentforce action responses appear on mobile devices.
Enable Agentforce Voice for Employee Agents: Turn on Agentforce Voice for an employee agent so your users can have voice conversations with it in the Salesforce app — handy for hands-free moments like Pre-Visit Prep and Post-Visit Updates, including while driving.
Salesforce Mobile App and Biometric ID: Biometric ID is a secure and convenient way to access the Salesforce mobile app. On capable devices, you can unlock the app with touch or face authentication, instead of a PIN.
Custom Lightning Types in the Salesforce Mobile App: Show rich, interactive UI in Agentforce conversations on the Salesforce mobile app by using custom Lightning types (CLTs) with Lightning web component (LWC) overrides.
Access Collections on the Salesforce Mobile App: Collections enable you to curate your analytics in a customized way, and have a personalized set of CRM Analytics items, and reports and dashboards when you first open the application. Analytics can be added from different apps and folders, and they can exist in multiple collections. With collections, you’re able to quickly access data that’s relevant to your work or interests in one place.
Considerations for the Salesforce Mobile App: Before you set up and use the Salesforce mobile app, learn about security, limitations, accessibility, and more to ensure a smooth mobile experience for your users.
Customize the Salesforce Mobile App: The Salesforce mobile app is fully customizable to the needs of your users. Customize branding, navigation, and more to get the most of out of running Salesforce on mobile devices.
Customize Salesforce Mobile App Branding: Change the Salesforce mobile app’s appearance, including the loading page background color, loading page logo, and header background color, so the app matches your company’s branding.
Lightning Apps by Default: Starting in Winter ‘22, the Salesforce mobile app defaults to a phone-activated Lightning app if it’s available to the user. Previously, all users had Mobile Only app navigation, but they could switch to a different Lightning app by using the App Launcher from the Menu tab. The Salesforce mobile app now selects the first available Lightning app by default—instead of Mobile Only—resulting in a change in the navigation bar at the bottom of the page. Users who don't have access to any phone-activated Lightnings apps default to Mobile Only.
Customize the Mobile Only Navigation Menu in the Salesforce Mobile App: Select the Lightning pages, Visualforce pages, Lightning components, and other productivity items you want to appear in the navigation menu and navigation bar of the Salesforce mobile app using the Mobile Only app.
Data Available in the Salesforce Mobile App: The Salesforce mobile app uses your organization’s Salesforce edition, your user license type, and your assigned user profile and permission sets to determine the data that’s available to you. You see most of the objects, record types, fields, and page layouts that you do when working in the full Salesforce site. But not all Salesforce data is available in the app.
Simplify Daily Tasks with AI in the Salesforce Mobile App: Einstein Generative AI features including Agentforce and Prompt Builder allow your users to streamline daily tasks and be ever more productive. Ask Agentforce to summarize records, draft emails, show related records, and execute all your custom agentic actions in a conversational and intuitive experience on the Salesforce mobile app.
Enable Offline Access and Offline Edit for the Salesforce Mobile App: With just a few clicks, you can protect your Salesforce mobile app users against the vagaries of mobile connectivity. You can enable two levels of offline access: caching frequently accessed records, so users can view data while offline, and Offline Edit, so users can create, edit, and delete records while offline. Offline access is available in Salesforce for Android and iOS only.
The Enhanced Contacts Experience (Beta): Enhanced Contacts (beta) is an upgraded experience for interacting with contact lists and records, optimized for phone and tablet use and included with existing licenses.
Help Your Users Succeed with the Salesforce Mobile App: As Salesforce admins, we know that you are the first line of help to your end users when they have questions about using all things Salesforce. Here are some resources to help your end users get the most out of the Salesforce mobile app and address some common situations that differ from the Salesforce full site experience.
Salesforce Mobile App Language Considerations: The Salesforce mobile app gets language support from the language and region settings on the mobile device, the language setting for the mobile device’s default browser, and the language and region settings in the user’s Salesforce user profile. If these settings differ, users can see different languages in the app.
Create a Custom Launchpad for the Salesforce Mobile App: Launchpads let users quickly access the information they need. Use the Launchpad Lightning web component to add links to Lightning pages on mobile and desktop. If you don’t need a launchpad for desktop users, you can create a mobile-specific launchpad. Set the component visibility to show the launchpad to mobile users only. That way, mobile users can still access all of their navigation menu items, but the most important links are only a tap away.
Message Customers in the Salesforce Mobile App: Modernize your communication by letting agents message customers from the Salesforce mobile app. Agents who use enhanced messaging channels or Enhanced Chat can chat with customers on the go.
Enable Mobile Home for iOS and Android: Mobile Home is a set of configurable, dynamic cards that show personalized information for your users. When users open the Mobile Home page, they can see their reports, recent records, favorites, and more. Each card shows information that’s based on what users view in Salesforce. Your users can also easily rearrange, add, and remove cards to customize Mobile Home.
Work with an App Configuration: After you create an app configuration, you can easily change its style, function, or assignment.
Customize Mobile Home Page: The Mobile Builder for Customizable Home Page is a point-and-click tool that lets you customize the layout of the home page in the Salesforce mobile app.
Customizable Mobile Home Page (Beta): Customizable mobile home page gives your users a fresh, personalized home page experience in the Salesforce Mobile App. Give your users the information they need as soon as they open the app. See the most important information at a glance with cards for Pinned Reports, Recent Records and Lists, Favorites, My Calendar, Salesforce Events, and Tasks. You control how it all looks and works by designing it in the mobile builder on desktop. You can also decide if you want your users to be able to customize their own mobile experiences.
Use Agentforce With Customizable Mobile Home Page: You never have to fly solo, since Agentforce is always right there to help. Tap on the Ask Agentforce button and through voice or text input, ask Agentforce to find and summarize records for you, and even to generate emails.
Accelerate Meeting Follow-Ups with AI Suggested Actions: After a meeting transcript is available, the Salesforce mobile app presents a meeting summary, key decisions, and contextual next steps directly on the event record. You can review follow-up recommendations such as sending requested materials, updating an opportunity, or scheduling another meeting.
Disable Full Content Push Notifications: The content of mobile push notifications can be displayed outside of the Salesforce mobile app, such as on a mobile device’s lock screen. Full content push notifications are enabled by default for the Salesforce mobile app, but you can choose to display minimal content instead.
Work Offline with the Salesforce Mobile App: Your mobile users' productivity doesn't have to stop when there's no connectivity. When you enable caching and Offline Edit, users can keep working, unimpeded by a subway commute, FAA regulations, capricious cellular signals, or bunker-style buildings. Offline access is available for Salesforce for Android and iOS.
Salesforce Mobile App and Password Manager Apps: Good security practices require long, complex passwords. But typing long, complex passwords on small mobile keyboards is error prone and frustrating. If your org uses password management, your Salesforce for iOS users can use a password manager app to simplify the login process down to a few taps.
Salesforce Mobile App Plus: Salesforce Mobile App Plus combines everything you know and use with the Salesforce Mobile App and enhances the experience with Mobile Offline, Enhanced Mobile Security, and Branding and App Management.
Branding and App Management: Build, brand, and distribute your mobile app into app stores using the Mobile Publisher engine and automatically update them with the latest releases.
Advantages of Binary Upload Distribution Method: If your org is familiar with how the app stores work, the Binary Upload Distribution Method has many advantages for managing the release of your app on your end.
App Distribution Types: Choose the right distribution type based on your use case and Apple and Google guidelines. As an app developer, Salesforce complies with Apple and Google distribution guidelines, and violating the guidelines can cause Apple or Google to reject your branded app.
App Distribution Methods: Choose whether you want Salesforce to manage the release of your branded app, or if you want to manage the release of the app on your own.
App Distribution: Deciding on how you want to manage the release and distribution of your app is an important step. App Distribution Methods and App Distribution Types to help your org manage the release and distribution of your app, your way.
How the Process Works: Let’s look at the overall process so you know what to expect when creating and distributing your branded Salesforce Mobile app using the Mobile Publisher engine.
Build and Distribute Your Branded App: After reviewing the app branding process and deciding how to distribute the app to your users, you’re ready to use the Mobile Publisher engine to start your branded app project.
Install the Salesforce Connected Apps (Optional): This step is required if your org is new and there are no connected apps installed yet. Alternatively, you can log into your org using the Salesforce mobile app to trigger an installation of the required connected apps.
Enhanced Mobile App Security: Enhanced Mobile App Security is a paid mobile application management (MAM) add-on designed to meet high security and compliance needs for the Salesforce mobile app.
Enable Enhanced Mobile App Security: Before you can configure mobile app security policies, there are a couple steps to get Enhanced Mobile App Security enabled.
What Your Users See: Users with the Enforce Enhanced Mobile App Security user permission see a dedicated user interface in the Salesforce mobile app.
Mobile Offline: With Mobile Offline, users can do their jobs with the Salesforce Mobile app from anywhere, even when there's poor or even no network connectivity. Offline mode lets users create, edit, and delete records while their mobile devices are disconnected from the internet. When their mobile devices return online, the Salesforce Mobile app automatically syncs those changes to Salesforce and notifies users if there are conflicts that must be resolved.
Offline Behaviors: Learn what data is primed for offline use, what data can’t be primed, and how draft, how to create drafts, and how drafts are synced once online.
Briefcase Building: Briefcase Builder is how you choose which records are available offline for your users. It's important to think about your users and which records they need access to while offline.
Start Coding: With your briefcases and development environment set up and verified, you’re ready for real code.
Set Up Your Development Environment: Once your org is enabled and you’ve successfully configured the necessary briefcases for your org and users, you can set up your development environment and test that everything is working.
Mobile Offline App FAQs: Learn where in the Salesforce Mobile App you can use LWCs, how to use Briefcase Builder to ensure records are available offline, and get to coding.
Get Started With Mobile Offline: Learn where in the Salesforce Mobile App you can use LWCs, how to use Briefcase Builder to ensure records are available offline, and get to coding.
Customization of the Landing Page: The Landing Page is the Mobile Offline home page for the Salesforce Mobile App. When a user logs into the Salesforce Mobile App offline experience, the landing page is the first thing they see. This page is intended to give access to the users most important records and allow them to quickly and easily take relevant actions.
Customize with Code: The landing page can be configured as a static resource file in JSON format. Edit the provided default JSON file and then upload it as a static resource to Salesforce.
Where To Use Lightning Web Components: Learn where in the Salesforce Mobile App you can use standard and custom objects and Lightning global quick actions.
Data That Is Primed: Each user’s Briefcase-driven record data, and the LWCs associated with quick actions for these records, are primed, or preloaded, in preparation for going offline.
Capture Post-Meeting Insights with Voice Notes: Capture critical context on the go. Use Post-Meeting Voice Notes to record your thoughts immediately after any meeting that wasn't transcribed.
Open Enhanced Reports on Mobile: Open existing Lightning reports at anytime and make timely decisions without gaps or limitations.
View Enhanced Reports Formats on Mobile: Reports for your mobile device are presented in several formats that help you view and understand data effectively.
Requirements for the Salesforce Mobile App: The Salesforce mobile app is available for most Salesforce editions and user license types. The app supports various mobile platforms, both phone and tablets, with some minimum operating system requirements.
Salesforce Mobile App Rollout Strategy: To learn more about best practices and to get the most out of the Salesforce mobile app, check out our resources on Trailhead.
Control Access and Security for the Salesforce Mobile App: By default, all users in your organization can log in to Salesforce for Android and iOS. However, you can control access to all versions of the Salesforce mobile app and configure security policies through a mix of settings and connected app attributes.
Set Up the Salesforce Mobile App: Learn more about device requirements and access to get the most out of the Salesforce mobile app.
Managing Your Day with Today in Salesforce for iOS and Android: Today in Salesforce for iOS and Salesforce for Android shows key information for reps on the go. Admins can add the Today item to the navigation menu of Lightning apps and the Mobile Only app.
Set Up In-Person Meeting Assistant: Transform face-to-face client interactions into actionable CRM data. With private and secure processing, you can capture AI-powered transcripts. Your data syncs automatically to Einstein Conversation Insights (ECI), eliminating manual entry and keeping you focused on the client.
Submit Feedback for Continuous Improvement: Submit feedback to share valuable context or flag concerns on cross metric insight summaries. By contributing feedback, you support continuous improvement and collaboration.
View Metric Details in Tableau Next Mobile: Metric details give you key context and a deeper understanding of your metric’s status, breaking down the data with clear visuals, trends over time, and applied filters.
Enable Metric Notifications: Get notified about important system events or when analytics are shared. These alerts boost engagement and simplify teamwork.
Stay Informed With Tableau Next Mobile Overview: Tableau Next Mobile empowers users to engage with their data insights anytime, anywhere, fostering a culture of data-driven decision-making beyond the confines of the traditional office. Furthermore, Tableau Next Mobile enhances collaboration by allowing users to easily share insights with colleagues, which promotes a more connected and informed workforce, leading to more effective problem-solving and improved business outcomes.
Set Up Tableau Next Mobile: Grant access to Tableau Next in the Salesforce Mobile App, ensuring that your users can begin using it to monitor their most important metrics right away.
Share a Metric in Tableau Next Mobile: Share metrics to promote alignment across teams, enabling a common understanding of metric performance and using data to make smarter decisions together.
Consolidate Your Data with Unified Analytics: Unified Analytics is your home base for all your analytics on your iOS and Android devices. Go to the section for your operating system to get more details about Unified Analytics, such as navigation and finding items.
Navigate Unified Analytics on Android: Unified Analytics is a modern and welcoming environment on Android to organize, locate, and share your analytics.
Open Links with One Tap: When Salesforce mobile app users tap Lightning URL and Chatter notification links on their phones, they’re taken directly to the mobile app. Learn more about which URL types are supported.
What's Available Offline in the Salesforce Mobile App: With Salesforce mobile app caching and Offline Edit, Salesforce for Android and iOS users can work with many of their frequently accessed objects and records while offline. Here’s the list of data and Salesforce mobile app user interface elements that are available offline.
Create, Edit, and Delete Records in the Salesforce Mobile App While Online or Offline: Whether online or offline, Salesforce mobile app users can create, edit, and delete records and monitor changes from the Pending Changes page. The Salesforce mobile app automatically syncs those pending changes to Salesforce and warns the user if there are conflicts to be resolved.
Use Salesforce Authenticator for Multi-Factor Authentication: We all want to keep our online accounts and data secure. Salesforce wants that too, which is why multi-factor authentication (MFA) is required for all logins to the user interface. MFA adds an extra layer of security by requiring you to enter two or more pieces of evidence (or factors) about your identity when you log in. The first factor is something you know, like your username and password combination. The second is a verification method that you have in your possession, like the Salesforce Authenticator mobile app. With MFA, even if hackers steal your password, they can’t log in because they don't have your mobile device with Salesforce Authenticator installed on it.
Salesforce Authenticator Accessibility Considerations: Salesforce Authenticator is designed with accessibility in mind and delivers a fully accessible mobile experience for everyone, including users working with screen readers. Unlike the full Salesforce site, Salesforce Authenticator doesn’t require accessibility mode to give users working with assistive devices a fully accessible experience.
Register Salesforce Authenticator as an Identity Verification Method for Salesforce Orgs: Connect your Salesforce account to the Salesforce Authenticator app so that you can easily log in with multi-factor authentication (MFA). Then, every time you log in to Salesforce, the app sends a notification to your mobile device to verify it’s you. The process for connecting your account depends on whether you’re logged in to Salesforce when MFA is enabled.
Automate Multi-Factor Authentication with Salesforce Authenticator: Authenticator can automatically approve multi-factor authentication (MFA) requests. Automation relies on several conditions, including your device and browser information, your location, and the service that you’re logging into. When all factors of an incoming request match a request that was approved three times, Authenticator automatically verifies the activity and approves it.
Back Up Your Connected Accounts in the Salesforce Authenticator Mobile App: We recommend backing up your connected accounts in the Salesforce Authenticator mobile app. That way, if you change your device, your device gets lost or damaged, or you delete and reinstall the app, you can easily transfer your accounts.
Locale and Language Support for Salesforce Authenticator: Salesforce Authenticator works with almost all Salesforce-supported locales and the fully supported end-user languages. Salesforce Help includes a list of supported locales and languages. Languages that are read right to left, including Arabic and Hebrew, aren’t currently supported.
Location Data and Privacy in Salesforce Authenticator: When you allow Salesforce Authenticator to use your mobile device’s location services, the app automatically approves account activity that you trust. Location data is critical to maintaining security while providing the convenience of automated verifications. Learn how Authenticator uses your location data without compromising your privacy.
Use Salesforce Authenticator TOTP Codes If You’re Offline or Push Notifications Are Unavailable: If your mobile device doesn’t have a data connection or if push notifications from Salesforce Authenticator aren’t working, you can still log in with multi factor authentication (MFA). Simply enter a time-based one-time password (TOTP) code from the app to verify your identity. Salesforce Authenticator automatically generates TOTP codes for each of your connected accounts, even when push notifications are unavailable.
Salesforce Authenticator: Welcome to the Salesforce Authenticator mobile app. Salesforce Authenticator is the fastest and easiest way to complete multi-factor authentication (MFA) and other types of identity verification. Verify your identity with the tap of a finger while using any Salesforce product that requires MFA. You can also use the app with other online accounts that support time-based one-time password (TOTP) authenticator apps.
Manage Push Notifications for Salesforce Authenticator: To improve your verification experience, we recommend that you enable push notifications. Push notifications are a fast and easy way to approve verification requests. Check whether you allow push notifications for Salesforce Authenticator, and enable them with a one-tap link to your device settings.
Remove an Account from Salesforce Authenticator: When you no longer want to use the app for multi-factor authentication (MFA) logins, or want to switch to a new device, remove your Salesforce account from the Salesforce Authenticator mobile app.
Requirements for Salesforce Authenticator: The Salesforce Authenticator mobile app is supported on various mobile platforms, with some device, operating system, and mobile browser requirements. You need an Internet connection to communicate with Salesforce for user verifications of account activity and location-based automated verifications. The app generates verification codes as time-based one-time passwords, or TOTPs without an Internet connection on your mobile device, so you can still log in to your other accounts when you're offline.
Restore Connected Accounts in the Salesforce Authenticator Mobile App: If you back up your Connected Accounts in the Salesforce Authenticator mobile app, you can restore them on another mobile device. You can also restore your accounts on the same device if you delete and reinstall the app.
Use Salesforce Authenticator with Your Other Accounts: You can use the Salesforce Authenticator mobile app to log in to your other online accounts. For example, use Salesforce Authenticator to add an extra layer of security when you log in to your Facebook account. When you use the app with your other accounts, you verify your identity by entering 6-digit time-based one-time passwords (TOTPs). You can use Salesforce Authenticator with any service that supports multi-factor authentication (MFA) with TOTPs.
Verify Your Identity with Salesforce Authenticator: After you install the Salesforce Authenticator app on your mobile device and connect your Salesforce account, use the app to securely log in to your account or access restricted resources in Salesforce. Also, you can block activity that you don’t recognize and report it to your admin.
Salesforce Glossary: This glossary defines terms that appear in the Get Started section of the Salesforce documentation.
Partner Relationship Management Analytics: Every release, an automated process delivers the latest collection of predesigned Partner Relationship Management (PRM) reports and dashboards to your org. Channel managers can use PRM reports and dashboards to see key metrics on partner performance and activity. Channel managers can also build their own reports and dashboards using custom report types for PRM objects. To give access, Salesforce admins must first share PRM reports and dashboards folders with channel managers. If any analytics features are missing, Salesforce admins can generate the most recently released versions manually.
Partner Relationship Management Reports and Dashboards: See a list of the reports, dashboards, and custom report types that are included with Partner Relationship Management (PRM). Every release, an automated process delivers the latest PRM report and dashboard improvements to your org. Report and dashboard folder names correspond to the Salesforce release when they were delivered.
Managing Channels: Partner Relationship Management (PRM) gives channel managers the tools to lead inbound sales for your company. Stay on top of partner performance and activity using PRM analytics. Get a complete view of partner sales activity from the Channel Management Console.
Monitoring Channel Business from the Channel Management Console: Channel managers can see a complete view of partners’ sales activity from the Channel Management Console. Follow the performance metrics you care about most from the console dashboard. Review and approve partners’ leads and easily access frequently-used objects.
Channel Management Console: Monitor your channel business like a pro from the Channel Management Console.
Enabling and Guiding Your Partners: Equip partners with the resources and content that drives growth for your business, all from within your branded partner experience. Partner Enablement and In-App Guidance are available in supported Experience Cloud sites. Deliver Enablement programs, prompts, and walkthroughs to partners in the flow of their daily work, and then track progress towards goals with enablement-focused analytics.
Staying Productive as a Partner: Boost partner productivity with intelligent sales recommendations, enhanced list views for contacts, events, and opportunities, and the power of AI.
Partner Cloud Roles and Responsibilities: To build a successful partner strategy, you must collaborate with various players both inside and outside of your company. Learn about the relevant players and their responsibilities so you know who can support as you design your ideal partner experience using Partner Cloud.
Setting Up and Maintaining Analytics for Partner Relationship Management: When you set up Partner Relationship Management (PRM), share predesigned reports and dashboards with channel managers. And if you have issues with the latest versions delivered to you by Salesforce, you can get new versions manually.
Set Up Contact Intelligence View and Lead Intelligence View for Partners: Salesforce admins and Experience Cloud site developers must work together to set up Contact Intelligence View and Lead Intelligence View in supported Experience Cloud sites. First, Salesforce admins must turn on the two sales features in Salesforce and assign permissions to partners. Then Experience Cloud site developers must verify that the Enhanced List View component is added to the Experience Cloud site and published for partners. For vendors who purchase add-on licenses or are comfortable granting partners with more object permissions, more features can also be configured.
Enable the Channel Management Console and Assign Permissions: To give channel managers access to the Channel Management Console, Salesforce admins must enable the console, assign permissions, and share default components with channel managers, such as the Channel Management Overview Dashboard. Salesforce admins can customize the console some aspects of the console directly from PRM Setup, such as adding custom objects, adding the Leads to Review component, and setting Channel Management as the default app for channel managers. Salesforce admins can customize the console further from the App Builder by altering the Leads to Review component or creating other useful components and adding them to the console.
Customizing the Leads to Review Component: Leads to Review lets channel managers review deals that partners register from their Experience Cloud sites. Learn about the default functionality for Leads to Review and review some considerations for Salesforce admins who want to customize it.
Setting Up the Channel Management Console: The Channel Management Console lets channel managers monitor partner activities and performance from a standard Lightning console app. Salesforce admins must give channel managers access to the console and its features. If they want, Salesforce admins can customize the console.
Experience Cloud Template Configuration Requirements for Partner Relationship Management Features: Some Experience Cloud templates come with configured Partner Relationship Management (PRM) features. The steps for adding each feature to your site depend on which features you’re enabling, which Experience Cloud template you’re using, and the Salesforce release in which you create your site.
Setting Up Einstein Scoring for Partners: Give your sales partners access to scores that help them prioritize leads and opportunities by setting up Einstein Lead Scoring and Einstein Opportunity Scoring in Experience Cloud sites.
Setting Up More Enhanced List View Features for Partners: Salesforce admins can enable more Contact Intelligence, Lead Intelligence, and Pipeline Inspection features for partners by assigning add-on licenses and giving partners access to more objects. Learn which features are supported and how to complete the setup for each.
Setting Up Enhanced List Views for Partners: Learn how to set up Contact Intelligence View, Lead Intelligence View, and Pipeline Inspection for partners in their Experience Cloud sites.
Set Up Einstein Sales Emails for Partners: Give partners access to send personalized sales emails fast from your Experience Cloud Aura sites by using Einstein Sales Emails. From the email composer on contacts and leads, partners can rely on generative AI to help them craft impactful emails quickly. To begin drafting, partners choose from a collection of standard email prompt types for common sales scenarios, such as introductions, nudges, and meeting invitations. Or you can develop custom sales emails prompt templates by using Prompt Builder. To set up Einstein Sales Emails for partners, turn on the necessary features and assign the required permissions to partner users.
Get the Latest Partner Relationship Management Reports and Dashboards: If reports, dashboard widgets, or any analytics metrics are missing from your predesigned Partner Relationship Management (PRM) reports and dashboards, Salesforce admins can generate the most recently released versions manually.
Setting Up Partner Cloud Sales Features for Partners: Enable sales features in your partner sites, such as Einstein Sales Emails, Einstein Lead Scoring, Einstein Opportunity Scoring, Contact Intelligence View, Lead Intelligence View, and Pipeline Inspection for partners.
Set Up Pipeline Inspection for Partners: Salesforce admins and Experience Cloud site developers must work together to set up Pipeline Inspection for partners in their Experience Cloud sites. First, Salesforce admins must turn on Pipeline Inspection and assign permissions to partners. Then Experience Cloud site developers must verify that the Enhanced List View component is added to the Experience Cloud site and published for partners. For vendors who purchase add-on licenses or are comfortable granting partners with more object permissions, more Pipeline Inspection features can also be configured.
Salesforce Trust Sites: Salesforce My Trust Center and Trust Status are both Salesforce websites that provide crucial updates about the availability and performance of your products and services.
Reassign a User License with SalesforceA: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. When you create a new user with SalesforceA, there may be instances when your org doesn't have enough user licenses to assign to the newly created user. No need to worry if this happens, because SalesforceA saves the newly created user as inactive. To change the newly created user from inactive to active, you can reassign a user license from an existing user to the newly created user. Reassigning a user license is available in SalesforceA for iOS version 3.3 or later.
Create a New User with SalesforceA: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. Use SalesforceA on your mobile device to create a new user. Creating a new user is available in SalesforceA for iOS version 3.3 or later.
Log In to SalesforceA: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. Log in to the SalesforceA mobile app to perform essential administrative tasks for your Salesforce organization.
Log In to Multiple Organizations with SalesforceA: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. Use SalesforceA on your mobile device to log in to multiple Salesforce organizations that you administer. Once logged in, you can switch between organizations without going through the login process again.
SalesforceA Options: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. Manage users and view information for Salesforce organizations from your mobile device.
SalesforceA: SalesforceA is scheduled for retirement in all Salesforce orgs as of June 2022. SalesforceA is a mobile app for Salesforce administrators. When you’re away from your desk, you can use your phone or tablet to perform essential administration tasks like resetting passwords, freezing users, and viewing current system status.
Customize with the Mobile Builder: The landing page can be customized without writing a line of code or editing a single file using the Mobile Builder for Salesforce Mobile App.
Work with Configurations: After you create a custom configuration, you can easily change its style, function, or assignment.
Create a Configuration: Use the Mobile Builder for Salesforce Mobile App to configure and customize the offline landing page.
Customize Configurations: To create workflows that are optimized for your users, choose cards, their actions, and their placement, and add other customizations.
Troubleshoot the Mobile Builder: Check here for suggestions if your users aren’t seeing the custom landing page that was created with the Mobile Builder for Salesforce Mobile App.
Configure Deep Linking for the Salesforce Mobile App: Use supported URL schemes for the Salesforce mobile application for Android and iOS to launch Salesforce from a third-party or web application. You can customize a URL scheme to perform a specific action when Salesforce launches. For example, if a user receives an email about a feed post, you can create a link for the user to tap to view the post in the Salesforce Mobile app.
Additional Query Parameters: Salesforce Mobile app URL schemes support additional, optional query parameters. These parameters let you create links for users who belong to multiple organizations or Experience Cloud sites such that they can be correctly redirected.
Scalability: Plan, build, test, and monitor Salesforce implementations at scale with AI and a suite of integrated performance tools.
Configure Alerts: Configure Scale Center alerts to monitor critical org metrics and receive notifications when thresholds are breached.
Analyze Performance Reports: To troubleshoot errors or spikes in Scale Center, create a performance analysis report.
Apply Scale Insights: Get insights about your Apex code, reports, and search. View database and deployment recommendations.
Enable Scale Center for Standard Users: Use the Scale Center Standard Permission Set to enable access for standard users who aren’t System Administrators.
Scale Center FAQ: Get answers to common questions about using Scale Center.
Org Overview: Use the Org Overview page to monitor org health, identify peak usage, and review recommendations for optimizing performance.
Scale Center: Diagnose root causes and act on scale issues earlier in your development cycle. View org performance metrics and analyze performance reports.
Platform Events Investigations: Surface high-volume platform event publishing and delivery patterns, runtime breakdowns, limit consumption breaches, and user and subscriber breakdowns in your org.
Scale Test FAQ: Get answers to common questions about using Scale Test.
Load Generation: Book a scale test slot, run the full-scale load test, and analyze results to identify performance issues before they affect production.
Scale Test: Use metrics to plan scale tests. Book a slot in your sandbox instance calendar, and test at production peak load. Compare performance data from recent tests.
Security Center Essentials Metrics and Use Cases: Security Center Essentials shows your org’s Security Health Check score plus six other key security metrics. Learn the basics here and refer to related help topics for more information.
Understand and Manage Your Org’s Security Health Check Score: The Security Health Check detail page in Security Center Essentials helps you monitor your org's security posture over time by tracking how well your security settings meet the Salesforce Baseline Standard or a custom baseline you created. Security Center Essentials stores Security Health Check data for 30 days.
Understand and Track Security Center Essentials Metric Changes: Security Center Essentials tracks multiple important metrics for your org. Each metric has a detail page that helps you understand how your org’s ecosystem and configurations change over time. Use these charts to identify activity patterns, make adjustments as necessary, and ensure that your org’s security posture meets or exceeds your baseline.
View Security Center Essentials: From Security Center Essentials, navigate the dashboard to view your org’s Security Health Check score and other security metrics.
View the Security Center Essentials Response Log: The Security Center Essentials Response Log is a read-only list of automated threat containment actions that Salesforce Security performs on your organization's behalf. Use the log to quickly identify which threats are resolved and focus your attention where it's needed.
Schedule the Batch Job to Run: Now that the Process Transaction Journals batch job is created, create a scheduled flow to run this batch job. The batch job processes the Credit Points to Members flow.
Modify and Enrich Salesforce Data with Data Pipelines: Salesforce Data Pipelines is a high-performance data platform that can clean, transform, and enrich large volumes of data at scale. Use Salesforce Data Pipelines to enrich and modify Salesforce data without needing third-party tools or taking data outside your trusted Salesforce environment. Unlike external Extract, Transform, and Load (ETL) tools and data warehousing solutions, Data Pipelines is built natively into your Salesforce CRM, ensuring that updates are fast and secure. No more round-tripping data through expensive, fragile, lower-performing external systems.
Connect and Sync Your Data to Data Pipelines: Salesforce Data Pipelines connectors give you an easy way to connect data inside and outside of Salesforce. Salesforce Data Pipelines provides a prebuilt connector for data in your local org and a range of configurable connectors for remote data in external Salesforce orgs, apps, data warehouses, and database services.
Amazon Athena Connection: Sync Amazon Athena to Salesforce Data Pipelines by creating a remote connection.
Amazon RDS Connection: Create a remote connection using one of the Amazon RDS connectors to bring data managed on the Amazon Relational Database Service into Salesforce Data Pipelines.
Application Connectors: Use an application connector to sync data from an external application to Salesforce Data Pipelines.
Customer 360 Global Profile Data Connection (Beta): Use the Customer 360 Global Profile Data connector to access global profile data from connected orgs, along with other Salesforce and remote data, for integration into Salesforce Data Pipelines.
Databricks Connection: Sync Databricks to Salesforce Data Pipelines by creating a remote connection.
Google Analytics 4 Connection: Create a remote connection using the Google Analytics 4 connector to sync Google Analytics data to Salesforce Data Pipelines.
Google BigQuery for Legacy SQL Connection: Create a remote connection using the Google BigQuery connector to sync data from Google BigQuery to Salesforce Data Pipelines.
Google BigQuery Standard SQL Connection: Bring your large volumes of Google BigQuery data with standard SQL support into Salesforce Data Pipelines using the Google BigQuery Standard SQL connector.
Google Cloud Spanner Connection: Create a remote connection using the Google Spanner connector to sync data from Google Cloud Spanner to Salesforce Data Pipelines.
Heroku Postgres Connection: Create a remote connection using the Heroku Postgres connector to sync Heroku Postgres data to Salesforce Data Pipelines.
HubSpot Connection (Beta): Pull your marketing, sales, and customer service data from HubSpot into Data Manager using the HubSpot connector for Salesforce Data Pipelines.
Salesforce Marketing OAuth 2.0 Connection: Create a remote connection using the Salesforce Marketing OAuth 2.0 connector to sync data from Marketing Cloud Engagement to Salesforce Data Pipelines.
Marketo Connection (Beta): Create a remote connection using the Marketo connector to sync data from Marketo to Salesforce Data Pipelines.
Microsoft Azure SQL Database Connection: Create a remote connection using the Microsoft Azure SQL Database connector to sync data from Microsoft Azure SQL Database to Salesforce Data Pipelines. To connect to Microsoft Azure Synapse Analytics or a dedicated SQL pool (formerly SQL DW), add a Microsoft Azure Synapse Analytics connection instead of this one.
Microsoft Azure Synapse Analytics Connection: Create a remote connection using the Microsoft Azure Synapse Analytics connector to sync data from Azure Synapse Analytics or dedicated SQL pool (formerly SQL DW) to Salesforce Data Pipelines. To connect to SQL databases on Azure, add an Azure SQL Database Connection instead of this one.
Microsoft Dynamics 365 Sales Connection: Create a remote connection using the Microsoft Dynamics 365 Sales connector to sync sales data from your Microsoft Dynamics 365 account to Salesforce Data Pipelines.
NetSuite Connection: Create a remote connection using the NetSuite connector to sync data from NetSuite to Salesforce Data Pipelines.
Object Store and No SQL Connectors: Use these connectors to sync data from your object store and non-SQL services to Salesforce Data Pipelines.
Oracle Eloqua Connection: Create a remote connection using the Oracle Eloqua connector to sync data from Oracle Eloqua to Salesforce Data Pipelines.
Amazon S3 Output Connection: Create a remote connection using the Amazon S3 output connector to write .csv data from Salesforce Data Pipelines to an Amazon S3 bucket when using Data Prep.
Azure Data Lake Output Connection: Create a remote connection using the Azure Data Lake output connector to write .csv data from Salesforce Data Pipelines to Microsoft Azure Data Lake Storage Gen2 when using Data Prep.
Salesforce Output Connection: Push your prepared dataset data into any Salesforce org from Salesforce Data Pipelines Salesforce Output connector and Data Prep. With your prepared data back in Salesforce, you can integrate external data, apply the suite of Salesforce automation tools to act on the data, and allow non-Salesforce Data Pipelines users access to the data through reports and dashboards. External connectors require OAuth 2.0 for server to server communication.
Snowflake Output Connection: Create a remote connection using the Snowflake output connector to write data from Salesforce Data Pipelines to a Snowflake table. Then, use Sync Out to push raw data from Salesforce Data Pipelines to Snowflake, or a Data Prep recipe output node to push transformed data.
Setup OAuth for Snowflake Output: To use the Salesforce Data Pipelines Snowflake output connector with an OAuth connection, you must configure Snowflake, Salesforce, Data Pipelines, an external OAuth authorization server, and an external auth identity provider.
Snowflake Private Output Connection: Create a remote connection using the Snowflake private output connector to write data from Salesforce Data Pipeline to a Snowflake table. The private output connector uses a virtual private connection (VPC) for additional security. To use the Snowflake Private Output connector, you configure a network connection, external credential, and named credential. For authentication, use private key or OAuth.
Tableau Online Output Connection: Push your prepared data from Salesforce Data Pipelines into Tableau Online with the Tableau Online Output connector and Data Prep recipes. Use the connector to push your transformed, merged, and cleaned data to Tableau Online as a .hyper file for further analysis. For example, prepare historical Opportunity data for struggling products in Salesforce Data Pipelines, and then use Tableau Online’s analytics tools to identify helpful trends to optimize deals.
Pilot and Beta Connectors: You can use these connectors as a pilot or beta feature to sync external data with Salesforce Data Pipelines. Before choosing a connector, review its pilot or beta instructions.
Private Connectors: Use private connectors to push and pull data between Salesforce Data Pipelines and external services AWS using a Virtual Private Connection (VPC). Supported services include Snowflake and Amazon S3. To use private input and output connectors you must configure a network connection, external credential, and named credential. These credentials provide the security and privacy required for the private connection.
Amazon Redshift Connection: Create a remote connection using the Amazon Redshift connector to sync data from Amazon Redshift to Salesforce Data Pipelines.
Amazon Redshift Private Connection: Pull your data securely from Amazon Redshift into Data Manager using the virtual private connection (VPC) for Redshift input connector for Salesforce Data Pipelines. To use the Amazon Redshift Private connector, you configure an outbound network connection, external credential, and named credential.
Add and Remove Remote Objects and Fields from Data Sync: Update data sync for connected external data sources to keep up with your changing business by adding objects, removing objects, and managing which fields are synced. Synced data is stored in Salesforce Data Pipelines as objects that can be used in recipes.
Amazon S3 Connection: Create a remote connection using the Amazon S3 connector to sync CSV data from an S3 bucket to Salesforce Data Pipelines.
Amazon S3 Private Connection: Pull your data securely from S3 running on AWS into Data Manager using the Virtual Private Connection (VPC) for S3 input connector for CRM Analytics. To use the S3 Private connector, you configure an outbound network connection, external credential, and named credential.
Salesforce External Connections: Use a Salesforce external connector to sync data from another Salesforce org to Salesforce Data Pipelines. External connectors require OAuth 2.0 for server to server communication.
Salesforce Connectors: Use these connectors to sync your data in systems that are part of the Salesforce ecosystem, including external Salesforce orgs, to Salesforce Data Pipelines.
Connect to Local Salesforce Data: Use the prebuilt Salesforce Connector to manage the data synced between your local Salesforce org and Data Pipeline. Filter data synced to Data Pipelines, create more connections using the Salesforce Local connector, manage objects between connections, and add or remove objects and fields from sync. Use the Salesforce External connector to sync data from a remote Salesforce org.
Add and Remove Local Salesforce Objects and Fields from Data Sync: Update data sync to keep up with your changing business by adding local Salesforce objects, removing objects, and managing which fields are synced. Synced data is stored in Salesforce Data Pipelines as objects that you can use in recipes.
Create Another Salesforce Local Data Connection: Create connections using the Salesforce Local connector to strategically manage when your Salesforce data syncs to Salesforce Data Pipelines using individually scheduled local connections. A local connection, SFDC_LOCAL, is included when Salesforce Data Pipelines is activated.
Filter Local Data Synced to Data Pipelines: Exclude unnecessary or sensitive data from syncing to Data Pipelines with data sync filters. Filters run on the source object and speed up data sync by pulling only the data you need into Data Pipelines. If you want to use excluded data in the future, use a recipe filter to limit the dataset data instead of a data sync filter.
Optimize Recipes That Use the Local Salesforce Connection: Improve the performance of recipes run after a local Salesforce object sync by choosing to optimize the synced data. Optimization is available for full, periodic full, and incremental syncs.
SAP HANA Cloud Connection: Create a remote connection using the SAP HANA Cloud connector to sync data from cloud-based SAP HANA to Salesforce Data Pipelines.
Snowflake Connection: Create a remote connection using the Snowflake connector to sync data from Snowflake to Salesforce Data Pipelines. This connector supports private key or OAuth 2.0 for authentication. Using OAuth 2.0 requires additional setup steps in Snowflake and the Salesforce credentials.
Snowflake Private Connection: Pull your data securely from Snowflake into Data Manager using the Virtual Private Connection (VPC) for Snowflake input connector for Salesforce Data Pipelines. To use the Snowflake VPC connector, you configure an outbound network connection, external credential, and named credential. This connector supports private key or OAuth 2.0 for authentication. Using OAuth 2.0 requires additional setup steps in Snowflake and the Salesforce credentials.
Sync Out for Snowflake: Sync Out for Snowflake exports your raw local Salesforce data via Salesforce Data Pipelines to Snowflake using the Salesforce Data Pipelines output connector for Snowflake. With Sync Out for Snowflake, keep your Salesforce data in Snowflake up to date using scheduled Data Sync without the need for a third-party ETL tool. Fresh Salesforce data is vital if you maintain a central Snowflake data lake for processing, analysis, business automation, or storage. For example, give your shipping logistics team the freshest data by merging your account data from your system of record, Salesforce, with your ERP’s shipping data in your data lake.
Zendesk Connection: Create a remote connection using the Zendesk connector to sync data from Zendesk to Salesforce Data Pipelines.
Data Manager for Data Pipelines: After you set up Data Pipelines, use Data Manager to build, run, and monitor jobs that extract, prepare, and load data into Salesforce. Then you can surface the results anywhere, like in Salesforce fields or Lightning components.
Data Prep for Data Pipelines: Data Prep provides an intuitive, visual interface that allows you to easily point and click your way to build recipes that prepare data and load it into a target.
Clean, Transform, and Load Data with Data Prep: Data Prep provides an intuitive, visual interface in Salesforce Data Pipelines that allows you to easily point-and-click your way to build recipes that prepare data and load it into a target. Use the graph of a recipe to see at a glance where data comes from and how it flows through the recipe to the target. To validate the recipe as you build, preview how raw data is transformed at every step of the way.
Data Prep Access Based on Your User Type: Not all Data Prep users in Salesforce Data Pipelines need access to all data prep features. For example, a business analyst doesn’t need to change dataset security to grant themselves and others access to more data. To support advanced and limited Data Prep user types, Salesforce Data Pipelines comes with two user permissions: Edit Analytics Dataflows and Edit Dataset Recipes.
Data Template Features: Data templates are similar to app templates, with a few key differences.
Available Data Templates: Data templates provide simple data editing and calculations, advanced data manipulation, and rigorous analysis out of the box. To get started, see the instructions and specific details for each template by following these links.
Create Data Assets from a Data Template: Follow these general procedures when you create data assets from any data template. Before you use a template, see the help for the Data Template that you want to use for requirements and instructions specific to that template.
Get Started Faster with Data Templates: Salesforce Data Pipelines use purpose built data templates for common use case data tasks to accelerate your ROI. These data templates generate the necessary data connectors, data prep recipes, and queries for apps that can be scheduled to run regularly.
Modify and Enrich Data with Recipes: Use recipes to prepare large amounts of Salesforce and external data at scale before loading it into Salesforce objects. For example, you can define data preparation logic that combines data from two data sources and cleans up inconsistent date formats. Add nodes and transformations to a recipe to perform calculations, and to combine, transform, enrich, and clean your data. Use smart transformations to predict missing values, detect text sentiment, and forecast key metrics.
Configure Incremental Sync for Salesforce Data: Before you run or schedule data sync, specify whether the sync extracts incremental changes or all records from each Salesforce object. By default, Salesforce Data Pipelines performs an incremental sync. An incremental sync runs faster because it extracts only the latest changes to the Salesforce object.
Get Oriented with the Data Pipelines Tools: Data Pipelines uses Data Manager and Data Prep tools to accomplish tasks. Before you start using these tools, get familiar with them.
Database Connectors: Use these connectors to sync data from your external database services to Salesforce Data Pipelines.
Data Integration Best Practices: Review these tips to improve the performance of your recipes, speed up the editing of large recipes, and streamline data sync.
Manage Recipes: After you create a recipe, use the Recipes tab to edit and delete them.
Run a Recipe: Run a Salesforce Data Pipelines recipe for the first time to create the dataset it defines. Run a recipe again to update the dataset with the latest synced data. You can run a recipe manually or on a schedule.
Set Data Sync Notifications: Set Data Sync notifications to receive an email notification when a Salesforce Data Pipelines sync job has warnings, when sync fails, or every time the sync finishes.
Use the Recipe Inspector: Use the Salesforce Data Pipelines recipe inspector to troubleshoot issues and improve performance. Deep-dive into your recipe jobs to view the detailed information at each stage of the flow. Monitor individual node performance and status. You can quickly identify a slow join or a transformation node that failed to make fixes immediately.
Recipe Inspector Scenarios: The Salesforce Data Pipelines recipe inspector details provide information about the complexity of runtime processing. The following are common scenarios seen in the recipe inspector and what they mean.
Monitor a Recipe Job: The Jobs subtab on the Monitor tab shows the status of Salesforce Data Pipelines data sync and recipe jobs. You can view error messages about a job, view the run-time details about every transformation that is processed, and monitor the number of jobs remaining from your org’s 24-hour limit.
Set Recipe Notifications: Set recipe notifications to receive an email notification when a Salesforce Data Pipelines recipe job finishes. You can receive notifications for warnings, failures, and completions. You can also set an elapsed time notification to notify you when a recipe is still running after a specified length of time.
Run a Recipe Manually: Run a Salesforce Data Pipelines recipe for the first time to create the datasets it defines. Run it again to update the dataset with the latest synced data.
Schedule a Recipe to Run Automatically: You can schedule a Salesforce Data Pipelines recipe to run at a specific time or after an event. Use time-based scheduling to ensure that fresh data is available by a particular time or to run the job during non-business hours. You can schedule a recipe to run hourly, weekly, monthly, or on specific days of the week or dates. Use event-based scheduling to run a recipe after the sync runs to ensure that datasets include the latest data. If you split data prep across multiple recipes, use event-based scheduling to chain these recipes together to obtain the desired outcome automatically.
Export a Recipe Schedule: Export your Salesforce Data Pipelines recipe schedules as calendar format (ICS) for quick reference and visibility in your calendar. For instance, share a recipe's run schedule with stakeholders in other teams to coordinate data readiness and reporting deadlines.
Monitor a Data Sync Job: Monitor the progress of Salesforce Data Pipelines data syncs in Data Manager.
Schedule Smarter with Priority Scheduling: Priority scheduling for Salesforce Data Pipelines recipes automatically manages your run queue. It prioritizes smaller and faster runs while ensuring that larger and longer runs are completed on time. Priority is automatically calculated based on factors such as historic runtime, dataset input size, and CSV file size. Priority scheduling is most helpful to smooth out occasional queue-time spikes. If you never or frequently see long queue times, then priority scheduling isn’t as helpful. Activate the feature in advance to manage your queue, not during a problem when your queue is already overloaded. This feature doesn’t increase your maximum number of concurrent runs.
Run Data Sync Manually: Run data sync manually the first time to make the data available in Salesforce Data Pipelines to build recipes. Schedule subsequent syncs to regularly update the data.
Run Jobs to Create and Refresh Datasets: Whether you use local Salesforce data or pull data from an external source, you must set up Salesforce Data Pipelines to load the data, make it available to Salesforce Data Pipelines, and keep it up to date.
Schedule Data Sync to Run Automatically: To ensure that the latest source data is loaded into datasets, schedule data syncs to pull data into Salesforce Data Pipelines before the corresponding recipes. You schedule data sync for each connection, where all objects under the connection sync at the specified time, and not individual objects. To sync objects from the same data source on different intervals, create multiple connections to the data source, and set a unique schedule for each connection.
Why are my data sync and recipe runs getting canceled?: Tightly scheduled recipe or data sync jobs can result in canceled data sync and recipe runs because too many runs are queued. You can usually avoid this situation by extending the time between a recipe’s or data sync’s scheduled runs.
Why is my scheduled recipe not running as expected?: When recipes use scheduling, users can see unexpected results or sometimes no results at all. Here are some common reasons why your recipe might be having issues.
Why was a recipe unscheduled?: When a user is deactivated, the recipes in which they made the most recent modification are unscheduled to prevent unnecessary runs.
How Salesforce Data Pipelines and CRM Analytics Work Together: CRM Analytics and Salesforce Data Pipelines are unique products, but settings, limits, and assets sometimes are shared or interrelated when you use both products. These features are shared when you use Salesforce Data Pipelines.
Learn About Data Pipelines User Permissions: Users with the Data Pipelines Add On User Settings permission set license can be assigned all Data Pipelines user permissions. To assign all Data Pipelines user permissions, assign them the Data Pipelines Add On permission set.
Data Pipelines Limitations: Data Pipelines uses some features originally built for CRM Analytics, including Data Prep and Data Manager. So it’s possible that you see certain CRM Analytics options that aren’t supported in Data Pipelines.
Data Pipelines Limits: Review the limits for Salesforce Data Pipelines. If needed, you can purchase more licenses to increase the base limits.
Output Connectors: Use output connectors to push data from Salesforce Data Pipelines to the remote system. Output connectors can push as part of a data prep output node, and some can also push out unprepared data using sync.
Connect to a Data Source or Target: Use the Salesforce Data Pipelines connectors to connect data inside and outside of Salesforce. You can access data in your local Salesforce org, external orgs, and other sources, such as apps, data warehouses, and database services.
Stage CSV Data in Datasets: Because CSV files can’t be used as sources in a recipe, you can upload the CSV file and write it to a dataset. And then you can use the dataset as a source for the recipe. When you upload the file, it’s temporarily stored for processing only. After the dataset is created, the file is purged. If you want to use the file again later, keep a copy.
View Data Pipeline Usage: Use Data Manager’s Limits tab to monitor usage and to ensure you don’t hit the limits. The limits vary based on your licenses. If needed, contact Salesforce to increase your org’s limits.
Query Datasets with the Query API Endpoint: If your recipes write results to datasets, you can query the datasets using the Query API endpoint. Although this endpoint is part of the CRM Analytics REST API, you can use it to query datasets built with Data Pipelines. This endpoint supports SAQL and SQL queries. You can use this endpoint to create an application that queries data in datasets.
Input Node: Add Data to the Recipe: Although you choose input data when you create a recipe, if needed, you can add more data to an existing recipe. In Salesforce Data Pipelines, Data Prep shows a separate Input node for each set of data that you add to the recipe.
Add or Subtract Days or Months: In Salesforce Data Pipelines, return the column date with the specified days or months added or removed.
Additional Functions for Formulas: In Salesforce Data Pipelines, these versatile functions can be used with the data types text, number, date_only, and datetime to build logic into your formulas.
Aggregate Node: Use an Aggregate node in Salesforce Data Pipelines to roll up data. You can aggregate to a higher level of granularity or roll up hierarchical data.
Aggregate Node: Hierarchical Aggregation: Use Hierarchical Aggregation in Salesforce Data Pipelines to sum measures across multilevel data. For example, you can roll up revenues, assets, or liabilities for companies and their subsidiaries. Or, you can roll salesperson data up the management chain to see aggregates by team, region, area, and beyond. Hierarchical Aggregation requires rows with an ID and a parent ID. Many rows can have the same parent ID, or the parent ID can be empty. Some rows can even share an ID, such as a record with multiple parents. You can also use the optional roll up percentage to apply percentage splits to allocate portions to different parents, such as commission among members of the sales team.
Aggregate Node: Roll Up Data to a Higher Level: Use an Aggregate node to roll up data to a higher granularity in Salesforce Data Pipelines. You can aggregate using: unique, sum, average, count, maximum, and minimum. You can group by any dimension or date column. You can also pivot dimensions as columns. For example, you can group opportunities by account to get account-level details, like total opportunity amount, average number of cases, and the average days to close an opportunity for each account. You can then pivot on account type to analyze each combination of account and account type.
Append Node: Stack Rows from Different Sets of Data: Use an Append node in a Data Prep recipe in Salesforce Data Pipelines to stack rows from multiple sets of input data into one dataset. For example, use this node to combine sales records from two different Salesforce orgs, each containing sales transactions from a specific region.
Connect and Reorganize Nodes or Branches in a Recipe: In Salesforce Data Pipelines, connect disconnected nodes or branches to join or append data from any node to any other node in a Data Prep recipe. You can also create a branch at an intermediate node, and join or append it to another path in the recipe.
Data Type Conversion Transformations: Convert Column Types: In Salesforce Data Pipelines, the data type of a dataset column determines how you can query that column’s data. For example, you can filter and group by a text or date column, or perform calculations on a number column. When you load data into a dataset, CRM Analytics sometimes tags a dataset field with the wrong type. If needed, use the column-type conversion transformations in a Data Prep recipe to convert columns to the correct types.
Copy and Paste a Recipe: In Salesforce Data Pipelines, use the toolbar or keyboard shortcuts to copy and paste nodes within a single recipe or across multiple ones. To use this feature, enable clipboard access permissions in your browser.
Create a Recipe with Data Prep: Use a Data Prep recipe in Salesforce Data Pipelines to clean, transform, and enrich data before loading it into one or more targets. Preview your results as you build the recipe to confirm that the logic is correct.
Data Preview Sampling: In Salesforce Data Pipelines, use data preview sampling to see a more accurate picture of your data at each node in Preview. By widening the sample size and selecting the mode to arrange your data, data sampling helps prevent working without preview data. Select Filtered Rows to isolate specific values. Select All Column Values to populate a sample when you need to see all column values, such as when creating a bucket.
Date Functions for Formulas: In Salesforce Data Pipelines, use date functions to adjust or calculate values from dates in your recipe. For example, you can add time, find time until, and extract a day of the week from date fields. The arguments for date functions are date columns.
Delete a Recipe: Delete recipes that you no longer need. Deleting a recipe doesn’t delete its target dataset.
Pull Data Directly into Recipes: Direct data for recipes in Salesforce Data Pipelines lets your recipes access data in Salesforce objects that you don’t sync. When you use direct data, the latest data is pulled directly from the Salesforce object with each recipe run, bypassing the data sync step. Direct data is designed to access a small number of objects instead of optimizing for performance as is the case with data sync connected objects. After you decide to use direct data, you can use it in recipes, add filtering, and switch the data to be connected instead.
Date Difference: In Salesforce Data Pipelines, calculate the duration between two selected date columns as days, months, or years.
View or Edit a Recipe: In Salesforce Data Pipelines, view or edit a recipe by clicking its name. By default, all recipes open with Data Prep. When you edit a Data Prep Classic recipe, the recipe upgrades to and opens with Data Prep.
Filter Node: Filter Rows: In Salesforce Data Pipelines, use a Filter node to remove rows that you don’t need in your target. For example, you can filter case records to focus on escalated cases only. Filter values are case-sensitive. Filter nodes next to a direct data input node speed up recipe runs by reducing the number of records pulled into the recipe.
Use a Join Node in the Recipe Canvas: In Salesforce Data Pipelines, create joins between Salesforce objects, external objects, and CRM Analytics datasets in a recipe.
Join Node: Add Related Columns of Data to the Recipe: Use a join node in Salesforce Data Pipelines to add columns of data from related objects to existing data in a recipe. When working with CRM Analytics datasets and external objects, add a join node on the recipe canvas. When working with Salesforce objects, you can either create a join on the recipe canvas or join the data when you first create your dataset on the Add Input Data screen.
Lookup: In Salesforce Data Pipelines, a lookup returns all rows from the left data stream (recipe data) and only matching rows from the right data stream (lookup source). If multiple matches are found in the right data stream, you can set the lookup to return either a single row or all matching rows. To ensure that the grain of the results doesn’t change, the lookup outputs one row for each row in the left data stream.
Use a Join Node on the Add Input Screen (Salesforce Objects Only): When working with Salesforce objects in Salesforce Data Pipelines, you can create your dataset and join data source in one step on the Input Data screen. Add Input Data also recommends columns that match each of your data sources and can serve as join keys.
Multivalue Functions for Formulas: In Salesforce Data Pipelines, use multivalue functions with your multivalue data. For example, look for a specific value, count how many values there are, create a new multivalue by combining other text, convert a multivalue to a string, or split a string and return a multivalue. The arguments for multivalue functions must be text strings or fields.
Nodes for Data Prep Recipes: In Salesforce Data Pipelines, Data Prep provides nodes that let you bring in data, transform it, and write the results to a target. For example, you can use a Join node to add columns from a related object to a recipe. You add nodes in the Graph area of Data Prep. You can string together multiple nodes to sequentially change the flow of the data.
Now: In Salesforce Data Pipelines, create a column in a Data Prep recipe that displays the current date and time in a specified format.
Numeric Operators and Functions for Formulas: In Salesforce Data Pipelines, use numeric functions to calculate values from numbers in your recipe. For example, you can round, truncate, and determine the absolute value of a number. The arguments for numeric functions can be number values or columns.
Output Node: Write Recipe Results to a Dataset or External System: In Salesforce Data Pipelines, use Output nodes with Data Prep recipes to write recipe results to a target, such as a dataset, staged data, .csv, or remote location like Amazon S3. A recipe can have more than one Output node. If the recipe writes to a dataset, you can change the API name and label of the dataset in the Output node. If an existing dataset uses the specified API name, the recipe overwrites the existing dataset when it runs.
Recipe Output to CSV: Use the Data Prep output node in Salesforce Data Pipelines to save your prepared data as a data and schema file in a Salesforce BPO (storage database). You can then download the data locally using the public API as a CSV file. Use the CSV file to transfer prepared, cleaned, and improved data into your system for analysis, storage, or to inform business processes.
Run Sequential Recipes with Staged Data: When your data strategy involves multiple recipes, you can reduce processing time by using staged data instead of datasets. Place the steps you would otherwise repeat into one recipe that outputs results as staged data. Subsequent recipes can then use the staged data as input nodes to do other work. For example, rather than merge account and opportunity data in several region-specific forecasting recipe, merge in an initial recipe that outputs the results as staged data, and use this data in the other recipes
Preview Results in a Data Prep Recipe: As a best practice in Salesforce Data Pipelines, catch mistakes early by previewing the results of each node and transformation that you add to your Data Prep recipe.
Profile Columns to Understand Data in a Data Prep Recipe: In Salesforce Data Pipelines, run column profiling on sample data to estimate key stats about columns, such as the frequency of values and percent of columns with missing values. Column profiling is especially useful when you are combining data from different sources, where inconsistencies are often introduced. Column profiles are available only for columns shown in preview.
Reserved Keywords in Formulas: In Salesforce Data Pipelines, Data Prep has reserved keywords that need special handling when manually writing formulas. Use double quotes " when referencing dataset columns that share a name with reserved keywords. To avoid cross-referencing your column names to this list, the best practice is to use double quotes around all column names.
Notation for String Formulas: In Salesforce Data Pipelines, use formulas to create custom calculations. If you manually type your formulas, use single quotes ' for string literals and double quotes " for joined fields with dot notation or reserved keywords. If you use the recipe builder tool instead of typing, the correct single or double quote is automatically used.
String Functions for Formulas: Use string functions to create values based on other strings. For example, you can change the casing of text strings, concatenate values from multiple columns, and replace values. The arguments for string functions must be text strings or dimension fields.
Transform Node: Transform the Data Before Loading It Into a Target: Use a Transform node in Salesforce Data Pipelines to manipulate data based on the transformations added to the node. You can add one or more transformations to each Transform node. For example, you can add transformations to concatenate two columns, standardize the formats in a date column, and detect the sentiments of comments in a Feedback column. Each transformation modifies the data in a unique way. To manipulate data at multiple stages of a recipe, add a separate Transform node at each stage.
Categorize Date Column Values into Buckets: In Salesforce Data Pipelines, Data Prep provides transformations that allow you to prepare, clean, and transform your data. For example, you can use a transformation to create a calculated column based on a formula. You add transformations inside a Transform node. You can string together multiple transformations to manipulate data sequentially.
Categorize Dimension Column Values into Buckets: In Salesforce Data Pipelines, use a bucket column in a Data Prep recipe to categorize and organize text values. For example, you can create buckets West, Central, and East to group regions.
Categorize Measure Column Values into Buckets: In Salesforce Data Pipelines, use a bucket column in a Data Prep recipe to categorize and organize numeric values. For example, you can create buckets High, Middle, Low to group numbers of cases per account.
Cluster Transformation: Segment Your Data: In Salesforce Data Pipelines, use the Cluster transformation in a Data Prep recipe to segment rows of data into distinct clusters based on common characteristics. For example, you can cluster accounts based on number of employees, numerical rating, and annual revenue. Using the clusters, you can identify products and services to upsell to each account based on other accounts in the same cluster, apply different service handling or marketing campaigns based on cluster, or define different metrics and KPIs for analysis.
Cross Join: In Salesforce Data Pipelines, a cross join combines unrelated records and includes all rows from the left (recipe data) and the right. Unlike other joins that use keys to find matches, the cross join pairs every row from one dataset with every row of another dataset (known as the Cartesian Product).
Date and Time Transformations: Calculate on Date Fields: In Salesforce Data Pipelines, your date fields are key to understanding trends over time or keeping teams aware of upcoming milestones and deadlines. Use the Date and Time transformations to calculate based on dates or make them more helpful to your analysis. With the Now option, you can insert a column with the current date and time in a specified format. Use Date Difference to calculate the duration between two selected date columns as days, months, or years. And use the Add or Subtract Days or Months function to add or subtract days or months from a date column.
Extract Transformation: Get a Date Component: In Salesforce Data Pipelines, use the Extract transformation in a Data Prep recipe to pull a selected component from a date field into a new field. For example, extract the hour component from the Case Created Date column to analyze case creation by hour of the day.
Detect Sentiment Transformation: Determine the Sentiment of Text: In Salesforce Data Pipelines, text fields show valuable information such as product reviews and social media posts. Use the Detect Sentiment transformation in a Data Prep recipe to quickly categorize text into sentiments. Choose whether you want sentiment results as a decimal value on a 5-point scale, with 5 as the most positive, or as labels of Positive, Negative, and Neutral. For example, detect the sentiment of survey responses to evaluate how customers feel about your product support. If more than a certain percentage—say 30%—of the comments are negative, escalate the feedback to support management..
Detect Sentiment Model Card: In Salesforce Data Pipelines, the Detect Sentiment transformation uses the model to determine whether the sentiment of text is positive, negative, or neutral. Use this model card to better understand the model, how it’s trained, its capabilities, its intended use, and its limitations.
Text to Date Transformation: Convert the Column Type: When you load data into a dataset, Salesforce Data Pipelines tags a date column as a text if it contains unexpected string values or dates in different formats. To use date functionality, such as grouping by month, use the Text To Date transformation to change the Text column type to Date.
Text to Number Transformation: Convert the Column Type: When you load data into a dataset, Salesforce Data Pipelines tags a number column as text if it contains unexpected strings or characters. To perform a calculation on the column, such as calculating the average, use the Text To Number transformation to change the Text column type to Number. You can perform calculations on number columns only.
Drop Columns Transformation: Drop Columns from the Recipe: In Salesforce Data Pipelines, Drop unwanted columns from a Data Prep recipe. For example, you can add a Drop Columns transformation after a Formula transformation to drop input columns used for a calculated column.
Edit Attributes Transformation: Change the Column Names and Value Formats: In Salesforce Data Pipelines, to make column names more descriptive and apply consistent formats to column values, use the Edit Attributes transformation in a Data Prep recipe. You can set the labels and API names of all columns. You can also set the precision and scale for number columns, character length for text columns, and date formats for date columns.
Discovery Predict Transformation: Get Einstein Discovery Predictions: In Salesforce Data Pipelines, use the Discovery Predict transformation to populate your datasets with predictive and prescriptive intelligence. When you run a Data Prep recipe with a Discovery Predict node, Einstein calculates and saves predicted outcomes on a row-by-row basis. You can optionally store descriptions of top predictors and improvements. With the Discovery Predict node, you can quickly evaluate predictions across a large set of data, assess multiple models before deploying them into production, and aggregate this information in a dashboard.
Flatten Transformation: Flatten Hierarchies: In Salesforce Data Pipelines, the Flatten transformation flattens hierarchical data. For example, you can flatten the Salesforce role hierarchy to implement row-level security on a dataset based on the role hierarchy.
Format Dates Transformation: Standardize the Date Format in a Column: In Salesforce Data Pipelines, if a text column contains dates in different formats, use the Format Dates recipe transformation in a Data Prep recipe to standardize the format for all dates in the column. A consistent format enables you to correctly filter and group records by date, including filtering by date component, such as month. It also ensures you can successfully convert the column type from text to date. Optionally, you can convert the column type from Text to Date.
Formula Transformation: Create a Calculated Column Based on an Expression: In Salesforce Data Pipelines, create a column in a Data Prep recipe that displays values based on a formula calculation. The calculation can include input from other fields in the same row or across rows. For example, you can create a Profit column based on input from Revenue and Cost columns. Enter formulas in EA-SQL format. EA-SQL is a collection of standard and custom functions for numeric, string, and date data.
Full Outer Join: In Salesforce Data Pipelines, a full outer join includes all rows from the left (recipe data) and right, regardless of whether they have matches. The join includes all matched rows in the target when multiple rows match.
Inner Join: In Salesforce Data Pipelines, an inner join includes only matching rows from the left (recipe data) and right. The join includes all matched rows in the target when multiple rows match.
Considerations When Using Joins: In Salesforce Data Pipelines, unlike a lookup, a join creates a separate record for each match in the target dataset when multiple rows match. Before using a join, ensure that you understand the implications of duplicate rows.
Left Join: Like a lookup, a left join in Salesforce Data Pipelines includes all rows from the left (recipe data) and only matching rows from the right. Unlike a lookup, a join includes all matched rows in the target when multiple rows match.
Number to Text Transformation: Convert the Column Type: When you load data into a dataset, Salesforce Data Pipelines tags a text column as a number column if it contains only numbers. For example, Salesforce Data Pipelines tags a numerical Room Number column as the number type, even though it’s text that identifies rooms. To group and filter by a number column, use the Number To Text transformation to change a Number column type to Text. You can group and filter by text columns only.
Predict Missing Values Transformation: Fill In Missing Values: In Salesforce Data Pipelines, use the Predict Missing Values transformation in a Data Prep recipe to complete your data by filling in missing values in a text column. Salesforce Data Pipelines Intelligently predicts values based on values in other strongly correlated columns in your data.
Right Join: A right join in Salesforce Data Pipelines includes all rows from the right and only matching rows from the left (recipe data). The join includes all matched rows in the target when multiple rows match.
Split Transformation: Break Up Column Values: In Salesforce Data Pipelines, you can split the strings in a text column into two values by specifying a delimiter. To split column values into more than two parts, add multiple instances of the Split transformation. For instance, you can use 3 Split transformations in a Data Prep recipe to split the full address into the following components: street address, city, state, and zip code.
Time Series Forecasting Transformation: Forecast Measures: In Salesforce Data Pipelines, make decisions today based on forecasts about tomorrow with time series forecasting. A time series forecast takes an ordered series of points and intelligently forecasts the next values. For example, estimate units sold for the next 4 quarters based on the last 5 years of sales. Use the Time Series Forecasting transformation in a Data Prep recipe to run forecasts based on historical data and seasonality.
Transformations for Data Prep Recipes: In Salesforce Data Pipelines, Data Prep provides transformations that allow you to prepare, clean, and transform your data. For example, you can use a transformation to create a calculated column based on a formula. You add transformations inside a Transform node. You can string together multiple transformations to manipulate data sequentially.
Update Node: Swap Column Values: In Salesforce Data Pipelines, you can swap column values with data from another data source when key pairs match with the Update node. For example, to update selected account names after a series of recent acquisitions and mergers, replace the name from an uploaded spreadsheet based on matching account IDs. Processing time is minimized by only changing column values with matching key pairs, instead of every value in the column.
Restore a Previous Version of a Recipe: Test new ideas on recipes in Salesforce Data Pipelines. If you break a recipe, you can revert to a previous version. For recipes with multiple collaborators, each version displays the name of the contributor who made an update.
Window Functions for Formulas: In Salesforce Data Pipelines, use window functions in a Data Prep recipe to perform calculations across rows. For each row of input data, perform a calculation on a selection—or window—of related rows. Unlike aggregation that groups rows, window functions return a result for each row. For example, you can calculate the changes to the opportunity amount throughout the stages of each opportunity to see if you can hit your sales target.
Pre-Pull Data for Recipes with Data Sync: Use data sync to decouple the extract of data from your recipes and sync this data to Salesforce Data Pipelines on a separate schedule. By scheduling sync from Salesforce and remote systems ahead of time, your recipes have less to do and run faster. To lighten the load even more, Salesforce Data Pipelines can sync supported local Salesforce data incrementally by default, meaning that only data that’s changed gets synced.
Calculate API Calls Consumed by Salesforce Output Connector: When you use the Salesforce Output connector to push data from Salesforce Data Pipelines to another Salesforce org, you’re using part of that Salesforce org’s allotted Bulk API batch limit to receive the data.
Schedule, Run, and Monitor Data Sync: With Salesforce Data Pipelines, you can schedule sync to run automatically, manually run a sync, and monitor a sync's progress, all in the data manager.
Schedule the Sentiment Analysis Recipe: The Sentiment Analysis template creates one recipe to perform the data analysis on the specified source object. To update the analysis data, you must schedule the recipe for your app.
The Sentiment Analysis Recipe and Dataset: The Sentiment Analysis template creates a recipe that performs sentiment analysis on the source object field that you selected in the configuration wizard. This recipe outputs a dataset with the analysis results and any additional selected fields.
Troubleshoot an Unsuccessful Salesforce Output Connector Run: The Salesforce Data Pipelines Salesforce Output Connector pushes data from Salesforce Data Pipelines into Salesforce as a Bulk API job. If a portion of the data push fails, use Salesforce Setup and the API to troubleshoot.
View Data Sources and Targets: Use Data Manager’s Data tab to access data available for recipes. You can view datasets created by recipes that can be used as sources in other recipes. You can also view all connected objects.
What Can I Do with Data Pipelines?: Before Data Pipelines, companies often resorted to exporting data, enriching it in external systems, and then writing the results back into Salesforce. This approach was often time consuming and expensive. But now with Data Pipelines, you can do it all natively, securely, and more quickly in Salesforce. Data Pipelines simplifies the process of consolidating, aggregating, and calculating results based on CRM data and external data. It ensures rapid updates that give your CRM users the latest and most complete picture of customer activity.
How Is Search Different in Salesforce Classic: Global search in Lightning Experience and Salesforce Classic uses the same search index, so you're always searching the same data. You see the same set of recently accessed records in instant results. The search scope (the list of objects you use the most) influences search results, but some standard objects aren't available in Lightning Experience. You don’t always see the exact same search results. Lastly, the global search interface is different between these experiences, so there are visual and navigational differences to consider.
Search Insights: Use on-demand insights to get recommendations and improve your search performance.
How Is Search Different in the Salesforce Mobile App?: Not every Lightning Experience feature is available in the Salesforce mobile app. Find out what’s different and not available when you search across a Salesforce org.
Set Up Einstein Search: Find out which objects and fields are searchable. Customize search settings, search result filters, and lookup search. Learn how to improve the search experience for users.
Implement a Custom MFA Process with Apex (Salesforce Orgs): To implement your own multi-factor authentication (MFA) process, use Apex methods under the System.UserManagement class. The methods come as a pair for the Salesforce Authenticator and phone (SMS) identity verification methods — one to initiate a verification service, and one to complete the verification service. For password or time-based one-time password (TOTP) verification methods, you can use the second method alone to provide a complete verification service. Use of SMS for MFA is supported only for external users accessing your company’s Experience Cloud sites, employee communities, and other types of community portals.
IP and Domain Access: Add the required domains to your network allowlist, and configure IP allowlists in Salesforce.
Activations: Activation tracks information about devices from which users have verified their identity. Salesforce prompts users to verify their identity when they access Salesforce from an unrecognized browser or application. Identity verification adds an extra layer of security on top of username and password authentication. The Activations page lists the login IP addresses and client browsers used.
Use Activations: View your users’ activations and revoke activation status to prevent security breaches.
API Access: Configure remote site settings and named credentials to control and secure API callouts, and understand the purpose of the Platform Integration User.
Manage API Access: Use API Access Control to manage access to your Salesforce APIs. With this feature, you can restrict all users from accessing your Salesforce APIs unless they’re pre-authorized through an approved (allowlisted) connected app. Or you can restrict only customers and partners from accessing your Salesforce APIs unless they’re using a connected app that is installed in your org.
Restrict Access to APIs with Connected Apps: You can use API Access Control to restrict users from accessing your Salesforce APIs, unless they’re pre-authorized through an approved connected app. Connected apps integrate external applications with Salesforce APIs. With API Access Control, you can lock down all connected apps’ access to Salesforce APIs and then approve (allowlist) specific connected apps. Using profiles and permission sets, you can then grant users access to an approved connected app. These users can access APIs through the connected app.
Restrict Customers and Partners from Accessing APIs: You can use API Access Control to restrict customers and partners from accessing APIs, unless they’re using a connected app that is installed in the Experience Cloud site. Connected apps integrate external applications with Salesforce APIs. You can select which connected apps to install in the Experience Cloud site to limit access to APIs.
Monitor and Audit Security in Salesforce: Salesforce security is an ongoing practice. Audit changes to your org’s security, including field and setup changes. Track user logins, mobile device access, and user identity verification events.
Create Logout Event Triggers: If the LogoutEventStream object is available to your org, you can create Apex triggers that respond to security logout events from your org’s UI.
Require High-Assurance Session Security for Sensitive Operations: To secure different setup areas in your org, require a high-assurance level of security for sensitive operations, such as accessing reports and managing IP addresses. You can also block users from accessing these setup areas.
Replace the Default Proxy Certificate for SAML Single Sign-On: The proxy.salesforce.com default certificate has been retired due to its expiration and for security best practices. If your Salesforce org uses this certificate for SAML single sign-on, act now to prevent a possible interruption of service.
Countries Supported for SMS Identity Verification: These countries and regions are supported for SMS delivery in Salesforce orgs and Experience Cloud sites. For information about unsupported countries and regions, see our compliance documentation.
Best Practices for Security Contacts: Follow these best practices to help ensure that critical Salesforce security communications reach the correct people without delay.
Control Access to Browser Features: To control whether requests to an external (non-Salesforce) server or URL can access the user’s camera and microphone, enable the Permissions-Policy HTTP header. Then select when to allow access to each of these browser features.
Disconnect a Passkey from a User’s Account (Salesforce Orgs): If a user loses or replaces the device where they used a passkey (also known as a built-in authenticator), you can disconnect the passkey from their account. If a user’s passkey stops working, reset it by disconnecting the passkey. Then ask the user to re-register their passkey or create a new passkey.It’s also a good security practice to disconnect all of a user’s verification methods if they leave your company.
Take Charge of Your Security Goals with Security Center: The Security Center app offers a single view of your security, privacy, and governance posture across all of your Salesforce orgs and tenants. Use the app to review up-to-date health check scores, access settings, and user and login metrics in one easy-to-read interface. When you know how your orgs and tenants are performing, you can shorten security review processes and limit risks. You can also get clear insights into how you're meeting your security goals and respond proactively when suspicious conditions arise. And during periods of growth or change, Security Center can help you monitor changes that touch sensitive customer data.
Resolve Security Anomalies with Security Center with Agentforce (Beta): Security Center with Agentforce uses Event Monitoring and Security Center data to identify potential security incidents. When an incident is identified, Agentforce creates an Investigation record that includes the incident data and a suggested remediation plan.
Configure Your Security Agent (Beta): Configure Security Center with Agentforce to get the most out of agent capabilities for security triage, investigation, and response.
Enhance Your Security Posture by Using Security Center with Agentforce (Beta): Leverage the power of Agentforce to reduce alert fatigue and move quickly from security anomaly detection to guided remediation. Security Center with Agentforce, previously Agentforce for Security, is your AI-powered partner in investigating and resolving security incidents.
Use Cases for Alerts: This page contains examples of custom alerts that you can create to monitor your tenant’s security.
Designate a Parent Tenant in Security Center: To see security information for multiple tenants, designate a parent tenant to show data collected from that parent tenant and all connected child tenants. You can disconnect child tenants at any time. And you can group parent and child tenants based on their security policies or regulations.
Create Alerts for Security Changes: Create custom alerts to immediately learn about changes made to security settings that you care about. Alerts notify you by email or in the Salesforce app when a setting in your Security Center tenant exceeds a threshold that you set. Create as many alerts as you want so that you can stay informed of your tenant’s security posture.
Create Your Own Custom Metrics: Monitor vital data and bolster your organization's security posture by creating your own custom metrics that you can monitor from your Security Center dashboard.
Security Center Security Landscape: Security Center Security Landscape helps you get a quick status update on your security posture and usage patterns. The Security Landscape organizes aggregate data for all security data metrics by category. Category details show weekly data snapshots for all metrics in that category.
Define and Deploy Security Policies: You can define security-related policies and deploy them to the tenants that you choose. Use data gathered in Security Center to identify settings that matter most to you.
Review Detailed Metric Data: The metric detail page provides graphical and record-level views of changes, totals, and trends. Use this page for audits, deploying or updating policies, and monitoring usage patterns.
Disconnect a Child Tenant from a Parent Tenant: Sometimes you want to view a child tenant's data in a different parent tenant or stop viewing metrics from a child tenant. You can disconnect a child tenant from a parent tenant at any time. Disconnected child tenant data is retained, and visible when the child tenant is reconnected to a parent tenant.
Security Center Essentials: Security Center Essentials helps you visualize, understand, and optimize your org’s security posture based on your org’s Security Health Check score and six other fundamental security metrics. Security Center Essentials is available to customers at no additional cost. Licensed Security Center customers continue to use the full-featured, multitenant version. If your org upgrades from Security Center Essentials to the full version of Security Center, all historical metrics data is transferred.
Security Center Extension: The Security Center Extension helps enhance data security and compliance. After installing the Security Center Extension managed package, use it to find sensitive data and classify it with a data-sensitivity category. You can then decide how best to secure that data by using other Salesforce settings and features.
Classify Fields in Security Center: Security Center's Field Classification tool lets you assign and manage sensitivity level and other classifications for fields across all objects in your parent and tenant orgs, individually or in bulk.
Field Classification Attributes: Before you classify fields, customize your Fields view, or filter the Fields list, make sure you understand the field classification attributes.
Field Classification Considerations: Make sure you understand these considerations for classifying fields and configuring the Field Classification Fields list.
Customize Your Field Classification Fields List: Select the field attributes you need to see on the Fields list and remove the ones you don't. Object, Field, and Sensitivity Level attributes are always visible, but you can add, arrange, and remove others to get the view you want.
Calculate Fill Rates for Salesforce Fields: Field fill rates help identify which fields are filled on object records and how actively and consistently they're filled. Use fill rates to prioritize high-use fields to classify and identify fields that aren't used.
Filter the Fields List by Classification Attributes: Filtering the Field Classification tool's Fields list by classification attributes lets you narrow the list of fields you're working with and analyze your field security posture more efficiently. Filter by object and field attributes, and adjust field fill rate calculations.
Field Classification Filters and Use Cases: Field Classification's advanced filters let you focus on the fields that matter, whether you're trying to identify high-traffic fields that carry real compliance risk or flagging empty fields that go unused and can be deprecated.
Review Health Check Data: The Health Check detail page in Security Center saves you time by aggregating multiple Health Check scores and settings in one place. From a parent tenant, you can see the average Health Check score for all connected tenants and individual tenant Health Check scores. Security Center stores Health Check settings for 6 months.
Manage and Monitor Security Investigations in Security Center: Security Center gives you control and visibility over investigations for security detections—such as credential stuffing or API anomalies—that occur within your organization's connected tenants.
Create and Configure a Security Investigation Remediation Plan: A Security Center remediation plan lets you specify the steps and actions Salesforce takes to resolve security findings, such as session hijackings and login anomalies. You build your plan from steps you define, and an individual step can be used within multiple plans.
Create a Security Investigation Remediation Step: Remediation steps tell a remediation plan what to do to remediate security detections. A step can have multiple versions, but only one version can be active at a time.
View Security Investigations in Security Center: When one or more tenant organizations has a security investigation in progress, you can follow progress, view details, take user actions, and track response stages on the Security Center Investigations tab, from a kanban-style dashboard or a list.
Security Center Metrics: Security Center captures selected security, compliance, and governance metrics for all tenants.
Enable Security Center Permissions: To give new users access to Security Center in the app launcher, enable Security Center permissions. You can assign Security Center permissions from Profiles or Permission Sets in Setup.
Security Center Response Log: The Security Center Response Log is a read-only list of automated threat containment actions that Salesforce Security performs on your organization's behalf. Use the log to quickly identify which threats are resolved and focus your attention where it's needed.
Unify Security Data with Security Mesh: Security Mesh simplifies your security operations by unifying security data from internal and external sources into a single format in Security Center. These security findings help you identify and respond to threats more effectively.
Set Up the Security Mesh Signal Definitions: To specify the pipelines that send security-related data to Security Mesh, configure signal definitions. This step initiates the automated background tasks that ingest and standardize your data.
Set Up the Security Mesh Environment: Select the data space and workspace that store your Security Mesh data and analytical assets. This process creates the infrastructure for your security visualizations. Complete this one-time task the first time that you access the Security Mesh tab.
Security Mesh FAQs: Find answers to common questions about setting up and using Security Mesh.
Manage Security Mesh Webhook Signal Definitions: For signal types that use a built-in webhook, manage the webhook connection by enabling or disabling data ingestion, rotating the API key, or updating the API header.
Review Threat Detection Events: The Threat Detection app in Security Center saves you time by aggregating information on detected threats to all your tenants in one place. From a parent tenant, see information on four types of detected events throughout your org in real time. Threat Detection uses statistical and machine learning methods powered by Event Monitoring to detect threats to your tenants. Security Center stores Threat Detection event information for 6 months
Update Metric Data: Security Center automatically updates data one time per day. If you want to update data more frequently, you can update most metrics on demand.
Security Center Data: Security Center offers several ways to view your security settings and data. Summary and Category dashboards organize aggregate data and totals for quick scanning. Detail pages show metric-specific trends and details about changes made to security settings on specific days. Security Center stores data for 6 months. Because Security Center surfaces sensitive information, we recommend that you enable multi-factor authentication for all Security Center users.
Monitor Configured MCP Servers in Security Center (Beta): Monitor Model Context Protocol (MCP) servers configured across your organization's connected Salesforce tenants. Check risk scores, detect suspicious server URLs, and audit server-related activity, all from Security Center.
View the Security Center Response Log: Monitor automated threat containment actions that Salesforce Security performs on your organization's behalf from the Security Center Response Log.
Certificate-Based Authentication: In addition to authentication methods like single sign-on, Salesforce provides certificate-based authentication, which you can configure to authenticate your Salesforce users with unique PEM-encoded X.509 certificates.
Delete User Authentication Certificates: Delete a user authentication certificate if it’s compromised and the certificate has been revoked, expired, or no longer being used.
Enable Certificate-Based Authentication: To use certificates to authenticate individual users to your org, you must enable certificate-based authentication.
Review Certificate Login Errors: When you enable certificate revocation status checks, Salesforce prevents logins with certificates that are revoked or can’t be validated. To see why a certificate login failed, check your org’s Login History page. Review these login errors.
Add Certificate-Based Authentication to Your My Domain Login Page: After you enable certificate-based authentication in Identity Verification, add the Certificate-Based Login button to your My Domain login page. Users can click the button to authenticate using their unique user authentication certificate.
Rename User Authentication Certificates: You can rename a user authentication certificate. To edit more than a user certificate’s name, delete the certificate, and upload a new PEM-encoded X.509 digital certificate.
Validate the Revocation Status of User Authentication Certificates: Each time users log in with a certificate, you can validate its revocation status using the Online Certificate Status Protocol (OCSP) or Certificate Revocation Lists (CRL). With OCSP, Salesforce checks the revocation status of certificates in real time. If an OCSP status check fails, or a certificate isn’t configured for OCSP, Salesforce uses a CRL instead.
Upload a User Authentication Certificate: After enabling certificate-based authentication, you can upload PEM-encoded X.509 digital certificates to authenticate individual users to your org.
Log In to Your Org with Certificate-Based Authentication: If your Salesforce org supports certificate-based authentication as a login method, you can log in with your unique user authentication certificate instead of a username and password.
View Details About User Authentication Certificates: You can view all user authentication certificates uploaded for your org, and you can view certificates assigned to a single user. From these views, you can see when the certificates were uploaded and when they expire. You can also rename and delete certificates.
Apply Clickjack Protection to Less Common Browsers: To help protect your users against clickjacking attacks, Salesforce applies the Content-Security-Policy: frame-ancestors HTTP header directive to the pages that Salesforce serves when that directive is supported. To extend clickjack protection to more users, include that directive in the rare cases when Salesforce can’t identify whether the requesting app or specialized browser supports the directive.
Enable Clickjack Protection for Visualforce Pages: To help protect against clickjack attacks, prevent external sites from loading your Visualforce pages in an inline frame (iframe). Optionally, you can allow trusted external sites to frame your Visualforce pages.
Configure Clickjack Protection: Clickjacking is a type of attack that tricks users into clicking something, such as a button or link. The click sends an HTTP request that performs malicious actions that can lead to data intrusion, unauthorized emails, changed credentials, or similar results. To help protect against this kind of attack, most Salesforce pages can only be served in an inline frame by a page on the same domain. Learn which types of pages can be framed and how to configure the related clickjack settings.
Specify Trusted Domains for Inline Frames: To allow external sites to load your Visualforce pages or surveys in an inline frame (iframe), you must add each trusted domain to an allowlist in Session Settings. External domains that aren't on the allowlist can't frame your pages.
Restrict Page Resource Requests with Cross-Origin Embedder Policy (COEP): To safeguard your custom Visualforce pages, only allow content from external sources that trust your page. When you enable the Cross-Origin Embedder Policy (COEP) setting, externally sourced embedded content loads only when the origin explicitly states that your page or domain can load its content. Embedded content can include images, documents, and widgets.
Set a Security Contact: For every production org, set a security contact to receive critical security alerts, vulnerability notifications, and incident communications.
Protect Your Visualforce Pages with Cross-Origin Opener Policy (COOP): Help shield your custom Visualforce pages from external attacks. When you enable Cross-Origin Opener Policy (COOP), each top-level custom Visualforce page opens in a new browsing context group. This process prevents direct access between other browser tabs and your Visualforce page and the page’s content.
Create a Custom Baseline for Health Check: You can import up to five custom baselines to compare your security settings with your standards instead of the Salesforce recommended standards. For example, if you’re in financial services, you can create a custom security baseline by using FINRA standards.
Custom Baseline File Requirements: To import your Health Check custom baseline successfully, make sure that your file and settings meet the requirements.
Delegate MFA Management Tasks for Salesforce Orgs: Set up Salesforce admins, and trusted users who aren’t admins, to provide support for your org’s multi-factor authentication (MFA) implementation. For example, suppose you want your company’s Help Desk staff to assist admins by generating temporary verification codes for users who have lost or forgot their MFA verification methods. Assign the Manage Multi-Factor Authentication in User Interface user permission to all admins and anyone else who is supporting MFA, so they can generate codes and help end users with other MFA tasks.
Mobile Device Tracking: Mobile Device Tracking gives you greater control over your data security. You can track and monitor which mobile devices access your Salesforce org. You can revoke access from lost and stolen devices. And you can build processes and policies to define how devices access your org, such as requiring an approval request from the device before authorizing a login.
Create Custom Reports for Mobile Device Tracking: Using custom report types, you can create custom reports for Mobile Device Management statistics, such as how many active and revoked devices your Salesforce org has.
Manage Device Access with Mobile Device Tracking: You can manage which devices access your Salesforce data. Store a mobile device's unique identifier, then you can approve or revoke that device's access.
View Devices with Mobile Device Tracking: You can view devices using REST API, SOQL queries in Apex, or any other method that you use to interact with sObjects.
Disconnect Identity Verification Methods that are Lost, Replaced, or Not Working (Salesforce Orgs): When addressing multi-factor authentication (MFA) access issues, there are situations where a Salesforce admin must disconnect a user’s current verification method from their Salesforce account. This step is necessary if a user has lost their method, or has acquired a replacement method that they want to use instead of their current one. If a user’s method stops working, disconnecting it allows the user to re-register the method and restore its connection to their account. It’s also a good practice to disconnect all of a user’s verification methods if they leave your company.
Email Security: To enable Salesforce to send email, verify your email domains. And protect outbound communications with email security standards including Transport Layer Security (TLS), Sender Policy Framework (SPF), DomainKeys Identified Mail (DKIM), and Domain-based Message Authentication (DMARC). And help your users complete the required verification of their email address and return email address in Salesforce.
Copy Authorized Email Domains into a Sandbox: To avoid a second round of DNS verification, import your authorized email domains from production to a sandbox. In production, specify the authorized email domains to copy to a sandbox. Then, in a sandbox, import the available domains with one click.
Set Up an Authorized Email Domain: To verify your email-sending domain without DomainKeys Identified Mail (DKIM), set up an authorized email domain. For example, if your users’ email addresses are in the format name@example.com, set up an authorized email domain for example.com.
Authorized Email Domains: To send email on behalf of your users, Salesforce requires that you verify ownership of your email domains. We recommend that you set up DomainKeys Identified Mail (DKIM) to complete that requirement. If you can’t set up DKIM keys, verify that you own a domain via an authorized email domain.
Activate a DKIM Key: After you add a DomainKeys Identified Mail (DKIM) key in Setup and update your domain’s DNS records, wait for the DNS changes to apply across the internet before you activate the key.
Identify Your Email-Sending Domains: Use the User Email Domains page in Setup and email logs to identify the email domains used to send email from Salesforce. List the email domains used in your active users' email addresses and return email addresses on the User Email Domains page in Setup. Then check your email logs for domains used to send system-generated email.
Get Started with Email and Email Security: Configure email sending methods, set up shared email addresses, and protect your org with email verification and authentication controls.
Check the Verification Status of an Email-Sending Domain: Salesforce requires both domain-level and user-level verification to send email. View the verification status of a domain that you own on the Deliverability Setup page.
Considerations for Sending Email from Salesforce: Review the recommended method for verifying your email-sending domains and considerations if you use a single email-sending domain in multiple orgs. Allowlist a Salesforce-owned email domain, and understand why email address verification is important to your security.
Get a List of Your Verified Email-Sending Domains: To identify your verified email-sending domains, use Salesforce Object Query Language (SOQL) and Tooling API. Query your DomainKeys Identified Mail (DKIM) keys and your authorized email domains.
Manage User Email Address Verification: Users can’t send outgoing email from Salesforce until their Salesforce email address and return email address are verified. This requirement improves security in Salesforce and reduces the risk of email spoofing and spam. Identify users with unverified email addresses or return email addresses. Then learn how to initiate the verification process.
Requirements to Send Email from Salesforce: To protect your org and brand, Salesforce requires domain-level and user-level email verification. To send email from Salesforce with your email domain, verify ownership of your email-sending domains.
Use a Verified Domain for User-Level Email Verification: If a trusted integration or admin manages your users’ email addresses in Salesforce, specify which domains require address verification. For each authorized email domain, you can require email address verification only when users change their email address, or disable address verification entirely. Or use your active DomainKeys Identified Mail (DKIM) keys to verify addresses for new users and new organization-wide email addresses.
Enable Passkeys for Identity Verification in Salesforce Orgs: With passkeys, users can log in and complete multi-factor authentication (MFA) with Touch ID or Face ID, Windows Hello, a device password, or password managers. With MFA enforcement, Salesforce automatically enables passkeys (also known as built-in authenticators) as an available verification method for all employee users. When MFA is enforced in your org, you can't turn off this setting. If MFA isn't enforced yet in your org, turn on passkeys to test them. Passkeys satisfy the phishing-resistant MFA requirement for privileged users. Users can also use security keys to complete other identity verification challenges, such as device activation.
Limit Interactions with External URLs and Origins: In our connected world, interaction with external websites and origins is a necessity. To protect your network and data, configure allowlists and enable settings that limit how Salesforce and external origins interact. And limit redirections that originate in Salesforce to URLs that you trust.
Manage Redirections to External URLs: Protect your users from untrusted external redirections away from Salesforce. First, review which kinds of redirections are automatically restricted and your options for restricting hyperlinks in Salesforce. Add the external URLs that you trust to an allowlist. Then specify what happens when a user clicks a hyperlink that takes them outside your Salesforce org.
Field History Tracking: To maintain an audit trail of who changed what and when, use Field History Tracking. Select the standard and custom object fields to track.
Get Started with Salesforce Security: Whether you’re new to Salesforce, setting up a new org, or reviewing your security configuration, start here to understand the key security features and settings available in the Salesforce Platform.
Security Health Check: As an admin, you can use Health Check to identify and fix potential vulnerabilities in your security settings, all from a single page. A summary score shows how your org measures against a security baseline like the Salesforce Baseline Standard. You can upload up to five custom baselines to use instead of the Salesforce Baseline Standard.
Set Up Security Health Check Score Notifications: Configure who receives weekly notifications if your Health Check score decreases. These alerts keep admins informed without the need for manual monitoring.
How Is the Health Check Score Calculated?: The Health Check score is calculated by a proprietary formula that measures how well your security settings meet the Salesforce Baseline Standard or your selected custom baseline. Settings that meet or exceed compliance raise your score, and settings at risk lower your score.
Security Health Review Tool: The Security Health Review Tool identifies security gaps in an org’s configuration and provides recommendations to strengthen your Salesforce security posture.
Identity Verification: Identity verification is when a user provides evidence, called a verification method, to confirm they’re the true owner of an account. Users verify their identity to gain certain access privileges in Salesforce, such as logging in, activating a new device, or viewing a sensitive resource. Define how and when users verify their identity.
Identity Verification Overview: Identity verification is when a user provides evidence, called a verification method, to confirm they’re the true owner of an account. Users verify their identity to gain certain access privileges in Salesforce, such as logging in, activating a new device, or viewing a sensitive resource. Depending on the use case, identity verification is referred to as multi-factor authentication (MFA), device activation, or step-up authentication.
Certificates and Keys: Salesforce certificates and key pairs are used for signatures that verify a request is coming from your org. They’re used for authenticated SSL communications with an external website, or when using your Salesforce org as an Identity Provider. You only need to generate a Salesforce certificate and key pair if you're working with an external website that wants verification that a request is coming from a Salesforce organization.
Best Practices for Managing Root Certificates: Root certificates are the essential trust anchors for your org’s encrypted integrations. Before configuring your Certificate Trust Store, learn how to maintain the integrity of your connections.
Delete a Root Certificate: When you’re notified that a certificate authority (CA) is expiring, or when your org no longer needs a certificate, manage certificate deletion appropriately.
Download a Root Certificate: Download a certificate if you need to inspect, audit, backup, share with a partner or vendor, or import into another environment (e.g., prod → sandbox).
Upload a Root Certificate: Add a certificate to your trust store by uploading a root certificate in a supported format.
Generate a Self-Signed Certificate: Generate a certificate signed by Salesforce to show that communications purporting to come from your organization are really coming from there.
Export and Import Certificates with a Keystore: You can export all your certificates and private keys into a keystore for storage or import certificates and keys from a keystore. This keystore lets you move keys from one organization to another. The exported file is in the Java Keystore (JKS) format, and the imported file must also be in the JKS format.
Manage Expired Certificates: When you’re notified that a certificate authority (CA) or self-signed certificate is expiring, or when your org no longer needs a certificate, manage certificate deletion appropriately.
Certificates in Salesforce: Understand how certificates are used in Salesforce and how they expire. To prevent disruption and potential downtime, replace your certificates before they expire. Processes can stop working when a certificate expires, which can lead to outages.
Set Expired Certificate Notification Permission: Limit who's notified about expiring certificates by assigning the Receive Certificate Expiration Notifications permission. When you assign this permission to at least one admin, users with the System Administrator profile or the Modify All Data permission receive emails about an expiring certificate only the day before it expires and the day of expiry. Admins with the permission receive emails at 60, 30, and 10 days before a certificate expires. If you don’t assign this permission to anyone, all users with either the System Administrator profile or the Modify All Data system permission continue to receive all certificate expiration emails.
Manage Your Certificate Trust Store: Use the Certificate Trust Store to maintain a repository of root certificates for validating inbound TLS connections (not inbound mTLS). The Certificate Trust Store is tied to your individual Salesforce org and isn’t shared with others. By managing your own trust store, you can ensure that integrations align with your specific security and compliance requirements.
Set Up a Mutual Authentication Certificate for API Login: To improve security by preventing impersonation, you can require mutual authentication when a client app tries to access Salesforce data. With mutual authentication, the client app and the Salesforce server prove their identity to each other with signed certificates by using the Mutual Transport Layer Security (mTLS) protocol. As a prerequisite for mutual authentication, upload your client certificate to Salesforce.
Configure Your API Client to Use Mutual Authentication: To use mutual authentication when calling Salesforce services via API, configure your client app to present your client certificate and chain to Salesforce. For security reasons, the client certificate must be used only in your org.
Generate a Certificate Signed by a Certificate Authority: A certificate authority-signed (CA-signed) certificate can be a more authoritative way to prove that your org’s data communications are genuine. You can generate this type of certificate and upload it to Salesforce.
Manage Master Encryption Keys: Encrypted custom fields, such as Social Security Number or Credit Card Number, are encrypted with a master encryption key. This key is automatically assigned when you select fields to encrypt. You manage your own master key according to your organization’s security and regulatory needs.
Enable Lightning Login: Enable Lightning Login to give your users the enhanced speed, convenience, and security of password-free logins. After enabling Lightning Login and assigning the required permission to your users, encourage them to individually enroll in this password-free login feature.
Enroll in Lightning Login: Enroll in Lightning Login so that you can enjoy the enhanced speed, convenience, and security of password-free logins.
Lightning Login for Password-Free Logins: Say goodbye to the hassle of weak passwords, forgotten passwords, and locked-out accounts. With Lightning Login, you can give your users the enhanced speed, convenience, and security of password-free logins.
Custom Login Flows: A login flow directs users through a login process before they access your Salesforce org or Experience Cloud site. You can use a login flow to control the business processes that your users follow when they log in to Salesforce. After Salesforce authenticates a user, the login flow directs the user through a process, such as enforcing strong authentication or collecting user information. When users complete the login flow successfully, they’re redirected to their Salesforce org or site. If unsuccessful, the flow can log out users immediately.
Set Up a Login Flow and Connect to Profiles: After you create a flow using Flow Builder or Visualforce, designate it as a login flow and associate it with a user profile. When a user with an associated profile logs in, they go through the login flow.
Create a Login Flow with Flow Builder: Use the point-and-click Flow Builder to create a login flow declaratively. With this tool, you create a screen flow—a collection of screens and connectors that step users through a business process when they log in.
Login Flow Examples: You can use a login flow to customize the login experience and integrate business processes with Salesforce authentication. Common uses cases include collecting and updating user data at login, configuring multi-factor authentication, or integrating third-party strong authentication methods.
Create a Custom Login Flow with Visualforce: Use Visualforce and an Apex controller to create a custom login flow programmatically. With Visualforce, you have complete control over how your login page looks, behaves, and directs users after they complete the flow. You can design your login page from scratch and control every pixel of the page.
Keep Your Salesforce Org in Compliance with the MFA Requirement When Using an Approved Alternative Configuration: Are you satisfying the contractual MFA requirement with an approved alternative to MFA, such as employing certificate-based authentication that requires a PIN or using a combination of trusted devices and trusted networks for account access? Here are some tips to keep your production org in compliance with the requirement while ensuring appropriate users don’t receive MFA challenges when logging in.
Exclude Exempt Users from MFA for Salesforce Orgs: The Waive Multi-Factor Authentication for Exempt Users user permission previously allowed you to exempt specific users from MFA for use cases such as automation. After Salesforce enforces MFA requirements in your org, this permission no longer automatically exempts users from MFA. To restore this exemption for valid use cases, you must contact Salesforce Customer Support.
Enable MFA for Direct Login: Turn on multi-factor authentication (MFA) for everyone in your org with a single setting. When MFA is enabled, all internal users logging in directly with their username and password must also provide an identity verification method, such as an authenticator app or security key.
Use SMS as an MFA Verification Method for External Users: If you enable multi-factor authentication (MFA) for your customer or partner Experience Cloud sites, external users can log in using one-time passcodes delivered via SMS text messages. Users need only a verified mobile number and access to their device when they log in. This option is available for external users only. External users can also verify their identity with other supported MFA verification methods such as Salesforce Authenticator built-in authenticators, security keys, and third-party authenticator apps.
See How Your Users Verify Their Identity: To see who's using which identity verification methods, customize a list view of your users or create an Identity Verification Methods report.Use custom reports to spot patterns in identity verification behavior for your org or Experience Cloud site.
Set Trusted IP Ranges for Your Org: To help protect your Salesforce data from unauthorized access, specify a list of IP addresses from which users can log in without receiving an identity verification challenge.
Verification Method Selection During MFA Registration: With MFA enforcement, Salesforce prompts employee users who don't have a registered verification method to set up passkeys, also known as built-in authenticators. Salesforce requires passkeys for direct login for users with privileged permissions. Users who don't have these privileged permissions (non-privileged users) can choose to set up another verification method for direct login, such as Salesforce Authenticator. But passkeys are still the first option that all users see in the MFA registration flow, regardless of their permissions.
Configure Specialized Security Solutions: Tailor your security posture to satisfy complex security and compliance requirements in Salesforce. Use specialized features and products to limit risk, proactively monitor and manage user activity, manage encryption keys, and gain more visibility into your data.
Multi-Factor Authentication for Salesforce Orgs: Multi-factor authentication (MFA) is a secure authentication method that requires users to verify their identity with a second piece of evidence (or factor) in addition to their password. To protect users from security threats like phishing, credential stuffing, and account takeovers, Salesforce requires MFA for all logins to Salesforce products. MFA is both technically and contractually required. These requirements apply equally to direct logins with a Salesforce username and password and to logins via single sign-on (SSO). Salesforce provides MFA functionality for all Salesforce products.
Auditing: Auditing provides information about use of the system, which can be critical in diagnosing potential or real security issues. Salesforce auditing features don't secure your org by themselves. Have someone from your org perform regular audits to detect potential abuse.
Device Activation: By adding extra verification to unfamiliar login attempts, device activation keeps your orgs and Experience Cloud sites secure.
Security Infrastructure: Salesforce utilizes some of the most advanced technology for Internet security available today. When you access the application using a Salesforce-supported browser, Transport Layer Security (TLS) technology protects your information using both server authentication and Classic Encryption, ensuring that your data is safe, secure, and available only to registered users in your organization.
Manage User Passwords: Salesforce provides each user in your org with a unique username and password that the user must enter at each login. As an admin, you can configure several settings to ensure that your users’ passwords are strong and secure.
Session Security: After logging in, a user establishes a session with the platform. Use session security to limit exposure to your network when a user leaves the computer unattended while still logged in. Session security also limits the risk of internal attacks, such as when one employee tries to use another employee’s session. Choose from several session settings to control session behavior.
Phishing and Malware: Protect your Salesforce data from phishing and malware attacks by understanding the risks, following security best practices, and staying informed about the latest threats.
Require Multi-Factor Authentication for Key Management: Multi-factor authentication (MFA) is a powerful tool for securing access to data and resources. Salesforce requires the use of MFA for all logins to your org's user interface. In addition, you can add extra security by also requiring MFA for Shield Platform Encryption key management tasks like generating, rotating, or uploading key material and certificates.
Encrypt CRM Analytics Data: To get started with CRM Analytics Encryption, generate a tenant secret with Shield Platform Encryption. After you generate a CRM Analytics tenant secret, CRM Analytics Encryption uses the Shield Platform Encryption key management architecture to encrypt your CRM Analytics data.
Analyze Fields for Encryption Readiness: Assess the impact of encrypting individual fields with Field-Level Encryption (FLE). If a field is referenced by functions elsewhere in your Salesforce org, FLE can sometimes disrupt those functions. The field analyzer flags any encryption schemes that are blocked by existing configurations. Analyzing a field is required before you can encrypt it.
Apply Encryption to Standard Fields in Salesforce Classic: Applying encryption to multiple standard fields at the same time on one or more standard objects is the same process in Salesforce Classic and Lightning Experience. Applying encryption to a standard field on a custom object, a custom field on a standard object, or a custom field on a custom object, in Salesforce Classic is slightly different from the process in Lightning Experience.
Apply Encryption to Standard Fields in Lightning Experience: You can apply encryption to one or more standard fields at the same time on one or more standard objects by using the Encrypt Standard Fields page. To apply encryption to a standard field on a custom object, a custom field on a standard object, or a custom field on a custom object, do one field at a time.
Learn About Encrypting Archived Data: Data in production is encrypted by a variety of keys, some of which you control via Shield Platform Encryption. When you move data out of production and into an archive, Salesforce encrypts it with a data encryption key (DEK) that you can pair with a root key via Shield Platform Encryption. You control your root key, which means you maintain control of all keys that encrypt data while it’s in the archive.
Encrypt Archived Data: When you turn on encryption for Archive in Setup, Salesforce creates a root key dedicated to your org’s data archives and begins encrypting your data.
Learn About Encrypting Backup & Recover Next Data: Your backups contain the same sensitive data that you encrypt in your production org. It makes sense to protect backups the same way. Shield Platform Encryption extends to Backup & Recover Next and encrypts backup data at rest with a root key that's unique to your org. As a result, your backup data meets the same compliance and regulatory requirements as your production data.
Encrypt Data Backups: You can encrypt data backups made with Backup & Recover Next. To encrypt data backups, turn on encryption for Backup & Recover. Salesforce creates a root key for you and begins encrypting your data.
Shield Platform Encryption Best Practices: Take the time to identify the most likely threats to your org. This process helps you distinguish data that needs encryption from data that doesn’t, so that you can encrypt only what you need to. Make sure that your tenant secret and keys are backed up, and be careful who you allow to manage your secrets and keys.
Bring Your Own Key Overview: Generate and store customer-supplied key material outside of Salesforce by using your own crypto libraries, enterprise key management system, or hardware security module (HSM). You then grant the Salesforce Shield Platform Encryption access to those keys. Bring Your Own Key (BYOK) is available for most key types and data stores that Shield Platform Encryption supports.
Cache-Only Key Service: Shield Platform Encryption’s Cache-Only Key Service addresses a unique need for non-persisted key material. You can store your key material outside of Salesforce in any key repository or service that you control and have the Cache-Only Key Service fetch your key on demand from that key service. Your key service transmits your key over a secure channel that you configure, and the Cache-Only Key Service uses your key for immediate encrypt and decrypt operations. Salesforce doesn’t retain or persist your cache-only keys in any system of record or backups. You can revoke key material at any time.
Reactivate a Cache-Only Key: If you still have your named credential associated with a key that was destroyed in Salesforce, you can reactivate a destroyed cache-only key from Setup or programmatically through the API. Reactivating a destroyed key makes it the active key. Before you reactivate a destroyed key, make sure that the corresponding key service connection is recovered.
Check Your Cache-Only Key Connection: Because your cache-only key material is stored outside of Salesforce, it’s important to maintain a functional callout connection. Use the Callout Check page to monitor your connection and quickly respond to key service interruptions that could prevent the service from fetching your keys.
Considerations for Cache-Only Keys: These considerations apply to all data that you encrypt using the Shield Platform Encryption Cache-Only Key Service.
Create and Assemble Your Key Material: The Shield Platform Encryption Cache-Only Key Service is compatible with 256-bit AES keys returned in a JSON response, and then wrapped using JSON Web Encryption (JWE).
Destroy a Cache-Only Key: When you destroy a cache-only key, you’re destroying two things: the key in the cache and the callout connection to the key service.
How Cache-Only Keys Works: The Shield Platform Encryption Cache-Only Key Service provides access to various key services to generate, secure, and store your key material. Because a cache-only key bypasses the key derivation process, it’s used to directly encrypt and decrypt your data. You can use an on-premises key service, host your own cloud-based key service, or use a cloud-based key brokering vendor. Services that incorporate named principals for credentials are recommended, although key services that use legacy named credentials without named principals are supported.
Prerequisites and Terminology for Cache-Only Keys: Shield Platform Encryption’s Cache-Only Key Service offers you more control over your key material. When you use cache-only keys, you control more of the key-management tasks. Before you start using the service, review how to create and host your key material in a way that’s compatible with Salesforce’s BYOK service. Also review several important terms relevant to the Cache-Only Key Service
Add Replay Detection for Cache-Only Keys: Replay detection protects your cache-only keys if a callout is fraudulently intercepted. When enabled, replay detection inserts an autogenerated, unique marker called a RequestIdentifier into every callout. The RequestIdentifier includes the key identifier, a nonce generated for that callout instance, and the nonce required from the endpoint. The RequestIdentifier serves as a random, one-time identifier for each valid callout request. After you set up your key service to accept and return the RequestIdentifier, any callout with missing or mismatched RequestIdentifiers is aborted.
Troubleshoot Cache-Only Keys: One or more of these frequently asked questions can help you troubleshoot any problems that arise with Shield Platform Encryption’s Cache-Only Key Service.
Troubleshooting Bring Your Own Key: Read these frequently asked questions to help you troubleshoot any problems that arise with Shield Platform Encryption’s Bring Your Own Key service.
Generate a BYOK-Compatible Certificate: To encrypt data in Salesforce with Bring Your Own Key (BYOK) key material for any feature, such as field-level encryption or Search Encryption, use Salesforce to generate a 4096-bit RSA certificate. You can generate a self-signed or certificate-authority (CA) signed certificate. Each BYOK-compatible certificate’s private key is encrypted with a derived, org-specific tenant secret key.
Wrap BYOK Key Material: Generate a random number as your BYOK key material. For FLE only, you also calculate an SHA256 hash of the secret and encrypt it with the public key from the BYOK-compatible certificate you generated.
Take Good Care of Your BYOK Keys: When you create and store your own key material outside of Salesforce, it’s important that you safeguard that key material. Make sure that you have a trustworthy place to archive your key material; never save a tenant secret or data encryption key on a hard drive without a backup.
Opt Out of Key Derivation with BYOK: For Field-Level Encryption (FLE), Files and Attachments, and Event Bus Data, you can opt out of key derivation and upload a final data encryption key (DEK). Opting out gives you even more control of the key material used to encrypt and decrypt your data.
Sample Script for Generating a BYOK Tenant Secret: We provide a helper script that may be handy for preparing your tenant secret for upload. The script generates a random number as your tenant secret, calculates an SHA256 hash of the secret, and uses the public key from the certificate to encrypt the secret. This script is for creating a BYOK tenant secret only FLE, Files and Attachments, and Event Data.
Sample Script for Generating BYOK Secrets for Archive, Backup & Recover Next, and Data 360: Shield Platform Encryption provides a script to help you upload customer-supplied key material for Archive, Backup & Recover Next, and Data 360 data. It creates a root key that you can then upload to Salesforce. The script generates a random number as your secret and uses the public key from the certificate to encrypt the secret.
Sample Script for Generating BYOK Secrets for Search and for Database Encryption: We’ve provided a script to help you upload your BYOK material for Search and for Database Encryption. It creates an uploadable DEK for Search, or an uploadable tennant secret for Database Encryption. The script generates a random number as your secret and uses the public key from the certificate to encrypt the secret.
Bring Your Own Key (BYOK): When you supply your own key material, you take direct control over encryption keys in a way that helps you address compliance and regulatory requirements. You retain all the benefits built into Salesforce Shield Platform Encryption. You can upload your own customer-supplied keys for most data stores that Shield Platform Encryption supports. Depending on the feature, BYOK supports tenant secrets, data encryption keys (DEKs), and root keys.
Upload Your BYOK Key Material: After you prepare your Bring Your Own Key (BYOK) key material, upload it to Salesforce. You can upload keys for most categories of data that Shield Platform Encryption supports. Each data category uses a different type of key material: tenant secrets for deriving data encryption keys, data encryption keys (DEKs) for direct encryption, or root keys for securing other keys. You upload the key for your category of data, such as search indexes, plus a second file that secures your key material during upload.
Optimize Security Using Named Credentials and Cache-Only Keys: You can use an externally managed key as your cache-only key. External credentials create a secure connection between Salesforce and your external-key repository. For optimal security, set up an external credential that uses a named principal to authenticate into your external service on behalf of all users authorized to manage key material. Salesforce recommends you use this method instead of a legacy named credential if you use an external key management service along with cache-only keys.
Why Bring Your Own Key?: Shield Platform Encryption’s Bring Your Own Key (BYOK) feature gives you an extra layer of protection against unauthorized access to critical data. It can also help you meet the regulatory requirements that come with handling financial, health, or personal data. After you set up your key material, use Shield Platform Encryption as you always do to encrypt data at rest in your Salesforce org.
Encrypt Data in Chatter: Enabling Shield Platform Encryption for Chatter adds an extra layer of security to the information that users share in Chatter. You can encrypt data at rest in feed posts and comments, questions and answers, link names and URLs, poll questions and choices, and content from your custom rich publisher apps.
Learn About Encrypting Chatter Data: Shield Platform Encryption provides an additional layer of security for the collaborative discussions and information shared within Chatter. Encrypt data at rest in Chatter feed posts and comments, questions and answers, link names and URLs, poll questions and choices, and content from your custom rich publisher apps.
Components Involved in Deriving Keys: Encryption keys are derived with a combination of hardware security modules (HSMs) and key derivation servers.
How Shield Platform Encryption Works: Shield Platform Encryption helps you encrypt your data with keys that you manage. It uses two methods to protect your data: key derivation and direct encryption. For field-level encryption and Database Encryption, it uses a derived key composed of a unique tenant secret that you control and a primary secret that Salesforce maintains. For External Key Management (EKM) and databases that support root keys, a root key wraps the data encryption keys (DEKs) that directly encrypt and decrypt your data. You control the root key. Platform Encryption for search indexes, Archive, Backup & Recover Next, and Data 360 support root keys.
Tradeoffs and Limitations of Shield Platform Encryption: A security solution as powerful as Shield Platform Encryption doesn’t come without some tradeoffs. When your data is encrypted, it’s possible that some of your users experience limited functionality, and sometimes certain features aren’t available to them at all. As you design your encryption strategy, consider the impact on your users and your overall business solution.
Salesforce Apps That Don’t Support Shield Platform Encryption: Many Salesforce features work as expected when you work with data that’s encrypted with Shield Platform Encryption. Others don’t. When you apply field-level encryption (FLE) and Database Encryption in the same org, standard Shield Platform Encryption limitations apply.
Field Limits with Shield Platform Encryption: It’s good practice to use validation rules to enforce these field limits. In addition, because encrypted content is often longer than its ciphertext, encrypting a field can impose further limits on the values that you store in that field. Therefore, test your field limits in longer fields, such as Address and Subject, and on any encrypted field that contains non-ASCII values such as Chinese, Japanese, or Korean-encoded data.
Generate and Manage Root Keys and Tenant Secrets: Salesforce has multiple secret types that are used to encrypt different categories of data. You can generate root keys, data encryption keys, and tenant secrets right from Setup.
Learn About Encrypting CRM Analytics Data: CRM Analytics reports and dashboards sometimes contain confidential business insights, personally identifiable information, or other sensitive data. With Shield Platform Encryption, you can encrypt your CRM Analytics datasets at rest, maintaining compliance and enhancing your data security.
Which Custom Fields Can I Encrypt?: With field-level encryption (FLE), you can apply Shield Platform Encryption to the contents of certain custom field types. If you use Database Encryption, all custom fields are encrypted.
Learn About Encrypting Data 360: By default, Salesforce encrypts Data 360 data at rest with a Salesforce-managed data encryption key (DEK). With Shield Platform Encryption, you generate and manage a tenant-specific root key that controls your DEK. In this way, you retain control and visibility over the keys that secure your data. Shield Platform Encryption for Data 360 also supports Marketing Cloud Next and Tableau Next wherever they use Data 360.
Shield Platform Encryption Terminology: Encryption has its own specialized vocabulary. To get the most out of your Shield Platform Encryption features, it’s a good idea to familiarize yourself with key terminology.
Deploy Applications with Shield Platform Encryption Enabled: As a developer, you can deploy applications to your org by using tools such as Salesforce Extensions for Visual Studio Code, Migration Tool, and Postman. When you deploy your application, the setting of the Encrypted Field attribute is determined by its setting in the target org.
Destroy Key Material: Only destroy Shield Platform Encryption tenant secrets and key material in extreme cases where access to related data is no longer needed. Your key material is unique to your org and to the specific data to which it applies. Once you destroy key material, related data is not accessible unless you import previously exported key material. You can't destroy key material used by Database Encryption.
Filter Encrypted Data with Deterministic Encryption: You can filter data that’s protected with Shield Platform Encryption using deterministic encryption. Your users can filter records in reports and list views, even when the underlying fields are encrypted. You can apply case-sensitive deterministic encryption or exact-match case-insensitive deterministic encryption to data on a field-by-field basis.
Considerations for Using Deterministic Encryption: These considerations apply to data encrypted with Shield Platform Encryption’s deterministic encryption scheme. Some considerations manifest differently depending on whether data is encrypted with the case-sensitive or case-insensitive deterministic encryption scheme.
Encrypt Data with the Deterministic Encryption Scheme: Generate key material specific to data encrypted with deterministic encryption schemes. You can apply either case-sensitive deterministic encryption or case-insensitive deterministic encryption schemes to your data, depending on the kind of filtering that you want to perform. When you apply a deterministic encryption scheme to a field or change between deterministic encryption schemes, synchronize your data. Syncing data makes sure that your filters and queries produce accurate results.
How Deterministic Encryption Supports Filtering: By default, Shield Platform Encryption uses a probabilistic encryption scheme to encrypt data. Each bit of data is turned into a fully random ciphertext string every time it’s encrypted. Encryption doesn’t generally impact users who are authorized to view the data. The exceptions are when logic is executed in the database or when encrypted values are compared to a string or to each other. In these cases, because the data has been turned into random, patternless strings, filtering isn’t possible. For example, you might run a SOQL query in custom Apex code against the Contact object, where LastName = 'Smith'. If the LastName field is encrypted with probabilistic encryption, you can’t run the query. Deterministic encryption addresses this problem.
Disable Encryption on Fields: You can disable Shield Platform Encryption for fields, files, or both. You can turn field encryption on or off individually, but file encryption is all or nothing.
Audit an EKM Key: In this context, auditing means examining the details about the EKM key, such as when it was last modified. You can also view each external key’s unique policy.
Check the Connection to Your EKM Key: You can check the connection between Salesforce and your external key management service. This information can help you troubleshoot problems when you configure your key policy.
Shield External Key Management Considerations: Your Salesforce implementation depends on your external keys to encrypt and decrypt your data. If the key status changes, your users can permanently lose access to encrypted data. Take these considerations into account when managing your external keys.
Connect Salesforce to AWS KMS and Create a Data Encryption Key: When you configure your connection between Salesforce and AWS, you provide information about the AWS KMS key that you want Salesforce to use (key identifier, region, and description). You then generate a JSON structure and add that structure to your key policy in the AWS console for your key.
Deactivate an EKM Key: When you want to revoke all access to encrypted data, or rotate keys as a part of planned maintenance, you can deactivate key material. The effect of deactivating key material is similar to that of deleting a key. Your data remains encrypted, but it can’t be decrypted.
How Salesforce Shield EKM Works: With External Key Management (EKM), customers designate and use an external key management service (KMS) to manage data encryption keys (DEKs) in Salesforce. These DEKs encrypt and decrypt data. When not in use, Salesforce stores DEKs in a wrapped (encrypted) state within Shield Platform Encryption's key cache. For any encrypt or decrypt operation, Shield Platform Encryption sends the wrapped DEK to the customer's external key service, which then unwraps it and securely returns it.
Key Maintenance and Auditing for EKM: Common key operations include auditing, deactivating, reactivating, rotating, and checking the connection to your external keys. These operations affect the keys identified in your Salesforce setup. The original keys in the external KMS are managed by a separate external process.
External Key Management: Shield External Key Management (EKM) connects your Salesforce implementation to your key material in an external key management service (KMS). Shield Platform Encryption then uses that key material to encrypt and decrypt your Salesforce data. EKM fetches your keys on demand from the external KMS over a secure channel.
EKM Prerequisites: To use EKM, you must create a data encryption key (DEK) of sufficient strength in a supported external key management service. You should also check that an external application can communicate with the key service to securely retrieve the DEK.
Reactivate an EKM Key: You can make a previously deactivated key active again. When a key is reactivated, data previously encrypted with the key can be decrypted and viewed.
Rotate an EKM Key: Key rotation refers to the process of updating or changing your key material. You can edit existing key materials or replace them with new ones. If you edit or update your external key, make sure to align your external key details across both Salesforce and AWS KMS.
Key Coordination Policy Setup: Track the status of both the external KMS key and the Salesforce EKM key that depends on it.
EKM in a Sandbox Org: A sandbox org that’s copied, refreshed, or cloned from a source org that uses EKM keys is granted minimum access to the source org’s keys, so that it can decrypt any encrypted data it inherited from the source org. A sandbox org can’t manage its source org's keys in any way, because sandboxes have limited access to those keys. Rotate the keys in a sandbox org as soon as you create it.
Encrypt New Files and Attachments: For another layer of data protection, encrypt files and attachments. If Shield Platform Encryption is on, the body of each file or attachment is encrypted when it’s uploaded.
Encrypt Data 360 with Customer-Managed Root Keys: By default, Salesforce encrypts all Data 360 data at rest with a Salesforce-managed data encryption key (DEK). With Platform Encryption for Data 360, you can generate and control a Data 360 root key in Salesforce. Your Data 360 root keys are specific to your org and secure the DEKs that encrypt and decrypt your data. In this way, you control the chain of keys that encrypt your data. If you want to generate or manage keys outside of Salesforce, you can also use Bring Your Own Key (BYOK) or Shield External Key Management (EKM).
Set Up Your Encryption Policy: An encryption policy is your plan for encrypting data with Shield Platform Encryption. You can choose how you want to implement it. For example, you can encrypt the entire transactional database using Database Encryption. If you want advanced key management, you can use field-level encryption to encrypt individual fields and apply different encryption schemes to those fields. Or you can choose to encrypt other data elements such as files and attachments, data in Chatter, or search indexes. Remember that encryption is not the same thing as field-level security or object-level security. Put those controls in place before you implement your encryption policy.
What Other Fields Can I Encrypt?: In addition to standard and custom field data and files, Shield Platform Encryption supports encrypting fields in the Salesforce B2B Commerce managed package, and custom fields in installed managed packages.
What You Can Encrypt: Shield Platform Encryption provides key management and encryption options that help you meet compliance and regulatory requirements. It also adds extra protection to data stored at rest. You can opt for Database Encryption that encrypts most data within your transactional database. For more targeted protection and granular key management control, use field-level encryption (FLE) on individual standard and custom fields.
Behind the Scenes: The Shield Platform Encryption Process for Tenant Secrets: With field-level encryption, when users submit data, the application server looks for the org-specific data encryption key (DEK) in its cache. If it isn’t there, the application server gets the encrypted tenant secret from the database and asks the regional key management server (KMS) to derive the key. The Shield Platform Encryption service then encrypts the data on the application server. If you opt out of key derivation or use either the External Key Management Service or the Cache-Only Key Service, the encryption service applies your customer-supplied data encryption key directly to your data.
Learn About Encrypting Event Bus Data: Protect event messages and Change Data Capture (CDC) events at rest with Shield Platform Encryption. The event bus stores event and CDC data in temporary files as it flows through integrations and real-time processes. Turning on Event Bus Data encryption makes sure that event bus data in these temporary storage locations is fully encrypted.
Encrypt Event Bus Data: To enable encryption of change data capture or platform event messages at rest, generate an event bus tenant secret and then enable encryption.
Manage Field-Level Encryption from the Shield App: Set up and maintain your Field-Level Encryption (FLE) policy from the Shield app. Assess the impact of encrypting fields, turn encryption on or off, and update your encryption schemes as needed.
Use Encrypted Data in Formulas: Use custom formula fields to quickly find encrypted data. Shield Platform Encryption is compatible with several operators and functions, and can render encrypted data in text, date, and date/time formats, and reference quick actions.
How Key Material Is Stored: The critical components of the Security Platform Encryption architecture—the KDF secrets, KDF salt, wrapping keys, and DEKs—are secured using a tiered structure that incorporates wrapped keys, signing, and key derivation.
Shield Platform Encryption in Hyperforce: Shield Platform Encryption operates in parallel with volume-level encryption. By default, Hyperforce provides volume-level encryption for data at rest. Volume-level encryption protects all the data on a disk with one encryption key, which Salesforce owns and manages. With Shield Platform Encryption, you can encrypt your data in Hyperforce with unique keys that you control and manage. Also, if your org is on Hyperforce, you can use Database Encryption to encrypt the entire transactional database.
Back Up Your Tenant Secrets: Your Shield Platform Encryption tenant secret is unique to your org and to the specific data to which it applies. Salesforce recommends that you export your tenant secret to ensure continued access to the related data.
Work with Salesforce Key Material: With Shield Platform Encryption, you can generate unique tenant secrets, root keys, and DEKs. You can also generate key material using your own external resources. In either case, you manage your own key material: you can rotate it, archive it, and designate other users to share responsibility for it.
Encrypt Custom Fields in Installed Managed Packages: If an installed managed package supports Shield Platform Encryption, you can encrypt custom fields in that package. Turn on encryption for custom fields in installed managed packages from the Encryption Settings page, and then apply encryption to custom fields in your installed managed package.
Why Isn't My Encrypted Data Masked?: If the Shield Platform Encryption service isn't available, you can mask data in some types of encrypted fields. Masking data helps you troubleshoot encryption key issues, not control user access to data. If you have data that you don't want some users to see, revisit those users' field-level security settings, record access settings, and object permissions.
Synchronize Your Data Encryption with the Background Encryption Service: Periodically, you change your encryption policy. Or you rotate your keys. To get the most protection out of your encryption strategy with Shield Platform Encryption, synchronize new and existing encrypted data under your most recent encryption policy and keys. You can do this yourself or ask Salesforce for help.
Apply Encryption to Fields Used in Matching Rules: Matching rules used in duplicate management help you maintain clean and accurate data. To make fields encrypted with Shield Platform Encryption compatible with standard and custom matching rules, use the deterministic encryption scheme.
Switch Between Probabilistic and Deterministic Encryption: If you are already encrypting fields using the probabilistic encryption scheme, and have decided to switch one or more of them over to deterministic encryption you should consider your options and plan carefully.
Onboard Database Encryption after Enabling Field-Level Encryption: If you have been using FLE, and have decided to take advantage of the benefits of Database Encryption, decide whether you still need to use FLE. Database Encryption will cover all standard and custom fields that you can configure with FLE without any issues with filtering and sorting.
Onboard External Key Management: With External Key Management (EKM), you encrypt data in Salesforce with key material housed in an external key management service (KMS). If you currently use a Salesforce-generated root key or DEK, you can switch to EKM for supported data stores and categories. Shield EKM supports field-level encryption and encryption for data in Data 360, the event bus, and search indexes.
Onboard Search Index Encryption: Search is a feature integrated into your Salesforce org. Search index encryption supplies encryption keys specifically for your search indexes, protecting any sensitive information within them. You can turn it on and off at any time. You can also rotate the root key, data encryption key (DEK), or tenant secret.
Onboard BYOK: Switch from Salesforce-generated keys to Bring Your Own Key (BYOK) for Shield Platform Encryption.
Onboard Database Encryption: Database Encryption will give you sufficient encryption coverage for your org's data in Salesforce's transactional database.
Onboard Field-Level Encryption: FLE enables you to apply fine-grained encryption to standard and custom fields. You can use FLE with or without Database Encryption enabled.
Onboard to Shield Platform Encryption: There are several situations that can affect onboarding to the different Shield Platform Encryption features. These depend on the encryption policies you have adopted, and whether you already are using one or more Shield Platform Encryption features.
Strengthen Your Data’s Security with Shield Platform Encryption: Shield Platform Encryption gives your data a whole new layer of security while preserving critical platform functionality. You can encrypt sensitive data at rest, not just when transmitted over a network, so your company can confidently comply with privacy policies, regulatory requirements, and contractual obligations for handling private data.
Learn About Encrypting Files and Attachments: Shield Platform Encryption adds extra protection to sensitive data contained in files and attachments. As a result, documents, images, and other files uploaded to Salesforce remain encrypted. When you turn on encryption, the body of each new file or attachment is encrypted as it's uploaded to the platform.
Which User Permissions Does Shield Platform Encryption Require?: Assign permissions to users according to their roles regarding encryption and key management. Some users need permission to select data for encryption, while other users require combinations of permissions to work with certificates or key material. Enable these permissions for user profiles just like you do for any other user permission.
Platform Encryption Q&A: Here are some frequently asked questions about platform encryption.
Differences Between Probabilistic and Deterministic Encryption: In Shield Platform Encryption, probabilistic encryption randomizes the ciphertext output each time the same plaintext is encrypted. This enhancing security by making patterns harder to discern but it also prevents filtering or exact-match searches on encrypted data. Conversely, deterministic encryption always produces the same ciphertext for a given plaintext. This allows for filtering, sorting, and equality comparisons on encrypted fields, but with a slight reduction in randomness compared to probabilistic encryption.
Rotate Your Encryption Key Material: You control the lifecycle of your data encryption keys by controlling the lifecycle of your key material. Salesforce recommends that you regularly generate or upload new Shield Platform Encryption key material. When you rotate key material, you replace it with either Salesforce-generated key material or key material that you supply.
How Shield Platform Encryption Works in a Sandbox: Refreshing a sandbox from a production org creates an exact copy of the production org. If Shield Platform Encryption is enabled on the production org, all encryption settings are copied to the sandbox, including tenant secrets created in production. This is true for all Shield Platform Encryption features.
Encrypt Search Index Files with a Tenant Secret: In orgs that don't yet use the updated search index framework, use a tenant secret in the search index encryption process. Sometimes you must search for personally identifiable information (PII) or for data that’s encrypted in the database. When you search your org, the results are stored in search index files in plaintext — a potential vulnerability. You can encrypt these search index files with Shield Platform Encryption, adding another layer of security to your data.
Generate a Search Index Data Encryption Key: In Hyperforce orgs, create the search index encryption data encryption key (DEK) from the Key Management page in Setup. DEKs are secured with Salesforce root keys.
Encrypt Search Index Files with a Root Key: In orgs that use the updated search index framework, you use a DEK that’s secured by a root key in the search index encryption process. Sometimes you must search for personally identifiable information (PII) or for data that’s encrypted in the database. When you search your org, the results are stored in search index files in plaintext — a potential vulnerability. You can encrypt these search index files with Shield Platform Encryption, adding another layer of security to your data.
Behind the Scenes: The Search Index Encryption Process: Salesforce's search engine, powered by Apache Solr and Apache Lucene, organizes record data in a scalable, partitioned search index. Search Encryption secures org-specific search index files (.fdt, .tim, and .tip file types) using a unique AES-256 bit key. This encryption happens at the segment level, ensuring all index operations in memory are encrypted. Access to the encrypted search index and key cache is strictly via programmatic APIs.
Learn About Search Indexes: Except for Data 360, Salesforce products use traditional keyword indexing and store these keywords at rest in search index files. Shield Platform Encryption Add another layer of defense for personally identifiable information (PII) or other sensitive data that users search for. Encryption keeps tokenized search indexes unreadable to unauthorized parties if the indexes are compromised.
Manage Field-Level Encryption from Setup: Set up and maintain your Field-Level Encryption (FLE) policy from the Encryption Settings page in Setup. As a Shield Platform Encryption feature, FLE supports custom fields in Lightning Experience, in Salesforce Classic, and in installed managed packages. Salesforce plans to retire Field-Level Encryption from the Setup UI in Winter ’27. For an improved experience, manage Field-Level Encryption from the Shield app instead.
Key Management and Rotation: With Shield Platform Encryption, you control and rotate the key material used to encrypt your data. You can use Salesforce to generate a tenant secret for you, which is then combined with a primary secret for each release to derive a data encryption key. This derived data encryption key is then used in encryption and decryption functions. You can also use the Bring Your Own Key (BYOK) service to upload your own key material. Or you can store your key material outside of Salesforce. Use the External Key Management Service or the Cache-Only Key Service to fetch your key material on demand.
Which Standard Fields Can I Encrypt?: With field-level encryption, you can encrypt certain fields that you select on standard and custom objects. With some exceptions, encrypted fields work normally throughout the Salesforce user interface, business processes, and APIs. If you use Database Encryption, all standard fields are encrypted.
Get Statistics About Your Encryption Coverage: The Encryption Statistics page provides an overview of all data encrypted with Shield Platform Encryption. This information helps you to stay on top of your key rotation and management tasks. You can also use encryption statistics to identify which objects and fields you may want to update after you rotate your key material.
Gather Encryption Statistics: The Encryption Statistics and Data Sync page shows you how much of your data is encrypted by Shield Platform Encryption, and how much of that data is encrypted by active key material. Use this information to inform your key rotation actions and time lines. You can also use the Encryption Statistics page to collect information about the fields and objects you want to synchronize with the background encryption service.
Sync Data with Self-Service Background Encryption: Synchronizing your data with your active key material keeps your encryption policy up to date. You can sync data in standard and custom fields, the Attachment—Content Body field, and for field history and feed tracking changes from the Encryption Statistics and Data Sync page in Setup. To synchronize all other encrypted data, contact Salesforce Customer Support.
Interpret and Use Encryption Statistics: The Encryption Statistics page in Setup offers a snapshot of your encrypted data. Use this information to make informed decisions about managing your encrypted data.
Learn About Database Encryption: Database Encryption is available to all Hyperforce customers with a Shield or Shield Platform Encryption license. You can encrypt most of your data without impeding filtering, sorting, or impeding the many Salesforce features that rely on sorting and filtering. Because most of your data is encrypted by default with a tenant-specific key, Database Encryption helps you meet your compliance and regulatory requirements with minimal effort.
Learn About Encrypting Standard and Custom Fields: With Field Level Encryption (FLE), you choose the specific fields that you want to protect with Shield Platform Encryption. You can encrypt standard and custom fields that are compatible with the Shield Platform Encryption service with key material that you control.
Database Encryption Process: Salesforce's Database Encryption operates at the fragment level, encrypting and decrypting data in chunks, typically 64KB or smaller.
Turn On Database Encryption: You can choose to implement the broadest protection of your data by encrypting the entire transactional database. With database encryption, all data in the transactional database is encrypted at the data tier level.
Database Encryption Tradeoffs: Database Encryption provides you with a way to secure your entire transactional database. Even so, there are some compromises to accept if you use it.
Shield Platform Encryption Key Material Types: Encrypt data with either tenant secrets, a key pair composed of a root key and a data encryption key (DEK), or a DEK that you upload. Each type of key material targets specific data stores within Salesforce. You can apply different key-rotation cycles or key-destruction policies to different keys based on the kinds of data that they encrypt.
Turn Off Encryption For Standard and Custom Fields: When you turn off Field-Level Encryption, Salesforce mass-decrypts the associated field values automatically. Any functionality that was limited or unavailable due to encryption gets restored.
Generate a Tenant Secret with Salesforce: For new customers and admins setting up field-level encryption, generate your first probabilistic and deterministic tenant secrets from the Encryption Settings page. You can also generate any tenant secret from the Key Management page.
Fix Compatibility Problems: When you select fields or files to encrypt with Shield Platform Encryption, Salesforce automatically checks for potential side effects. The validation service then warns you if any existing settings may pose a risk to data access or your normal use of Salesforce. You have some options for how to clear up these problems.
Differences Between Classic Encryption and Shield Platform Encryption: Shield Platform Encryption offers two paths toward encrypting data: Field-Level Encryption and Database Encryption. Both offer control over key material and encrypt a broader range of data than Classic Encryption. Each Shield Platform Encryption option offers different data coverage, key management options, and support for functionality such as filtering and sorting. Use the comparison table in this article to help you decide which option best meets your encryption requirements.
Work with External Key Material: So you can maintain more complete control over your key material, Salesforce offers you three options: BYOK (Bring Your Own Key), EKM (External Key Management), and the Cache-Only key service.
Platform Integration User: The Platform Integration User, sometimes called the System User, is an internal, API-only user that integrates features across Salesforce. This user allows Salesforce applications to securely access data on different properties.
Help Users Register MFA Verification Methods for Direct Login: Multi-factor authentication (MFA) is required to access production and sandbox orgs. To log in, users must have at least one registered identity verification method that they provide in addition to their username and password. If they haven’t set up a verification method, they’re prompted to register one for MFA when they log in. The registration process connects a verification method to the user’s Salesforce account. Each user must complete this step themselves — Salesforce admins can’t do it for them. But you can head off confusion and support tickets but making sure your users understand what they must do.
Disconnect a Third-Party Authenticator App from a User’s Account (Salesforce Orgs): Only one third-party authenticator app that generates time-based one-time passwords (TOTP) codes can be connected to a user’s account at a time. If a user loses or replaces the device where their TOTP authenticator app was installed, you can disconnect the app from their account. If a user’s app stops working, reset it by disconnecting the app; then ask the user to restore the app’s connection to their account by re-registering it. It’s also a good security practice to disconnect all of a user’s verification methods if they leave your company.
Multi-Factor Authentication for API Access: Salesforce doesn't require multi-factor authentication (MFA) for integration login types via the API. But you can add extra protection for API access with the Multi-Factor Authentication for API Logins permission. With this permission, you require users to complete a second authentication challenge to access Salesforce APIs. API access includes the use of client apps such as the Data Loader and connected apps.
Review Your Security Health: Review your security configuration and get recommendations to identify and address potential vulnerabilities.
Secure Your Salesforce Org: Salesforce builds security into every layer to protect your data and applications, but security is a shared responsibility. Configure authentication and access controls so your users work securely. Then set up essential protections and monitor your org's health.
Session and Browser Security: After users log in, their sessions and browser interactions become potential targets for attack. Configure session security settings, protect against clickjacking, and manage allowlists for external URLs and origins. Then review the cookies that Salesforce Platform uses to improve functionality and accelerate processing times.
User Session Types: Learn about the session types in the User Session Information page to help you monitor and protect your org.
Protect Sensitive Information in Your URLs: To protect sensitive information in your URLs, such as an org ID, enable the referrer-policy HTTP header. When an action in Salesforce makes a request to another URL, the website receiving that request can see information about the origin. For example, when a Salesforce page loads an image, the website where the image lives can see the URL of that Salesforce page. And when you click a link, the website that you visit can see the URL of the Salesforce page where the link lives. The referrer-policy HTTP header controls how much of that URL, or referrer, is shared during that request.
Balance Data Security with Business Needs: Choosing to store PII, sensitive, confidential, or proprietary data with any third party often prompts customers to more closely investigate external regulatory and internal data compliance policies. Internal policies frequently rely on interpretation of external regulations.
Bring Your Own Key (BYOK) Option: With BYOK, customers can bring key material from outside of Salesforce. They generate key material by using their own crypto libraries, enterprise key management system, or hardware security module. Customers can encrypt it with a self-signed or certificate authority (CA) certificate’s public key. They upload the keys to Shield Platform Encryption. They can revoke access on demand via the Key Management tooling in Setup or programmatically via the API.
BYOK Tenant Secret Flow: To supply your own tenant secret, you create the secret, sign it with a BYOK-compatible certificate, and encode it with base64 encoding.
Cache-Only Key Flow: With Field-Level Encryption (FLE), you can insert a final data encryption key into the encrypted key cache. You supply a cache-only key as an encrypted JWE JSON file, wrapped with your content encryption key.
Cache-Only Keys Option: Customers can create and store a DEK outside of Salesforce and use Cache-Only Keys to apply that DEK to data in Salesforce. Customers can use an on-premises key service, host their own cloud-based key service, or use a cloud-based key brokering vendor. Root keys and named principals are supported. DEKs are fetched on demand over a secure channel that the customer configures. Salesforce-generated DEKs are wrapped with a cache key encryption key and placed directly in the encrypted key cache for encrypt and decrypt operations. DEKs generated by an external KMS are wrapped by the generating root key, and they’re unwrapped by that same root key when needed.
Application Tier and Data Tier Encryption: Application tier encryption refers to encryption for specific Salesforce features, such as Field-Level Encryption, Chatter, Event Bus Data, and CRM Analytics data. The at-rest data for each features is encrypted using a feature-specific data encryption key (DEK). Encryption at the Data tier refers to encryption at the underlying data level, such as with Database Encryption. It covers everything in the transactional database, regardless of which feature makes use of the data.
Customer Managed Key Options: Shield Platform Encryption provides two main ways for managing key material. It can generate your tenant secrets and other key material for you and store them securely within the Salesforce database. Or if you want, you can provide key material from an outside source instead:
Customers Can Supply Their Own Key Material with EKM, BYOK, and Cache-Only Keys: Customers can supply their own key material by using External Key Management (EKM), Bring Your Own Key (BYOK), or Cache-Only Keys. Each offers customers different levels of control over key material. Further, each has different setup requirements. With BYOK, customers can upload tenant secrets and data encryption keys outside of Salesforce by using their own crypto libraries, enterprise key management system, or hardware security module. With EKM and Cache-Only Keys, customers can supply their own DEKs.
Database Encryption Happens in the Data Tier: The Lightning Platform’s foundation for Database Encryption is a fragment-driven architecture that supports multitenant transactional operations. It encrypts within the data tier.
Encrypted Information Flow with Key Derivation: When attempting to read or write encrypted data, if the DEK isn’t already in the encrypted key cache, the encryption service transmits the request to the regional Shield KMS to retrieve it. For content encrypted at the application tier, such as FLE, the KDF derives a DEK by using the KDF secret, KDF salt, and customer tenant secret. The derived data encryption key is returned to the encryption service.
Data Encryption Key Derivation: Shield Platform Encryption uses the Shield Key Management Service to derive DEKs for encrypting customer data at rest. DEKs are derived from partial key secrets that are securely wrapped and stored in the Shield KMS. Key derivation ensures that the derived keys are never persisted in their composite forms, and it enables customers to control the key lifecycle.
Disaster Recovery and Key Management: You have control over the lifecycle of your encryption keys and tenant secrets. Salesforce provides several options for key material, including Salesforce-generated keys, Bring Your Own Key (BYOK), External Key Management (EKM), and the Cache-Only Key service. Salesforce strongly recommends that you regularly rotate your key material to align with security policies.
External Key Management Flow: For EKM, Shield Platform Encryption relies on the customer’s external KMS to generate and secure the DEKs used by the Shield Platform encryption service. These DEKs reside with the Shield Platform encrypted key cache in a wrapped state. When encryption or decryption operations are needed, the appropriate DEK is unwrapped by the external KMS. The customer key service then sends the unwrapped DEK securely back to the Shield Platform encryption service, which stores it in the Salesforce encrypted key cache. Encryption and decryption operations then use the cached DEKs.
Tenant Secrets, Root Keys, DEKs, and More: Central to encryption are the secrets and keys that the platform uses to encrypt and decrypt data. Throughout this guide, we refer to nearly a dozen types of secrets, materials, and keys that participate in the Shield Platform Encryption process. Before reading further, it’s helpful to understand how these parts relate to each other. A glossary at the end of the guide defines all the different secrets and material types that we discuss.
External Key Management (EKM) Option: EKM provides the ability to set up and configure keys within supported public cloud key management services controlled by the customer, for use by Salesforce as permitted by the customer. After the wrapped DEKs are in place, they’re used like any other Shield Platform Encryption DEK. When they’re needed, Shield Platform Encryption sends the wrapped DEK to the external KMS via TLS and requests that it unwrap the DEK. The unwrapped DEK is returned to Shield Platform Encryption via TLS and placed in the encrypted key cache. The DEK is cached for a limited time and never persisted as plain text.
Shield Platform Encryption Process Flow for Application Tier Encryption: Before data is encrypted, a Salesforce administrator must enable encryption and generate or supply key material. For the each field, file, attachment, and data element on which encryption is enabled in the application tier, the corresponding metadata in the UDD is updated to reflect the new encryption setting.
Fundamental Concepts in Shield Platform Encryption: Salesforce Shield Platform Encryption is an advanced security feature that provides at-rest encryption for sensitive data. At its core, the platform uses a system of secrets, keys, and cryptographic materials to secure data. The main component is the data encryption key (DEK), which is the key that directly encrypts your data. By default, Salesforce uses a derivation function to derive DEKs from a set of key materials. We ensure that plaintext DEKs are never written to disk. These DEKs are instead derived on demand and stored in a secure cache.
Keys and Secrets: Shield Platform Encryption uses a hierarchy of secrets, key materials, and fragments to ensure the highest encryption service.
How Shield Platform Encryption Works: Shield Platform Encryption meets the security requirements of customers while preserving functionality and performance in our multitenant environment. To make this happen, we provide encryption features in two separate tiers: in the application tier with FLE and in the transactional data tier with Database Encryption.
Implementation and Ongoing Management: As with any enterprise-wide activity, you should assess the preparations and repercussions of implementing Shield Platform Encryption prior to enabling it. Thorough planning, feature selection, and planning increase the likelihood of a smooth adoption.
HSM Initialization: A Hardware Security Module (HSM) must be initialized before it’s used. For the primary HSM, initialization creates a primary HSM encryption key pair and a primary HSM signing key pair. For each regional HSM, initialization creates a regional HSM encryption key pair.
Key Derivation Architecture: Secrets and secret-wrapping keys used in the key derivation process are initialized by the HSM in the primary Shield KMS at the start of each release. For customer-provided tenant secrets, they’re initialized on demand in production environments by the HSMs in the regional Shield KMSs.
Key Generation and Management Architecture: We use traceable and secure methods for creating key material. This section explores the architecture behind Salesforce's key generation and management, emphasizing the security of encryption keys. It details how Salesforce uses highly secure and traceable processes, including a Hardware Security Module (HSM) and a Key Escrow Server, to generate and manage cryptographic key material.
Key Management for Database Encryption: Database Encryption provides you with the ability to rotate your database tenant secret after it’s listed on the Key Management page. Deleting database tenant secrets isn’t permitted.
Key Management for Application Tier Encryption: With Shield Platform Encryption, Salesforce administrators can manage the lifecycle of their data encryption keys while protecting those keys from unauthorized access. To ensure this level of protection, data encryption keys are never persisted in plain text. If a customer has opted out of key derivation, then a wrapped DEK is persisted, but must be unwrapped by the regional Shield KMS or external KMS.
Data Encryption Keys (DEKs): The Shield Platform Encryption services can use three types of DEK: derived, root key created, or customer supplied. All have AES-256 bit strength. Derived DEKs and DEKs supplied by the customer aren’t persisted, but exist only in the encrypted key cache. Root key created DEKs are wrapped by the root key and stored in the database and unwrapped by the same root key when needed.
Encryption Monitoring And Backup: Along with the many encryption options that we provide with Shield Platform Encryption, we also make it easy to review the state of your encryption landscape. We also provide a facility to bulk encrypt data when you start using a new encryption feature, or after you have rotated an encryption key.
Moving to Shield Platform Encryption: The process of onboarding to Shield Platform Encryption requires a methodical, phase-based approach, as encryption applies to different data stores using distinct keys. The initial steps involve determining your encryption scope, classifying sensitive data, and setting up the foundational encryption policies. We recommend you make use of developer orgs and production sandboxes before rolling out any of the Shield Platform Encryption features.
On-Demand Tenant Secret Generation: Customers can generate or upload key material every 24 hours in their production or Developer Edition orgs, and every 4 hours in sandbox orgs. Field-Level Encryption key material can be destroyed at any time. When a customer generates new key material, all future data is encrypted with the new final data encryption key (DEK). This DEK is derived by default. Customers can opt out of derivation and supply their own DEK.
Performance Considerations: Encrypting data with Shield Platform Encryption has minimal impact on the day-to-day performance of Salesforce for users. Salesforce recommends testing Shield Platform Encryption in a full copy sandbox under real-world conditions before enabling it in a production org.
Salesforce Shield Platform Encryption Architecture: Salesforce Platform Encryption protects customer data by encrypting various data elements within the Salesforce platform, including fields, search indexes, and the database itself. This encryption provides you with enhanced data security and can help you meet compliance requirements.
Before You Encrypt: Before you encrypt data in Salesforce, or in any cloud service, first make sure that you’re matching the right security solution to the type of threats that you face.
Salesforce Encryption Principles: To balance security demands with customers’ functional requirements, Salesforce defined a set of principles that drove our solution design and architecture decisions. We focused on the problems that we wanted to solve, clearly defined the boundaries of our solution, and identified the implications and tradeoffs of the design.
Root Key Wrapping: Some of the Shield Platform Encryption features, like Search Index Encryption, make use of a customer controlled root key for DEK wrapping.
Search Encryption at Rest Process Flow: The Salesforce search engine is built on the open-source enterprise search platform software Apache Solr. The search index, which stores tokens of record data with links back to the original records stored in the database, is housed within Solr. Partitions divide the search index into segments to allow Salesforce to scale operations. Apache Lucene is used for its core library. Because of this, the Search content is technically outside of the application tier and has its own process flow.
Per-Release Secret Generation and Export: At the start of each release, a Salesforce cryptographic security officer conducts a High Assurance Virtual Ceremony (HAVC) to generate the per-release secrets and keys. Once created, the secrets are sent to the regional Shield KMSs.
Secure Secret Material Generation via HSM and Primary Keys: Your data may be encrypted, but unless your encryption keys are generated and stored securely, your data is still vulnerable. Salesforce uses a highly secure and traceable process for generating its primary keys and your tenant secrets. New primary keys are generated regularly, and all key material is securely stored in key management servers.
Shield KMS Startup: When the regional Shield KMS starts up in a production environment, it accesses each release’s encrypted secrets stored in the regional KMS. It then stores them in the encrypted key cache in preparation for deriving data encryption keys.
What Gets Encrypted?: You can encrypt a variety of fields, files, and data with Shield Platform Encryption. Salesforce uses metadata to keep information in these files and fields secure while preserving the ability to perform common business tasks.
What Is Encrypted with Chatter Encryption?: Chatter Encryption is an application tier encryption that covers data in feed posts and comments, questions and answers, link names, and URLs. It also includes poll choices and questions and content from your custom rich publisher apps.
What is Encrypted with Database Encryption?: Database Encryption encrypts the entire transactional database. All data stored within the database is encrypted to include standard and custom entities, all metadata, all setup configuration data, chatter posts, Einstein data, transaction logs, and storage catalogs.
What is Encrypted with Event Change Data Encryption?: The event bus may store event and CDC data in temporary files as it flows through integrations and real-time processes. Turning on Event Bus Data encryption ensures that event bus data in these temporary storage locations is fully encrypted.
What is Encrypted with Files and Attachments Encryption?: Shield Platform Encyrption encrypt all files and attachments uploaded into Salesforce. The body of each file is ecrypted. If you have enabled Database Encryption, files and attachments smaller than 32K in size are stored directly within the transactional database and are under its encryption protection. Larger files are always stored as encrypted binary objects in a separate content store.
What is Encrypted with Field-Level Encryption?: In contrast to Classic Encryption, which uses a custom field type in the Salesforce data model, Shield Platform Field-Level Encryption makes more fields, files, and data elements available for encryption with every release.
What is Encrypted with Search Index Encryption?: The Salesforce search engine is built on the open-source enterprise search platform software Apache Solr. The search index, which stores tokens of record data with links back to the original records stored in the database, is housed within Solr.
Why Encrypt: Security and trust are major factors in every company’s evaluation of public cloud services. Salesforce customers choose which business functions to run on the Salesforce Platform, which applications they can build to extend those functions, and what data they must store to enable those functions.
SMS Identity Verification: Understand how and when users can verify their identity with one-time passcodes sent via text messages (SMS).
Additional Salesforce Security Customizations: Salesforce offers other security products and features that address more complex security and compliance requirements. Use these features for more advanced or stringent data handling and residency, monitoring, and security scenarios. These solutions, some available at an additional cost, work in partnership with the security tools available to every admin.
Generate a Temporary Verification Code for MFA Logins to Salesforce Orgs: If a user forgets or loses the identity verification method that they use for multi-factor authentication (MFA), generate a temporary verification code so they can log in while you sort out the issue. You can control how long codes are valid, up to 24 hours. A user can log in multiple times with their code until it expires. Temporary verification codes are valid for MFA only. They can’t be used for device activation, when a user must verify their identity because they’re logging in from an unrecognized browser or app.
Protect Your Org with Updated CSP Directives: To help protect your org from cross-site scripting and other code-injection attacks, Salesforce updated the delivered content security policy (CSP) directives for Lightning pages in Summer ’24. If your production org was created before June 2024, enable a setting to adopt the latest directives.
Manage Trusted URL and Browser Policy Violations: To protect your users, two allowlists specify the URLs that you trust to load resources in Salesforce and the trusted URLs for redirections. Review blocked redirections and the resource requests that your content security policy (CSP) directives blocked. Then, to allow the required resources, update your trusted URLs.
Identify Cross-Org Urls to Allow for Redirections: To protect your users from potential attacks, users aren’t redirected to a different Salesforce org from your Salesforce org unless the URL is trusted. This limitation includes redirections to the second org’s publicly served pages and content. To allow a link, action, or process to redirect the user to a different Salesforce org that you own, add the target URL to the Trusted URLs for Redirects allowlist.
Secure External Redirections from Hyperlinks in Salesforce: After you populate the Trusted URLs for Redirects allowlist, protect your users from redirections to untrusted URLs. You can warn block redirections that originate from a hyperlink in Salesforce or warn users during those redirections.
Specify Trusted URLs for Redirections: Help your users access external and cross-org URLs via redirections. Add your trusted URLs to the Trusted URLs for Redirects allowlist. Redirections from Salesforce to URLs in that allowlist are always allowed without a warning.
Test External Redirections: After you update your Trusted URLs for Redirects allowlist, verify that the corresponding redirections are allowed.
External Redirection Restrictions in Salesforce: Learn what qualifies as a redirection in Salesforce, when those redirections are blocked, and your options for allowing and restricting redirections.
Manage Trusted URLs: Specify the URLs that you trust to interact with your users and network. Use Content Security Policy (CSP) directives to control the types of resources that Lightning components, third-party APIs, and WebSocket connections can load from each trusted URL. If you enabled the Permissions-Policy HTTP header in Session Settings, you can also control which URLs can access browser features from Salesforce.
Enable Security Keys for Identity Verification in Salesforce Orgs: Security keys are small physical devices, such as YubiKeys or Titan keys, that users can use to set up passkeys for secure multi-factor authentication (MFA). With MFA enforcement, Salesforce automatically enables security keys as an available verification method for all employee users. When MFA is enforced in your org, you can't turn off this setting. If MFA isn't enforced yet in your org, turn on security keys to test them. Security keys satisfy the phishing-resistant MFA requirement for users with privileged permissions. Users can also use security keys to complete other identity verification challenges, such as device activation.
Register a Security Key as an Identity Verification Method for Salesforce Orgs: Register a physical security key so you can use it to verify your identity when logging in with multi-factor authentication (MFA) or if you receive a device activation challenge. You can use security keys that support the WebAuthn (FIDO2) or Universal Second Factor (U2F) standards. The registration process sets up your security key as a personal verification by creating a connection between your Salesforce account and the key. If you don’t see this option, talk to your Salesforce admin about enabling it.
Disconnect a Security Key from a User’s Account (Salesforce Orgs): Users can register only one WebAuthn (FIDO2) or Universal Second Factor (U2F) security key with their Salesforce account at a time. If a user loses or replaces their security key, you can disconnect the original key from their account. If a user’s security key stops working, reset it by disconnecting the key; then ask the user to restore the key’s connection to their account by re-registering it. It’s also a good security practice to disconnect all of a user’s verification methods if they leave your company.
Security Alerts: Release updates have replaced security alerts. Information about previously released security alerts can be found in the Release Updates node.
Manage User Access: Salesforce provides a layered approach to user access so that you can control what data users can see and what tasks they can perform.
User and API Access: Learn about giving users and APIs access to your Salesforce org and data.
User Authentication and Identity Verification: User authentication and identity verification work together to protect access to Salesforce. User authentication asks users to establish their identity with credentials, such as a username and password. Identity verification is when a user demonstrates ownership of their account by providing evidence, such as a verification code that only the user knows. Protect access to Salesforce with secure authentication and identity verification features such as multi-factor authentication (MFA), single sign-on (SSO), and passwordless login with passkeys.
User Authentication: Authentication protects access to Salesforce by making sure that users are who they say they are. Enhance security for direct Salesforce logins with features such as multi-factor authentication (MFA), passwordless login with passkeys, certificate-based authentication, and Lightning Login. Use single sign-on (SSO) to enable users to log in to Salesforce from a third party, such as Google.
User Email Address Verification: Users can’t send outgoing email from Salesforce until their Salesforce email address and return email address are verified. Learn how to identify users with unverified email addresses and help them complete this required step.
Enable Salesforce to Send Email: Before Salesforce can send email on behalf of your users, domain-level and user-level verification is required. Salesforce admins verify the domains that you own, and users verify their email and return email addresses.
Determine How to Verify Your Email-Sending Domains: To send email from Salesforce on domains that you own, verification is required for each of your email-sending domains. Determine the best method to verify your email domains: DomainKeys Identified Mail (DKIM), authorized email domains, or both options.
Send Email for Users with Unverified Domains: Enable Salesforce to send email for users with email domains that you can't verify, such as site users, consultants, and users with public email addresses like yahoo.com or icloud.com. With these options, the user's display name and reply-to address remain unchanged, but the From address uses an organization-wide email address or site-specific sender address of your choice.
View User Session Information on the Session Management Page: Monitor and protect Salesforce by reviewing active sessions and session details on the Session Management page in Setup. You can create custom list views, view details about a user associated with a specific session, and easily end suspicious sessions. Salesforce admins can view all active user sessions, and non-admins see only their sessions.
Monitor Identity Verification History: Use Identity Verification History to monitor and audit up to 20,000 records of your org users’ identity verification attempts from the past 6 months. For example, when a user successfully provides a time-based, one-time password (TOTP) as proof of identity during multi-factor authentication (MFA), that information is recorded in Identity Verification History.
Send Back-in-Stock Notifications: Let shoppers register their interest in out-of-stock items. Send personalized messages when the item is available. Gain insights into the popularity of products.
Send Survey Invitations Using Flows: Use Flow Builder to automatically email survey invitations to leads, contacts, and users in your org based on a condition, such as when a customer support case closes. While flows send survey email invitations by default using the standard Salesforce email service, which has daily sending limits, you can also send them directly through Marketing Cloud. This is an ideal use case when you need to send a high volume of survey email invitations, as it allows you to reach a wider range of audience and exceed the 5,000 daily email limit.
Analyze Survey Responses to Get Sentiment Insights: Analyze the sentiment of your customers and get actionable insights to improve it. Sentiment Insights uses the Amazon Comprehend BatchDetectSentiment API with your AWS account to get insights about your customers’ sentiment based on their feedback.
Create an External Credential and a Named Credential: Create an external credential to authenticate the Amazon Web Services (AWS) account that you want to use for analyzing the sentiment of text. Then create a named credential for the external credential.
Service Console for Loyalty Program Members: Customer service representatives (CSRs) can get a comprehensive view of members’ details and activities in one page by using the service console for loyalty program members. CSRs can use the console to proactively engage loyalty program members and resolve their questions, and address their requests, search for relevant knowledge articles, get alerts for related records that need attention, and run actions to resolve member requests. CSRs can also track previous interactions on a timeline and check related records.
See a Service’s Status History: View a timeline of each service’s status, as well as the duration of incidents or maintenance events.
Integrate Service Providers as SAML-Enabled Apps: To configure SAML single sign-on (SSO) with Salesforce as an identity provider, integrate a service provider by using the external client apps framework or the connected apps framework. With this SSO configuration, users log in to the service provider by using the same credentials that they use to log in to your Salesforce org or Experience Cloud site. To change your service provider details, edit your app. Control which users can access your app by managing profiles and permission sets.
Salesforce as an OpenID Connect Identity Provider: Unlike SAML single sign-on (SSO), when integrating service providers with OpenID Connect, or relying party,you don’t enable Salesforce as an identity provider. You can integrate the service provider, as a connected app with OpenID Connect. Your org can then authenticate users so that they can log in to the relying party.
Map Salesforce Users to the SAML Service Provider: To ensure that your SAML service provider can recognize Salesforce users when they log in with single sign-on (SSO), update user information in Salesforce. Provide user identifiers that the service provider recognizes.
Set up Business Rules Engine: Configure your users to use Business Rules Engine and assign permission sets so that the users can access expression sets and lookup tables.
Set IP Allowlist Ranges for Refresh Tokens: To improve security and help protect your Salesforce data from unauthorized access, set an IP range to allow refresh tokens. When you turn on Enforce Refresh Token IP Allowlist, only IPs in allowed ranges can complete the OAuth web server flow or the refresh token flow.
Set Your Preferred Language for Trust Notifications: Set your preferred language for the Trust Status site and for Trust notifications. Supported languages are English, Dutch, German, Portuguese, Japanese, Swedish, Chinese, French, Spanish, Korean, and Italian.
Set Up Experiences for Loyalty Program Members: Create a feature-rich portal for your loyalty program members using the Loyalty Member Portal template. Keep your loyalty members engaged by letting them track their progress in the reward program with the Loyalty Member Portal. With a few clicks, admins can set up the loyalty member portal where program members can view their program details, including recent transactions, current tiers, benefits, points associated with each transaction, and profile details. You can customize the portal based on your company's requirements.
Set Up Heroku External Objects: Provision Heroku Connect, create OData service login credentials, and choose the tables and views you want to expose.
Set Up Loyalty Processes: You can provide an efficient process for customer recognition, rewards, and experiences by setting up end-to-end Loyalty Processes.
Set Up Privacy Center and Connect to Heroku: Use Heroku to securely store your Salesforce data. Get started by installing Salesforce Privacy Center and setting up an archive for data retention.
Set Up Promotions with Data Cloud: To identify and create the right promotions for the right customers, associate promotions with Data Cloud segments.
Set Up Promotions With Campaigns: You can set up and manage promotions with campaign members when you don’t have Data Cloud in your Salesforce org. Use campaigns to identify the right customer segments and send promotional campaigns to these customers. The segments and members are created using Salesforce Reports. Use data extensions with loyalty data and send promotional campaigns to efficiently create and track customer journeys through Journey Builder.
Set Up Your Private Space: Your Private Space is where your customer information is stored and where data synchronization occurs between Heroku and Salesforce. Work with your Salesforce account team to create your Private Space.
Set the Fiscal Year: If your company follows the Gregorian calendar year but you want to change the fiscal year start month, use standard fiscal years. If your company does not observe a standard fiscal year, you can enable custom fiscal years, which define a more complex fiscal year structure.
Set Up Partner Deal Registration: Enable Partner Deal Registration and complete required manual configuration for lead statuses, lead process, record type assignment, and user experiences.
Set Up Price Protection Program: To create a Price Protection program, define pricing terms and benefits, process price protection claims, and enable Price Protection in Setup. When Price Protection is enabled, you can use predefined templates for the data processing engine, context definition, and Business Rules Engine expression sets.
Explore What Setup with Agentforce Can Do: Review all the available features and tasks that Setup with Agentforce supports. Setup with Agentforce can assist with many common administrative tasks in Setup to help streamline your work and increase efficiency.
Considerations for Setup with Agentforce: When using Setup with Agentforce, keep these supported functionality, usage, limitations, and other considerations in mind.
Remove Unused Setup Page Search Metadata: Delete leftover Setup Page Search Metadata artifacts in Data 360 to reclaim storage without affecting the Setup agent.
Formulas in Setup with Agentforce: Use Agentforce to get help with Salesforce formulas. Create, modify, explain, validate, and fix formulas directly within Setup pages.
Setup Information and Navigation in Setup with Agentforce: Use Agentforce to get information sourced from Salesforce documentation directly in the flow of work, with links to relevant Setup pages or Salesforce Go features. You can also get information about setup changes tracked in the Setup Audit Trail. Delete leftover Setup Page Search Metadata artifacts in Data 360 to reclaim storage without affecting the Setup agent.
Setup Home with Agentforce: In Winter ‘26, Setup Home was redesigned to provide a more efficient experience, and enhanced with dedicated tiles from Salesforce Go and more. Agentforce takes that new Home page and gives it an AI upgrade, adding a prompt bar where you can ask questions or enter a prompt to start working with the agent.
Lightning Pages in Setup with Agentforce: Agentforce can create a Lightning page based on the requirements you give it, such as object, page type, required components, and use case. The agent takes the specifications, analyzes them, and proposes the page structure, components, and fields that most closely match them.
Org Health and Usage in Setup with Agentforce: Use Agentforce to get information about your org’s health and usage metrics and explore your metrics with an agent. Org Health and Usage on the Setup page shows metrics for security, performance, trust, usage, and more. Click “Ask Agentforce” to get more details about individual metric health and how to improve it.
Setup with Agentforce: Salesforce's new agent-driven Setup experience streamlines administrative tasks with the help of an AI assistant. Powered by the Atlas Reasoning Engine, its conversational interface allows you to ask questions or give commands using natural language. Activities such as creating objects, Lightning pages, and flows; managing users and user access; and troubleshooting formulas are more efficient and intuitive, with reduced navigation and fewer clicks.
Grant Permissions to Use Setup with Agentforce: Review access requirements for Setup with Agentforce and how to configure this access for users. All users must be assigned permissions to turn on or use the Setup agent.
Set Up Enhanced Conversation Recommendations: By default, Setup with Agentforce conversation recommendations are personalized using your Setup Audit Trail and your Setup agent conversations. To improve your recommendations in searches and agent conversations, turn on Enhanced Conversation Recommendations. This feature collects your page views, CRUDs (create, read, update, and delete actions), and other runtime data, and then exports your insight to Data 360 and the personalization layer to improve Setup agent recommendations.
Use the Prompt Library for Setup with Agentforce: Use ready-made prompts to quickly start a conversation with the Setup agent. You can explore example prompts organized by category, such as user access, flows, and org health, to learn more about Setup with Agentforce capabilities.
Get Started with Setup with Agentforce: Get up and running with Setup with Agentforce by setting up permissions and enabling the feature. See what the Setup agent can do through asking example questions.
Reports and Dashboards in Setup with Agentforce: Use Agentforce to create custom report types to meet your users’ reporting requirements. The agent examines existing report types to find some related to your request. It also proposes the structure of a new custom report type that closely matches your specifications.
User Access Management in Setup with Agentforce: Use Agentforce to troubleshoot user access issues, review the permissions and access that users have, and understand how access is configured.
Collect Debug Logs for Guest Users: Your public users generate a large volume of events, which can quickly fill up your debug logs. When collecting debug logs for guest users, keep in mind that all your public site visitors share one guest user license. One Salesforce user represents all your site's public users.
Allow the Required Domains: To enable your users to access Salesforce, you must add the standard Salesforce domains to your list of allowed domains.
Read-Only Mode: Access to your data at a moment’s notice—even during our planned maintenance windows. To minimize interruption to your business, Salesforce gives users read-only access during splits, instance migrations, instance switches, pre-scripts, and certain other maintenance events.
Manage Users and Data Access: One of the most important administrative tasks is setting up and keeping your users up to date with the permissions and access that they require to perform their everyday tasks. Salesforce provides a variety of features and tools so that you can customize your data access setup for internal and external users.
Monitor Org Health and Usage in Setup: Org Health and Usage in Setup provides insight into the health of your org and opportunities to improve it. The dashboard ranks metrics for security, performance, trust, usage, and more based on severity, so the metrics that need your attention appear first.
Set Up and Maintain Your Salesforce Organization: As a Salesforce administrator—that is, a user assigned to the Administrator profile—you’re responsible for setting up your online organization, which means adding users and configuring the system for your needs.
Plan Your Salesforce Rollout: Before you roll up your sleeves and start setting up Salesforce, take a look at the resources available to help you plan your rollout.
Learn More About Setting Up Salesforce: In addition to online help, Salesforce creates guides and tip sheets to help you learn about our features and successfully administer Salesforce.
Discover and Set Up Features with Salesforce Go: Save time and effort exploring and setting up features with Salesforce Go. With rich filtering, find the exact features and feature sets you want to set up. Access helpful content resources and links to learn about features and get configuration assistance. Discover more features and products that are available based on your Salesforce edition, and quickly purchase add-on licenses for new products.
System Overview: API Usage: The API Usage box in the system overview page shows usage information for API requests in the last 24 hours.
System Overview: Business Logic: The Business Logic box on the system overview page shows usage information for rules, Apex triggers, Apex classes, and code used.
System Overview: Most Used Licenses: The Most Used Licenses box in the system overview page counts only active licenses, and by default shows the top three used licenses for your org. Any license that reaches 95% usage also appears.
System Overview: Portal Roles: The Portal Roles box in the system overview page shows the usage data and limit for total partner portal, Customer Portal, and Communities roles. The system overview page displays a message when your org reaches 95% of its allotted portal roles.
System Overview: Schema: The Schema box in the system overview page shows usage information for custom objects, custom settings, custom metadata types, and data storage.
System Overview: User Interface: The User Interface box in the system overview page shows usage information for custom apps, published Site.com sites, active Salesforce sites, active flows, custom tabs, and Visualforce pages.
Loyalty Management Permissions: Provide permissions to invocable actions, user interface actions, and connect APIs. Use sharing rules to share and control access of loyalty records for users.
Salesforce Shield: Salesforce Shield is a suite of security products that builds extra levels of security, compliance, and governance into your business-critical apps. You can access them through Setup or the Shield app.
Grant Access to Shield: Manage user access to individual Shield products by assigning user permissions.
Platform Encryption Analyzer in Shield Extension: By encrypting sensitive data, you build extra layers of data protection and work toward meeting compliance and regulatory requirements. The Shield Extension managed package includes the Platform Encryption Analyzer, a tool for identifying and assessing fields that are suitable for field-level encryption. It simplifies the encryption process and helps you implement your encryption policies faster.
History Tracking Enhancements in the Shield Extension: The Shield Extension managed package includes Field History Explorer and History Retention Policy Manager features. Each provides detailed insights into data changes. Use these features to conduct thorough audits and quickly take action to resolve any unauthorized activities.
Salesforce Shield Learning Maps: This set of learning maps helps you start using Shield right away and craft auditing, encryption, monitoring, and security analysis solutions.
Use Shield to Meet Auditing and Compliance Requirements: Audits are a critical step in meeting data governance and compliance requirements. Shield and non-Shield features combine to help you track field history, create data retention policies, store event data, and keep tabs on important changes like encryption key rotation.
Encrypt Sensitive Data and Manage Key Material: Learn how to plan and create an encryption policy, and manage encryption keys. Shield Platform Encryption offers varying levels of specificity, ranging from full database encryption to granular field-level encryption. Multiple key management and storage options help you craft a strategy that’s right for you.
Measure Feature Adoption and Performance with Shield: When you implement changes, such as new apps or login flows, it’s good to know how your apps and systems perform. Use Event Monitoring to analyze data, custom Apex class performance, network performance, bulk API actions, and more. For customers who purchase Security Center in addition to Shield, you get visualizations and aggregate data about Shield usage and metrics.
Check in on Your Data (And Who’s Using It): Use Event Monitoring and non-Shield Salesforce tools for an in-depth look into who’s using your data and how. Monitoring not only helps you understand how well your security policies are working, but also how users and systems respond to changes in system settings and company policies.
Quick Start for Salesforce Shield: Set up Shield features and start using them right away. This learning map guides you through how to scan your org for sensitive data, encrypting search indexes with just a few clicks, setting up access to event logs, and creating a prebuilt transaction security policy. You can also see how others are using Shield as part of their broader Salesforce implementation strategy and learn more about Shield features.
Shift Management: Help manage employee shifts efficiently. Scheduling tools—Get Candidates, Batch Assign, and Mass Shift Update—help find the right candidates for shifts based on scheduling rules, constraints, and objectives that you define.
View and Manage Approval Requests: If your admin has set up an approval process for shift assignments, planners can review pending approvals directly from the Schedule Manager.
Approve Time-Off Requests: Stay on top of everyone's schedules. Approve time-off requests by worker or by object type.
Match Qualified Talent Using Skills and Certifications: Create and assign skills that represent certifications and expertise, like Electrician Certification or Tier 2 Support. Assign skills to worker records so scheduling tools match qualified candidates to shifts that require those skills.
Control Workloads Using Scheduling Constraints: Constraints establish maximum boundaries for work hours and shift assignments. Attach constraints directly to individual service resource records or broader service territory records.
Create Shift Templates: Create shifts more quickly with templates. Insert a template of pre-populated fields instead of manually completing fields in the shift creation pane.
Create Shifts in Bulk from a Capacity Plan: In Workforce Management, you can add shifts that your short-term capacity plan predicts as necessary. You can schedule shifts quickly and accurately when you create them directly from your plan. No more cloning shifts one-by-one and tracking how many you still need.
Get Started with Shift Management: Review foundational shift management concepts and licensing requirements early to build a clear understanding of how scheduling tools drive effective operational strategy across your organization.
Manage and View Shift Schedules: View upcoming shifts as a planner or a worker. Planners can switch to the schedule view to see weekly shifts grouped by service territory or job profile in a calendar.
Non-Standard Shifts: Non-standard shifts are shifts not sought by workers for various reasons, such as inconvenient hours or increased workload. Identifying and marking shifts as non-standard helps the planner assign shifts in a more equitable and balanced way, which can reduce worker dissatisfaction and attrition.
Maximize Workforce Efficiency with Shift Scheduling: Help manage employee shifts efficiently. Scheduling tools—Get Candidates, Batch Assign, and Mass Shift Update—help find the right candidates for shifts based on scheduling rules, constraints, and objectives that you define.
Prepare to Use Service Resource Preferences: After you set up service resource preferences, workers can specify the days and times that they want to work. When planners then assign workers to shifts, the scheduling tools take each worker's preference into account.
Set Up Your System and Core Configuration: Configure core objects, permission sets, skill sets, and scheduling logic to align system automation with your operational requirements.
Set Up Service Resource Preferences: Allow workers to specify preferred daily operating hours. When the scheduling tools run, the scheduling engine factors these preferences into match scoring through the Maximized Preferences objective.
Automate Resource Assignment with Bulk Tools: The scheduling tools—Get Candidates, Batch Assign, and Mass Shift Update—help planners assign the right workers where and when they're needed.
Submit a Service Resource Preference: Service resource preferences allow you, the worker, to take ownership of your schedule. Submit a service resource preference that reflects the hours that you'd like to work. When planners schedule shifts, the scheduling tools consider your preferences.
Prevent Overstaffing Gaps with Automated Time-Off Requests: Streamline time-off management to maintain accurate availability data. Approved absences automatically update scheduling availability so the tools don't assign conflicting shifts.
Create Account Account Relationships for Rebate Program Members: Define a relationship between two business accounts by creating Account Account Relationship records. You can relate parent and child accounts or peer accounts. For example, a distributor and its regional subsidiary can be related with each other in a parent-child relationship. Create account account relationships between a distributor or a ship-to partner and their child accounts to validate the ship and debit claims submitted by a child account.
Validate and Calculate Rebate Claim and Claim Aggregate: The Validate and Calculate Rebate Claim and Claim Aggregate expression set performs a series of validation checks on ship and debit claims, including verifying claim quantities, sales prices, member eligibility, and other key details.
Capabilities of Ship and Debit Process Management: Use Ship and Debit Process Management to create a robust, scalable ship and debit process to protect your partners’ margins and react to market conditions. Review the capabilities of Ship and Debit Process Management and see how you can achieve various business outcomes with it.
Capture Ship and Debit Claims in Experience Cloud: Partners can upload ship and debit claims by using Experience Cloud sites. Partners can also view the ship and debit program they're enrolled in and related special pricing term by using the sites.
Adjust Ship and Debit Claim Amounts: Ship and debit claim analysts can adjust the calculated amount of a rebate claim and get the adjustment approved. They can create adjustments to account for the changes in incentive terms, inflation, enrollment fees, previous balances, and so on. Adjustments can be submitted for approval by using the standard approval process.
Ship and Debit Claim Amounts and Aggregates: Use Rebate Claim records to track the claims submitted by partners for ship and debit programs. View the total claimed amount and the total claimed quantity for each product for a program member by using the Rebate Member Claim Aggregate records.
Process Ship and Debit Claims with Partner Inventory: The Process Ship and Debit Claim with Partner Inventory flow validates ship and debit claims and calculates claim amounts based on partner inventory. To calculate the claim amount, the flow draws from the ledgers of eligible partner unsold inventories for ship and debit. It determines the special prices applied to the claim amounts based on eligible partner unsold inventory (PUI), applicable special pricing terms, and benefits. The flow then updates the claim, the consumed partner unsold inventory ledgers, and the related rebate member claim aggregate.
Calculate Payouts for Ship and Debit Rebate Claim and Claim Aggregate: The Calculate Rebate Claim and Claim Aggregate for Ship and Debit flow validates a ship and debit claim based on business rules and calculates its claim amount based on the applicable special pricing term or benefit. It updates the claim and its related rebate member claim aggregate.
Enable Ship and Debit Process Management: To create ship and debit rebate programs, define special pricing terms and benefits, and process rebate claims, enable Ship and Debit Process Management in Setup. When you enable Ship and Debit Process Management, the predefined templates for Flow Builder and Business Rules Engine expression sets are also available for use.
Enroll Distributors and Ship-To Partners in a Ship and Debit Program: Enroll in a ship and debit program, distributors, partners, and dealers who receive ship and debit incentives, and customers and ship-to partners to whom distributors sell products. To validate the claims submitted by subsidiaries of distributors or ship-to partners, define the types of relationships between the related parties and create relationships between their accounts.
Validate Ship and Debit Claim with Partner Inventory: The Validate Ship and Debit Claim with Partner Inventory expression set validates ship and debit claims processed based on partner unsold inventory levels. It verifies claim quantities, member eligibility, claim dates, and other key details. This expression set is invoked in the Process Ship and Debit Claim flow template.
Experience Cloud Site Setup for Ship and Debit Members: Use Experience Cloud to give your partners access to Ship and Debit Process Management. Create an Experience Cloud site where partners can view the ship and debit program and payout details and submit their claims and proof-of-sale documents. You can use the predefined Manufacturing Experience Cloud template to create a site for partners. You can also use an existing site in your org, or create a site from scratch and add the Ship and Debit Process Management objects to your Experience Cloud site.
Expression Set Templates for Ship and Debit Claim Processing: Create a scalable process to validate ship and debit claims and to calculate payouts by using a Business Rules Engine. A Business Rules Engine is a suite of features that helps you automate complex decision-making. Ship and Debit Process Management includes preconfigured expression sets, which are read-only templates containing rules for processing ship and debit claims.
Flow Templates for Ship and Debit Claim Processing: Use Flow Builder to develop an automated process that validates ship and debit claims and calculates payouts. Flow Builder is a declarative tool that helps you build automated business processes. Use the preconfigured flow template as is to process claims, or extend and customize it to suit your business needs.
Key Roles in Ship and Debit Process Management: Ship and Debit Process Management users include admins, rebate program managers, partner users, ship and debit claim analysts, and the finance team. Admins set up and configure features. Rebate program managers design the ship and debit programs and special pricing terms based on requirements provided by sales and finance. Partner users are beneficiaries of ship and debit programs and enroll in programs to protect their margins. Ship and debit claims analysts validate ship and debit claims and review ship and debit payouts. The finance team tracks payments and approvals of payments and claims, helps with audits, and maintains the book of business.
Get Started with Ship and Debit Process Management: Use Ship and Debit Process Management to create effective ship and debit incentives to compensate partners who price products competitively for end-customers. Explore a trial org and then learn about what’s included, what setup we recommend, and how to get ready for your implementation.
Learn About Ship and Debit Process Management: Learn about the capabilities of Ship and Debit Process Management. Understand the end-to-end workflow of implementing and using its features. Explore the data model for Ship and Debit Process Management.
Create and Manage Ship and Debit Programs: Compensate partners when they competitively price their products to react to evolving market conditions, attract new customers, or build deeper relationships with existing customers. Rebate program managers can create effective, flexible ship and debit rebate programs to incentivize their partners. They enroll partners, dealers, and distributors as well as ship-to partners and customers to these programs. Rebate program managers can optimize the special prices and discounts offered to partners by defining the right mix of special pricing terms and benefits.
Ship and Debit Process Management: Ship and Debit Process Management gives manufacturers the ability to craft an end-to-end ship and debit process to compensate partners who sell competitively priced products and deftly react to market conditions. Manufacturers adjust product prices to protect their partners’ margins and to incentivize partners to repeat business. Use Ship and Debit Process Management to create ship and debit programs and set up special prices and discounts that partners receive for different products.
Create Party Role Relationships for Rebate Program Members: Define the relationship of two accounts or two contacts that are related to each other by using Party Role Relationship records. Some relationships can be reciprocal, such as the parent-child relationship between a distributor and their regional subsidiary. Some relationships can be linear, such as the relationship between two regional dealers that are subsidiaries of the same ship-to account.
Permission Sets for Ship and Debit Process Management: Assign permission sets to users to give them access to objects, fields, and features for Ship and Debit Process Management and related features. Permission sets extend users’ functional access beyond their user profiles but can’t take access away. You can assign multiple permission sets to a user.
Process Ship and Debit Claims: Build an end-to-end process to validate ship and debit claims, verify their eligibility for benefits, and calculate payouts by using declarative process automation tools. Minimize turnaround times, improve the efficiency of ship and debit claim analysts, and reduce manual errors with automated processes. Build your own processes by using the preconfigured, scalable templates for flows and Business Rules Engine expression sets as-is or as a reference.
Ship and Debit Incentives for Distributors and Their Subsidiaries (Example): Create ship and debit programs to define multi-tiered ship and debit incentives for distributors. Define the relationships between a distributor and their subsidiaries. Here’s an example that shows a semiconductor manufacturer that creates a ship and debit program for their partner distributors.
Add Ship and Debit Program Members: Rebate program managers can enroll partners and customers to ship and debit programs by creating Rebate Program Member records. Add partners, distributors, or dealers who get the ship and debit rebates to a ship and debit program as accounts. Specify ship-to partners and customers to whom distributors must sell products to get the ship and debit incentives as ship-to accounts.
Create a Ship and Debit Program: Rebate program managers can create a ship and debit rebate program to create a scalable, streamlined incentive structure for special prices and discounts.
Set Up Ship and Debit Management: Set up features for Ship and Debit Process Management. Enable the required features in Setup. Assign users the necessary permission sets. Set up object access, and configure the required settings for Experience Cloud site.
Create a Special Pricing Term: Rebate program managers can create special pricing terms to compensate partners when partners sell competitively priced products to end-customers. Define the products and program members that are eligible for special pricing terms. Specify the maximum quantity of a product that’s eligible for the special pricing term. Specify either the reference price per unit or the discount and discount by percent values for a special pricing term.
Create a Special Pricing Term Benefit: Rebate program managers can create special pricing term benefits for a special pricing term to define a tiered ship and debit incentive structure with qualifying ranges and incentives for each range. Differentiate the reference prices or discounts that partners get by the quantity of products they sell, the period they sell the products in, or both.
Compensate Your Partners for Competitive Pricing with Special Prices and Discounts: Rebate program managers can create special pricing terms to define flat discounts and reference prices for partners when partners sell competitively priced products. Rebate program managers can create special pricing term benefits to craft nuanced, tiered incentive structures and differentiate benefits by the product quantity sold, the period the product was sold in, or both.
How Do Special Pricing Terms and Benefits Work?: Understand what are special pricing terms and special pricing term benefits and how they work together to create a tiered ship and debit incentive structure.
Track and Adjust Ship and Debit Claim Amounts: View pricing, payout, and processing information of the ship and debit claims submitted by partners. Track the amount of ship and debit incentive for a product that a program member has already claimed. Adjust the ship and debit claim amounts and get the adjustments approved.
Ship and Debit Process Management Workflow: Review the end-to-end workflow, key considerations, and decisions involved in each stage of implementing and using Ship and Debit Process Management.
Access and Use the Security Health Review Tool: The Security Health Review tool provides an expert-grade assessment of your org’s security posture by analyzing metadata signals directly in Salesforce Setup. Use it to identify critical security findings, track remediation progress, and maintain compliance with Salesforce security standards.
API-Only Access Control: Restricts system identities, such as integration users, to programmatic access only, enforcing the principle of least privilege for all external integrations.
Assign Access to the Security Health Review Tool: Control who can view and manage Security Health Review reports and findings using two dedicated system permissions: View Health Assessments and Manage Health Assessments.
Authentication Provider Control: In Salesforce, an authentication provider is used when you want Salesforce to let users log in using their credentials from another service.
Caching Settings Control: This configuration optimizes platform performance and user convenience by using a global Content Delivery Network (CDN) and secure browser caching to accelerate the delivery of static Lightning resources.
Clickjack Protection Control: Salesforce provides Clickjack Protection settings to protect your organization from UI redress attacks.
Compliant Data Sharing Control: This control enforces the immediate removal of user participant records within the Compliant Data Sharing (CDS) framework whenever a user is deactivated or transitions to a role no longer requiring access.
Configure OAuth Policies: Custom Attribute Security Control: This security setting lets Salesforce admins define and restrict the specific user-level metadata and company claims that are injected into the cryptographically signed OAuth ID token.
Configure OAuth Policies: Manage External Client App OAuth Usage Control: This security setting provides Salesforce admins with a centralized interface to monitor, install, and block individual External Client App instances to regulate which third-party integrations can actively access organizational data.
Consent Event Stream Control: Streams near real-time events whenever consent-related fields change, providing an auditable feed of consent updates that downstream systems can subscribe to for timely enforcement of privacy choices.
Content Security Policy (CSP) Directive Rendering Control: Enabling CSP (Content Security Policy) Directive Rendering allows your Salesforce org to adopt the latest, most restrictive security standards for how resources are loaded on Lightning pages.
Content Security Policy Protection Control: Prevent users from bypassing security checks when viewing templates in Salesforce Classic using Internet Explorer, and enforce a rigorous framework that blocks unauthorized scripts and resources from executing within the platform.
Content Sniffing Protection Control: To prevent browsers from incorrectly interpreting files as executable scripts, Salesforce admins should enable "Enable Content Sniffing Protection" within the Session Settings menu.
Control User Access to Your Experience Cloud Site Control: This control involves explicitly adding specific Profiles or Permission Sets to the "Members" section of a site’s Administration settings to define exactly which user groups are authorized to log in.
Control Who Sees What: Salesforce uses a layered security model where Object and Field Permissions define the baseline for data access (CRUD), while Administrative, User, and Custom Permissions grant specific functional capabilities and system-level authority.
Controlling Access Using the Role Hierarchy Control: In the role hierarchy, users have access to records owned by or shared with users in roles below them. Roles within the hierarchy affect access to components, such as records and reports.
CORS Allowlist Control: The Salesforce CORS (Cross-Origin Resource Sharing) allowlist is a security control that enables administrators to specify trusted external domains permitted to perform cross-origin requests to Salesforce APIs and resources.
Daily Retention Store Cleanup Control: Automatically purges expired records from the Retention Store daily, enforcing data minimization by removing data past its defined retention period from Privacy Center policies.
Data Detect Control: Data Detect helps you identify sensitive data within your org so you can take steps to protect it. It uses platform-native technology without relying on third-party services or moving data outside of Salesforce. Use Data Detect to expedite data categorization by aligning data sensitivity levels and categories to actual field data.
Data Protection and Privacy - Health Cloud and Life Sciences Cloud: To help maintain the privacy of your users’ data, verify that data protection details are available for lead, contact, and person account records for Health Cloud and Life Sciences Cloud customers.
Disable Formula in Report Control: Org-wide setting that strips Excel formulas from report exports, preventing malicious formula injection attacks when users download sensitive data as spreadsheets.
DKIM Keys Control: A digital signature mechanism that validates that outbound emails originated from your Salesforce‑hosted org and have not been altered in transit, supporting email authenticity and spam‑filter enforcement.
Einstein - Agent Analytics Control: Activates the continuous collection and visualization of autonomous agent interactions, enabling performance tracking and ROI measurement.
Embedded Login Control: Embedded Login is a legacy feature that lets you put a login form directly on an external webpage using a small piece of JavaScript.
Enable Generate Event Log Files Control: Foundational setting that activates generation of detailed Event Log Files (ELFs) capturing comprehensive user and system activity across the org for security monitoring, compliance, and forensic analysis.
Enable the Health Assessments Agent: The Health Assessments Agent is an Agentforce-powered AI assistant that helps you interpret and act on your Security Health Review findings directly within Setup.
Review Encryption at Rest - Shield Platform Encryption (Add-On): Salesforce Shield Platform Encryption is the add-on security feature of Salesforce that encrypts sensitive data at rest without breaking the features your team needs, like search and workflows.
Enforce Email Privacy Settings Control: Organization‑level setting that enforces strict email‑privacy behavior for Salesforce‑sent messages, limiting exposure of internal addressing and metadata that could aid phishing or social‑engineering attacks.
Event Manager Control: Central console to activate real-time storage and streaming for 50+ event types, enabling both historical analysis via Big Objects and immediate external consumption via Pub/Sub API for SIEM/security platforms.
External Client Apps: Mobile App Settings: Mobile Screen Lock Control: The control enforces a mandatory authentication mechanism, such as a PIN, password, or biometric factor, that must be successfully validated before a user can access the mobile application or the device environment.
Field History Tracking Control: Native Salesforce auditing feature that logs all changes to tracked fields on objects, capturing old/new values, user, and timestamp for compliance and forensic investigations.
Field History Tracking Retention Control: Extends standard 18-month Field History Tracking retention through external archiving or Field Audit Trail upgrade, to support long-term auditability of critical data changes for compliance requirements.
Flow Builder Setup Control: Configures Flow execution context to enforce sharing rules and user permissions, preventing automated workflows from bypassing org security model and accessing unauthorized data.
Guest User Access: Site Preferences for Guest Accessing API Control: This security preference serves as a master gate that determines whether unauthenticated visitors can interact with the underlying Salesforce Connect and public-facing REST endpoints of an Experience Cloud site.
Guest User Access: Site User Visibility Control: This security setting determines whether users within a specific Experience Cloud site can discover and view the profiles of other members belonging to that same site.
Identity Provider Control: Configure Salesforce as an Identity Provider (IdP) when you want Salesforce to be the "source of truth."
Identity Verification Control: The control objective of Identity Verification settings in Salesforce is to enforce risk-based authentication by requiring users to provide secondary proof of identity whenever their login context changes.
Review Integrated User: Salesforce uses an Integration User to establish communication between systems. It serves as the "identity" for external applications when they interact with your Salesforce data via APIs. Salesforce configuration lets administrators restrict integration users for API only.
Lightning Loader API Version Control: Enabling the latest Lightning Locker API version is a security control that ensures all Lightning components in your organization are governed by the most recent security patches.
Lightning Login for Password-Free Login Control: The control objective of restricting Lightning Login to only users with the specific "Lightning Login User" permission is to make sure that passwordless authentication is deployed as a privileged, granular access method rather than an org-wide default.
Lightning Web Security Control: Enabling Lightning Web Security (LWS) is a security control that replaces the legacy Lightning Locker architecture with a modern, virtualization-based sandbox for Lightning components.
Limit Login IP Ranges Control: Login IP Ranges at the profile level is to enforce zero trust boundary by restricting Salesforce access to only authorized, company-controlled network environments (like a corporate VPN or office IP).
Login Access Control: Salesforce allows Salesforce admin to set up your org to allow Salesforce support users, partner support users, or subscribers to log in to a Salesforce org as another user.
Manage Redirections to External URLs Control: Salesforce secure redirections protect users from phishing and malicious sites by restricting URL redirects to only those domains explicitly added to the Trusted URLs list.
Manage User Passwords Control: Password Policies in Salesforce are to enforce robust authentication standards—such as complexity, length, and expiration—to prevent unauthorized access via "Brute Force" or "Credential Stuffing" attacks.
Mobile App Settings: Mobile PIN Requirement Control: This security setting mandates a secondary layer of local authentication by requiring users to enter a numerical personal identification number or biometric equivalent before accessing the mobile application interface.
Review Multi-Factor Authentication Controls: Multi-factor authentication (MFA) is a secure authentication method that requires users to verify their identity with a second piece of evidence (or factor) in addition to their password.
New User Welcome Email Settings Control: The Salesforce "Link Expiration" setting for welcome emails is a security control that defines the timeframe for which a new user's activation link remains active.
OAuth Access Policies - Enable Single Logout Control: Ensures that logging out of one application automatically terminates all associated sessions across the federated identity ecosystem for that connected app.
OAuth Flow Enablement: Disable Client Credentials Flow Control: This security setting deactivates the OAuth 2.0 grant type that lets an application authenticate and access data using only its own credentials without any user intervention or presence.
OAuth Flow Enablement: Enable JWT Bearer Flow Control: This security setting activates a certificate-based OAuth 2.0 flow that lets an application authenticate by signing a JSON Web Token (JWT) with a private key instead of using a static shared secret.
Permission Set Groups Control: Manage Permission Set Group to make sure that user access is granted based on specific job functions (personas) and adheres to the principle of least privilege, minimizing "permission sprawl."
Permission Sets Control: To enforce the principle of least privilege and simplify user management, Salesforce administrators should assign users the "Minimum Access" profile as a baseline.
Prevent Download of Custom File Types Control: Organization‑level control that blocks users from downloading specified high‑risk or sensitive file extensions stored as ContentVersion records, preventing abusive or unintended downloads of dangerous or regulated file types.
Prevent Upload of Attachment with High-Risk Type Files Control: Blocks upload of executable and high-risk file types (HTML, HTM, JS, EXE, and so on) as Attachments, Documents, or ContentVersion records, preventing stored XSS and malware distribution through Salesforce files.
Protect Data with Salesforce Backup and Restore Control (Add-On): The Salesforce Backup & Restore feature primarily addresses the security risk of data and metadata loss resulting from the "Shared Responsibility Model," where Salesforce secures the infrastructure but the customer remains responsible for the integrity of their own records.
Record Access Control: This setting enforces a mandatory private sharing model for unauthenticated users, so that they can only access records specifically shared with them through dedicated guest user sharing rules.
Referer URL Protection Control: The Referrer URL Protection control in Salesforce enables the Referrer-Policy HTTP header to regulate the amount of internal URL information shared with external websites.
Restrict User Email Domains Control: Define an allowlist to restrict the email domains allowed in a user’s Email field, to make sure the domains used are trusted.
Review and Manage Security Health Review Findings: Use the Security Health Review findings view to investigate security gaps in your org, track remediation progress, and document compensating controls or risk decisions.
Routing and Policies - Content Delivery Network Control: For optimal performance and robust security for Salesforce Experience Cloud LWR sites, enable the Salesforce Content Delivery Network (CDN) using a Single Domain Certificate.
Routing and Policies - Salesforce Edge Network Control: To improve global connectivity and security, enable the Salesforce Edge Network by configuring the "Route My Domain through Salesforce Edge Network" setting within the My Domain setup.
Safety and Security - Toxicity Detection Control: Automatically scans AI prompts and generated responses to identify, flag, and score harmful language across multiple categories (for example, hate speech, violence, profanity).
Secure Connections (HTTPS) Settings Control: This multi-layered control framework strengthens session integrity by enforcing continuous IP validation for every request and shielding session tokens from unauthorized script access via the HTTPOnly attribute.
Secure Logout Page Control: This control ensures that when a Salesforce session expires in a browser tab, the user is automatically redirected to a predefined, secure URL.
Security: Enable Refresh Token Rotation Control: This security setting invalidates and replaces each refresh token with a new, single-use token whenever a client uses it to obtain a new access token.
Security Insight - Security Center Extension (Add-On) Control: The detailed insight lenses display a set of scores. The scores are based on the risk rating for each security insight, finding and help in prioritizing what comes first in remediation activities.
Security: Require Secret for Refresh Token Flow Control: This security setting mandates that an application must provide a valid client secret alongside a refresh token to obtain a new, active access token from the Salesforce authorization server.
Security: Require Secret for Web Server Flow Control: This security setting mandates that the web server or application must provide a unique client secret to Salesforce to complete the exchange of an authorization code for an access token.
Select Enable Lightning Logger Events Control: Captures detailed client-side JavaScript errors, performance metrics, and custom logging events from Lightning Web Components (LWCs) and Aura components.
Self-Registration Control: This control involves deactivating the self-registration feature and its associated Visualforce components to make sure that new site members can only be added through an authorized, administrator-led invitation process.
Session Security Level Policies Control: The control objective of High-Assurance Session Security is to enforce "Step-up Authentication" for high-risk operations.
Session Settings Control: Lock Sessions to Originating IP Address to prevent session hijacking by making sure that a user's session ID remains valid only when accessed from the specific IP address where it was first established.
Session Timeout Settings Control: The Salesforce session timeout control is a security measure designed to protect against unauthorized access by automatically terminating user sessions after a specified period of inactivity.
Setup Audit Trail Control: Tracks administrative and configuration changes in Salesforce Setup to provide an auditable history of who changed what and when, supporting security monitoring and forensic investigations.
Single Logout Control: Configure Single Logout on applicable user cases for connections with external applications or identity providers.
Review Single Sign-On Controls: Single Sign-On (SSO) is a foundational security control in Salesforce that enables centralized, enterprise-grade identity management while reducing reliance on local credentials.
Single Sign-On for Salesforce Customer Identity Control: This enables Federated Authentication (SAML or OpenID Connect), allowing customers to use a single, trusted set of credentials from an external identity provider (IdP) to access multiple Salesforce sites and integrated applications.
Single Sign-On Settings Control: Single Sign-On centralizes authentication by allowing users to access Salesforce and integrated applications using a trusted identity provider.
Use Any API Client - Restriction Control: Restricts API access to only admin-approved Connected Apps, eliminating the ability for users to use unauthorized or legacy API clients.
User Access Policies Control: Salesforce User Access Policy is a security and administrative control that allows for the automated or manual management of user permissions and licenses based on predefined criteria.
User Sharing and Visibility Control: To enforce the principle of least privilege, set the User object’s Organization-Wide Sharing Defaults to "Private" and turn on the "Require Permission to View Record Names in Lookup Fields" setting.
View Event Log Data in Analytics Apps Control: Enables Event Log Files (ELFs) and real-time event data to be queried and visualized directly within Salesforce Analytics (CRM Analytics/Einstein Analytics).
WAF: Define Custom Firewall Rules Based on ASN or IP Control: This control lets Salesforce admins create specific security filters within the Salesforce Content Delivery Network (CDN) to block or allow web traffic based on the originating IP address or Autonomous System Number.
WAF Firewall Managed Ruleset Control: This control activates a pre-configured layer of security rules within the Salesforce Content Delivery Network (CDN) to inspect incoming web traffic and block common malicious patterns before they reach your site.
Web App Settings: After Enabling SAML, Configure the Required Policies Control: This security setting defines the required cryptographic signing algorithms, assertion validation rules, and service provider endpoints to secure the Security Assertion Markup Language exchange between the identity provider and the web application.
Web App Settings: Encrypt SAML Response - Select Control: This security setting cryptographically obfuscates the entire SAML assertion containing user identity and authorization attributes using a public key provided by the service provider before transmission.
Web App Settings: Verify Request Signatures - Select Control: This security setting mandates that the platform validates the digital signature of every incoming SAML or OAuth request against a trusted public certificate to ensure that the sender is authentic.
Simplify Reporting with Accounting Subledger: Improve your financial reporting by extending Accounting Subledger functionality to include rebate and incentive records. By integrating with Accounting Subledger, you can generate debits and credits within Salesforce, eliminating manual exports and data reconciliation in separate spreadsheets.
Simulate and Execute Price Protection: Manage end-to-end price change detection and execution to ensure accurate Price Protection for partner-held inventory, including the creation of PPE and PPELI records and generation of partner claims..
Simulation and Execution of Price Protection: Price Protection allows channel managers, vendors, and OEMs to assess the effects of price changes on their partners, products, and inventory. By providing visualization, pre-execution assessments, and a detailed audit trail, this feature ensures transparency and accuracy in managing price adjustments and their financial implications.
Single Logout: With single logout (SLO), users can log out from the identity provider and the service provider by logging out from either of them. Whether Salesforce is the service provider or identity provider, you can enable SLO with SAML or OpenID Connect. SLO can increase security and save users time by removing manual logout from every individual application.
SAML Session Index Support: Salesforce supports session index parameters in requests and responses with SAML single logout (SLO). When a user logs out of a connected app registered for SAML SLO, the session index parameter is required to identify which user session to end.
Explore Salesforce Solution Kits: Salesforce solution kits are recommended solutions that help solve common, cross-product, or cross-cloud business use cases.
Single Sign-On: Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one login and one set of credentials. For example, after users log in to your org, they can automatically access all apps from the App Launcher. You can set up your Salesforce org to trust a third-party identity provider to authenticate users. Or you can configure a third-party app to rely on your org for authentication.
Develop an Apex Registration Handler: To set up single sign-on (SSO) with an authentication provider, you must build a registration handler. During SSO, the handler creates and updates users based on information from the identity provider. For high-scale, high-performance use cases, develop a registration handler with Apex.
Authentication Provider SSO: With authentication providers, your users can log in to your Salesforce org or Experience Cloud site with single sign-on (SSO) using credentials from a third party. Authentication providers also give your users access to protected third-party data. Salesforce offers several ways to configure authentication providers, such as with OpenID Connect or with a custom OAuth 2.0 configuration. Which protocol you can use depends on the third party.
Configure SAML SSO Between Salesforce Orgs or Experience Cloud Sites: If your company deploys more than one Salesforce org or Experience Cloud site, set up SAML single sign-on (SSO) so users can easily move between them. In this SSO configuration, a single org or site acting as the identity provider authenticates users for one or more orgs or sites in the service provider role. Users can log in to all orgs or sites with a single set of credentials.
Create an Identity Provider Chain: To simultaneously authenticate users for your Salesforce org and a third-party client app, create an identity provider chain. In this SSO configuration, a third party authenticates users for Salesforce, while Salesforce authenticates users for the client app. Users can log in to the third party and immediately access Salesforce and the client app. You can chain identity providers with SAML or OpenID Connect exclusively. Or, you can create a chain that implements two different authentication protocols.
Create an Authentication Provider Registration Handler: To set up single sign-on (SSO) with an authentication provider, you must set up a registration handler. The registration handler creates and updates Salesforce users after they authenticate with the identity provider. To set up a registration handler, you can use Flow Builder or Apex.
Delegated Authentication: Delegated authentication is similar to single sign-on (SSO), but it offers a slightly different experience to users. With delegated authentication, one system relies on another system to validate user credentials. For example, you can configure your Salesforce org to rely on a Lightweight Directory Access Protocol (LDAP) server to validate credentials. Both SSO and delegated authentication enable users to log in to multiple apps with one set of credentials. However, with delegated authentication, users must log in to each app separately.
Configure Salesforce for Delegated Authentication: Set up delegated authentication for your Salesforce org so users can log in with credentials managed by an external authentication service. To configure Salesforce for delegated authentication, wrap your authentication method in a web service that Salesforce can consume. Then, use permissions to determine whether users log in with delegated authentication or with a Salesforce-managed password.
FAQs for Delegated Authentication: Review these frequently asked questions (FAQs) to help you implement and troubleshoot delegated authentication.
Require Users to Log In with Single Sign-On (SSO): By default, when you set up single sign-on, users can log in from the SSO provider or from Salesforce. To ensure that users can’t bypass your SSO system, disable their ability to log in with their Salesforce username and password so that they’re required to log in with SSO. We recommend that you don’t require SSO for Salesforce admins so that they can still access Salesforce to respond to SSO outages or other issues.
Troubleshoot an Authentication Provider User Registration Flow: When you use a flow for authentication provider user registration, there are some errors that are revealed only when you run the flow. Learn how to update your flow based on execution errors.
Example: Authentication Provider Registration Handler Flow: To create a registration handler flow for single sign-on (SSO), customize the Authentication Provider User Registration Flow template. The template creates and updates both internal and external users. It shows you how to use the Get User Data from JSON String and Generate User Data invocable actions. It also shows you how to manage permission set assignments.
Just-in-Time Provisioning for SAML: Use Just-in-Time (JIT) provisioning to automatically create a user account in your Salesforce org the first time a user logs in with a SAML identity provider. JIT provisioning can reduce your workload and save time because you don’t provision users or create user accounts in advance.
Just-in-Time SAML Assertion Fields for Experience Cloud: With Just-in-Time (JIT) provisioning for Experience Cloud, you can use a SAML assertion to create Experience Cloud site users the first time they log in from an identity provider. The identity provider sends user information to your Salesforce org in an Attributes statement in a SAML assertion. Work with your identity provider to determine which user information you want to pass to your org and that the Attributes statement is formatted correctly.
Edit the SAML Just-in-Time Handler: Finish the custom SAML Just-in-Time (JIT) configuration process by editing the Apex provisioning handler class. You can customize the way Salesforce provisions users when they log in to Salesforce with SAML single sign-on (SSO) for the first time.
Enable Just-in-Time Provisioning: Enable Just-in-Time (JIT) provisioning in Salesforce to automatically create or update user accounts when users first log in to Salesforce with SAML single sign-on (SSO).
Just-in-Time Provisioning Errors: Error codes, descriptions, and details for SAML Just-in-Time (JIT) provisioning are returned in the URL parameters.
Just-in-Time SAML Assertion Fields for Portals: With Just-in-Time (JIT) provisioning for portals, you can use a SAML assertion to create customer and partner portal users the first time they log in from an identity provider. Customer portals and partner portals aren’t available for new Salesforce orgs as of Summer ’13. Use JIT provisioning with Experience Cloud instead.
Just-in-Time SAML Assertion Fields for Salesforce: With Just-in-Time (JIT) provisioning, the identity provider sends user information to your Salesforce org in an Attributes statement in a SAML assertion. Work with your identity provider to determine which user information you want to pass to your org and that the Attributes statement is formatted correctly.
Define an Authentication Provider: To use an authentication provider for single sign-on (SSO), define an authentication provider in Setup by using configuration information from a third-party identity provider. Control security settings, customize the SSO experience with error and logout URLs, and configure registration handler settings. Most authentication providers support single sign-on (SSO) and third-party data access, with the exceptions of GitHub, Microsoft Access Control Service, and X (formerly Twitter).
Add Functionality to an Authentication Provider: After you set up single sign-on (SSO) with an authentication provider, Salesforce generates several client configuration URLs, such as the Single Sign-On Initialization URL. These client configuration URLs support request parameters, which you can use to add functions to your authentication provider. For example, use these parameters to get customized permissions from the third party or direct users to a specific location after authenticating.
Control Where You Send Users for Authorization: When you set up a Salesforce authentication provider, use an authorization endpoint host request parameter to send users to a specific page to approve authorization requests. You can use this parameter only for Salesforce authentication providers. You can’t use it to send users to an authorization page outside of a Salesforce domain.
Direct Users to an Experience Cloud Site after Authentication: When you set up single sign-on (SSO) with an authentication provider, use the Experience Cloud site URL request parameter to send users to a specific site after authenticating. With the site parameter, you can determine whether a user logs in to your Salesforce org or in to an Experience Cloud site. This parameter can also change what type of user the registration handler creates.
Control Your Authentication Provider User Experience: When you set up single sign-on (SSO) with an authentication provider for your Salesforce Experience Cloud site, use the expid request parameter to deliver different experiences to users.
Prompt Users to Reauthenticate and Reauthorize: When you set up single sign-on (SSO) with an authentication provider, you can optionally add the prompt URL request parameter to client configuration URLs. This parameter specifies how the authorization server prompts the user to log in again and reapprove data access. For example, you can make a user log in again after signing up for an account.
Redirect Users to Secure URLs: When you set up single sign-on (SSO) with an authentication provider, use protected URL redirect parameters to redirect users to *.force.com pages and prevent malicious redirects.
Customize Relying Party Data Requests: When you set up single sign-on (SSO) with an authentication provider, use the scope parameter to customize data requests to a third party, like Facebook. For example, request access to the email address listed on a user’s Facebook profile. You can use this parameter with every authentication provider except Janrain.
Configure an Apple Authentication Provider: Configure Apple as an authentication provider to allow users to log in to Salesforce or Experience Cloud using their Apple ID.
Manage Apple Auth. Provider and Private Key: After you create your Apple Auth. Provider, you can edit it to change settings or upload a new Apple key. Upload a new Apple key, for example, if you suspect that the key is compromised. After uploading the new Apple key, revoke the old one.
Configure a Salesforce-Managed Authentication Provider: To simplify authentication provider setup for sandbox use cases, use Salesforce-managed third-party apps. This process saves you the time and effort of creating your own third-party app and managing its credentials. Salesforce provides third-party apps for several common providers, such as Google, Microsoft, and Slack.
Configure a Microsoft® Access Control Service Authentication Provider: You can use Microsoft Access Control Service as an authentication provider using the OAuth protocol. Typically, a Microsoft Office 365 service like SharePoint® Online handles authorization. SSO authentication from a Microsoft authentication provider isn’t supported.
Configure a Microsoft Authentication Provider: Set up a Microsoft authentication provider so your users can log in to Salesforce with their Microsoft credentials. This provider supports authentication with all services provided by Microsoft Azure Active Directory (AD).
Configure an Authentication Provider Using OpenID Connect: To configure single sign-on (SSO) with Salesforce as the relying party for a third-party OpenID provider, set up an authentication provider that implements OpenID Connect. With this configuration, your users can log in to Salesforce from the OpenID provider and authorize Salesforce to access protected data.
Dynamically Add Functionality to an Authentication Provider: For the most flexibility with authentication provider functionality, create your own URL parameter forwarding allowlist. With an allowlist, you can dynamically add allowlisted parameters to your client configuration URLs at runtime and forward them to the third-party provider. For example, forward the user's language preferences to the third-party provider so that the provider's login page displays in the user's desired language.
Create a Custom External Authentication Provider: To configure single sign-on (SSO) from a third party that supports OAuth but not OpenID Connect, create a custom authentication provider. With a custom authentication provider, users can log in to your Salesforce org with third-party credentials.
Configure a Salesforce Authentication Provider: To set up single sign-on (SSO) between two Salesforce orgs, configure a Salesforce authentication provider. Your users can log in to one org, the relying party, by using credentials from an identity provider org.
Configure SSO with Salesforce as a SAML Service Provider: Configure your Salesforce org or Experience Cloud site as a service provider with SAML single sign-on (SSO). With this SAML configuration, your users can log in to Salesforce with credentials from an external identity provider.
Example SAML Assertions: Salesforce supports several SAML assertion formats sent by your identity provider, with extra requirements for specific features like encrypted assertions and Just-in-Time (JIT) provisioning. To help your identity provider determine the format of SAML assertions to use with your Salesforce org, share these examples.
View and Edit Single Sign-On Settings: After you configure your Salesforce org to use SAML, you can manage the SAML configuration from the Single Sign-On Settings page.
Step 1: Gather Information from Your Identity Provider: During a SAML single sign-on (SSO) flow where you use Salesforce as a service provider, your identity provider sends a SAML response to Salesforce, which Salesforce then validates. To make sure that Salesforce can recognize and validate the SAML response, gather SAML information from your identity provider so that you can share it with Salesforce.
Review the Login History: When users fail to log in to your org with single sign-on (SSO), search the login history to find out why. For example, see if a login failure is related to the SAML assertion or to your Salesforce configuration.
SAML SSO with Salesforce as the Service Provider: SAML is an open-standard authentication protocol that Salesforce uses for single sign-on (SSO) into a Salesforce org from a third-party identity provider. You can also use SAML to automatically create user accounts with Just-in-Time (JIT) user provisioning.
Set Up an External Identity Provider to Encrypt SAML Assertions: When you configure Salesforce as the service provider in a SAML single sign-on (SSO) configuration, you can pick a saved certificate to decrypt inbound assertions from external identity providers. These instructions show you how to edit your SSO configuration so that your external identity provider can encrypt SAML assertions.
Customize SAML Start, Login, Logout, and Error Pages: When you configure SAML single sign-on (SSO) into Salesforce, you define URLs for the pages users see throughout the SSO flow. Your identity provider can provide the URLs for the start, login, and logout pages. Or you can provide your own URLs for these pages. You can also specify a custom error page.
Troubleshoot SAML Assertion Errors: Use the SAML Assertion Validator to troubleshoot single sign-on (SSO) login problems and identify errors in SAML assertions sent by your identity provider.
SAML Login Errors: If users have trouble accessing your org with single sign-on (SSO), use the login history to determine whether it’s a SAML assertion error or a configuration problem. If it’s an assertion-related error, identify specific assertion problems with the SAML Assertion Validator. Work with your identity provider to ensure that the SAML assertion and your SSO configuration are valid.
Step 2: Create a SAML Single Sign-On Setting in Salesforce: For SAML configurations where your org or Experience Cloud site acts as a service provider, create a SAML single sign-on (SSO) setting with the information from your identity provider.
Salesforce as Service Provider and Identity Provider for SSO: Depending on your authentication needs, you can create an identity provider chain, configure SAML single sign-on (SSO) across multiple orgs or Experience Cloud sites, or use the predefined Salesforce authentication provider. If you want users to log in to Salesforce from a third-party identity provider and immediately have access to a client app, set up an identity provider chain. If you want users to access several orgs or sites with one set of credentials, set up SAML SSO between multiple orgs or sites. You can also set up SSO between two orgs with the Salesforce authentication provider, which authenticates users and authorizes access to protected data.
Salesforce as an Identity Provider: Configure single sign-on (SSO) so users can log in to an external service provider or relying party with their Salesforce credentials. You can enable your Salesforce org as a SAML identity provider and integrate a service provider as a SAML external client app or connected app. You can also use OpenID Connect to integrate a relying party with your org.
Salesforce as a SAML Identity Provider: Set up single sign-on (SSO) by using your Salesforce org or Experience Cloud site as a SAML identity provider for an external service provider, such as Google Apps. In this SSO configuration, users log in to the service provider with their Salesforce credentials. To set up this configuration, enable Salesforce as an identity provider and integrate your service provider using the external client apps framework or the connected apps framework.
Salesforce as a Service Provider: Configure single sign-on (SSO) so users can log in to your Salesforce org with their credentials from an identity provider or authentication provider. For this use case, you can define an identity provider with Security Assertion Markup Language (SAML). You can also use a predefined authentication provider, configure an OpenID Connect authentication provider, or create a custom authentication provider.
Single Sign-On for Portals and Sites: You can configure single sign-on (SSO) for portals and Sites. Keep in mind that customer and partner portals aren't available for new orgs as of the Summer ’13 release. Use Experience Cloud sites instead.
Single Sign-On Terminology: Do you want to configure single sign-on (SSO) for your org? Get acquainted with some key terminology first.
FAQs for Single Sign-On: Review these frequently asked questions (FAQs) to help you implement and troubleshoot single sign-on (SSO).
Single Sign-On Use Cases: When you want users to move seamlessly between Salesforce orgs and applications without logging in repeatedly, set up single sign-on (SSO). Depending on the use case, you can configure SSO so users log in to your Salesforce org from a third-party application, such as a corporate portal. You can also set up SSO to allow users to log in to another application from your Salesforce org. You can even configure an SSO chain where users log in to a third-party application to access Salesforce and then use Salesforce to access another org. Or configure a less centralized login experience, where users can log in to multiple apps with the same user credentials.
Consent Management: Before you send promotional emails, make sure that you’re in compliance with regulations such as CAN-SPAM. After you update consent data, allow time for your data to sync before you send messages.
Segment Examples: The quickest way to get started with segments is to use the quick filters or send to campaign members options. But if you want to further customize your audience segments, use Segment Builder. For best results, verify field values on corresponding records, and copy and paste those values into the segment canvas.
Test Segments in Small Business Suites: Review email personalization and email delivery in the real world with test segments. A test segment contains your or your colleagues’ contact information so that you can review personalized, draft emails in your own inboxes.
Start Selling Online: Sell directly to individual shoppers and provide a personalized online shopping experience with the Commerce app for Starter and Pro Suite. Create secure payment links that direct your customers to a Pay Now page where they can choose which payment method to use.
Spring ’24 Release Notes: Explore what’s new in Salesforce Starter and Pro Suite for Spring ’24. Spend less time searching for apps you need and explore new options that help you get to work more quickly. Analyze and optimize your marketing efforts with the new campaign layout. These features and enhancements became available starting in January 2024.
General Enhancements for Starter and Pro Suite: Customize the vertical navigation bar for easy access to apps and use the new home page to prioritize your tasks for the day. Manage your plans for the fiscal year in Quick Settings and consider the benefits when you upgrade your account to Pro Suite.
Summer ’24 Release Notes: Explore what’s new in Salesforce Starter and Pro Suite for Summer ‘24. Focus on the information that matters most to you with the enhanced Lightning user interface. Manage campaigns and create content more efficiently. These features and enhancements are available starting in May 2024.
Marketing Enhancements for Starter and Pro Suite: Add a templated flow, preview and test emails, and send emails to campaign members all from the campaign record. Create content more quickly with brands and cloning.
Spring '25 Release Notes: Explore what’s new in Salesforce Starter and Pro Suite for Spring ’25. Find and manage your Commerce payment information faster with the refreshed Pay Now experience. Create campaign audiences more easily with quick filters and preview. These features and enhancements are available starting in January 2025.
Marketing Enhancements for Starter and Pro Suite: Build campaign audiences faster from the campaign record with preconfigured filters. Preview a segment to get an idea of who receives your emails. Access automated parts of a campaign more easily with an improved record page layout.
Summer ’25 Release Notes: Explore what’s new in Salesforce Starter and Pro Suite for Summer ’25. Collaborate in real-time with Slack. Send emails to an audience segment directly from any lead or contact list view. Further customize the content of your marketing emails and more easily manage the data sources powering your email personalizations. These features and enhancements are available starting in May 2025.
Marketing Enhancements for Starter and Pro Suite: Create consistent and customizable layouts for lists of related content in marketing emails. Use dynamic URLS to personalize images and buttons in emails. And easily view and manage the data sources powering email personalizations.
Winter ’25 Release Notes: Explore what’s new in Salesforce Starter and Pro Suite for Winter ‘25. Sell to shoppers by building an online commerce store with the new setup assistant. Boost your productivity with new features such as shared workspace folders and additional consent tools. These features and enhancements are available starting in September 2024.
Commerce Enhancements for Starter and Pro Suite: Create an online shopping experience for your customers to drive more sales. With the setup assistant in the Commerce app, you can get your site up and running quickly.
Einstein Enhancements for Starter and Pro Suite: Try Generative Canvas (Preview) and see how it can create tailored pages for a singular view of the data most important to you and your teams.
General Enhancements for Starter and Pro Suite: Keep track of suggestions on the Home app easily with options such as bookmarks and category filters. Share content records across marketing and commerce workspaces to save time on content creation.
Marketing Enhancements for Starter and Pro Suite: Manage customer opt-in, opt-out consent statuses more efficiently with additional consent tools. Create custom pages with forms to collect information from customers and share about your brand. Upgrade to Marketing Cloud Growth Edition to get access to more features.
Spring ’26 Release Notes: Explore what’s new in Salesforce Suites for Spring ’26. Upgrade the Microsoft Office 365 connection in Einstein Activity Capture to the more modern, secure, and scalable Microsoft Graph API. As part of our commitment to email security and deliverability, Salesforce is moving to a mandatory domain verification model. Use Agentforce and generative AI to surface key insights and save time on labor-intensive tasks. Einstein Conversation Insights now brings AI insights to Starter and Pro Suite. The streamlined, component-based Email Builder Lite is now available in Starter and Pro Suite. An abridged version of the Marketing app is now available in Salesforce Free Suite. Segments are now creatable directly from your Contact and Lead list views. Generative Canvas (Preview) is no longer available in Starter or Pro Suite starting on February 11.
AI Enhancements for Salesforce Suites: Agentforce and generative AI now enable Salesforce Suites users to surface key insights and save time on labor-intensive tasks. Einstein Conversation Insights are now in Starter and Pro Suite.
General Enhancements for Salesforce Suites: Starting with Spring ’26, all existing Starter and Pro Suite orgs that are connected to Microsoft Office 365 must transition to Microsoft Graph. All emails sent from Salesforce in paid Suites must originate from a verified domain. Explore dark mode theme for Starter orgs who are using Salesforce Lightning Design System 2 (SLDS 2).
Marketing Enhancements for Salesforce Suites: Access Email Builder Lite in all Salesforce Suites. Take advantage of advanced Marketing features in Salesforce Free Suite. Create audience segments directly from your Contact and Lead list views.
Summer '26 Release Notes: Explore what's new in Salesforce Suites for Summer '26. Turn on dark mode in all Salesforce Suites. Prioritize your top leads and contacts with People Scoring in Starter and Pro Suite. Elevate your marketing analytics with Tableau. Create sign-up form campaigns more efficiently. Build brand-consistent emails faster in Starter and Pro Suite.
Marketing Enhancements for Salesforce Suites: Use People Scoring in Starter and Pro Suite to prioritize your leads and contacts. Access new, high-fidelity Tableau visualizations to evaluate your marketing strategy with data-backed confidence. Create lead caputure campaigns and brand-consistent emails faster than ever before.
Winter ’26 Release Notes: Explore what’s new in Salesforce Small Business Suites for Winter ’26. Explore the new Free Suite edition designed for small businesses. Use Salesforce Channels for Slack to connect your team across Salesforce and Slack. Easily configure forms for external sites and add necessary integrations to enhance functionality and security. Discover new capabilities that come with sending marketing emails from a list. These features and enhancements are available starting in September 2025.
General Enhancements for Small Business Suites: Explore how individuals and boutique businesses can access key Salesforce features for free. Learn about real-time collaboration with Slack Channels for Salesforce record pages.
Earlier Starter and Pro Suite Release Notes: Starter and Pro Suite archives release notes older than one calendar year. Refer to the help documentation for the most accurate and current information on using Starter and Pro Suite functionality.
Set Up Marketing in Starter and Pro Suite: Before users can start working with campaigns and send emails in Starter and Pro Suite, you must enable Marketing and complete additional setup tasks required to meet email privacy regulations and give users access to the Marketing app.
Set Up Pay Now in Starter and Pro Suite: Pay Now, powered by Salesforce Payments, is a payment solution that can be used to generate links that direct customers to a Pay Now page. In Starter and Pro Suite, you can direct customers to a payment page when an opportunity closes. Pay Now isn't available to Salesforce customers in India, Brazil, and Japan.
Preview and Activate Your Store: As you work on your online store, you can preview what it looks like to customers. When you’ve completed setup and you’re ready to make your store public, you publish the store and then activate it. To continue preparing your store for customers, follow the recommended actions on the store home page. Republish your store whenever you make changes.
Set Up Store Branding: Brand your online store to duplicate the look of your company's site. You can add colors, images, text size, and more to your store’s template theme. The settings you configure for the template’s theme apply across the storefront.
Configure Store Checkout: Add checkout functionality to your store, including payment, shipping, and tax calculation services. By default, a new D2C store uses Managed Checkout, which includes smart store defaults for a streamlined checkout setup. A default shipping profile based on your store location and currency settings is automatically configured for you. You can change your profile and rates at any time.
Create More Markets: Instead of standing up multiple stores for different regions, use one store and segment your customers into markets based on locale. To create a market, assign the price book, entitlement policy, currency, ship-to countries, and locales that it supports. Additional markets are available only for Pro Suite customers.
Add a Product: Add a product to your online store. In addition to bulk loading products by using a CSV file, you can add products one at a time during store setup.
Enhance Your Store with Recommended Configurations: After you activate and publish your online store, you can use recommended actions to further develop and configure your store. You can choose which recommended actions to take. Some are based on insights into your store and unique to your store’s data, and others are general recommended actions. Monitor goal progress over time with data-driven insights such as conversion rate, average order value, and site traffic.
User Management in Salesforce Suites: Assign and manage user access easily with a simple user management window and standard permission set groups. Review how permission set group recalculation statuses can help you make sure that users have the latest permissions.
User Permissions in Salesforce Suites: Take the guesswork out of user management with standard permission set groups in Salesforce Suites. Learn what permissions are granted automatically to users with the System Administrator profile so you can handle setup tasks with confidence.
Submit Ship and Debit Claims: Partners, dealers, and distributors can submit ship and debit rebate claims either directly or from the Experience Cloud site. You can validate these claims against proof-of-sale documents and verify whether these claims qualify for special pricing terms and benefits. Partners can edit and resubmit claims if there are any errors.
Subscribe to Trust Notifications: You can subscribe to Trust instance notifications and to Trust informational message notifications. To get notified when a service disruption, performance degradation, or maintenance activity affects your Salesforce products and instances, subscribe to Trust instance notifications. To get notified about general announcements regarding cross-cloud products or services, a subset of Trust Status users on multiple instances or not limited to a specific instance, and external issues affecting your ability to access your Salesforce product or service, subscribe to Trust informational message notifications.
Actionable Lists in Salesforce Suites: In the Marketing app, the List Sends feature targets an Actionable List, which is a saved collection of leads or contacts. Because the recipient list comes from an Actionable List instead of a segment, your email goes out without waiting on Data 360 processing.
AI Features for Salesforce Suites: Stop digging and start doing. Our AI tools help you get more done so you can spend your time focusing on your customers and growing your business. Turn your data into actionable insights and get help with time-consuming tasks like updating records, meeting preparation, and drafting emails.
Delivered Actions for Salesforce Suites: Actions are how agents and generative AI get things done. For example, if a user asks an agent for help with writing an email, the agent launches the action that drafts and revises the email and grounds it in your relevant data.
Set Up Agentforce and Generative AI for Salesforce Suites: Before you can use AI to surface insights or save time on labor-intensive tasks, you must turn on Agentforce and generative AI. From there, customers with an existing Salesforce org must add the AI Summary tool to your record pages.
Get to Know AI Features for Salesforce Suites: Conversational AI tools, like Agentforce Coworker and Agentforce, help you manage business tasks, surface key insights, and prep for meetings more efficiently. Use plain language to describe what you're looking for and these tools instantly pull up the information you need. Generative AI uses your data to automatically create brand-new content, such as personalized emails and account summaries.
Choose Recipients to Email with List Sends: Use the Send Email button on a list view to start the List Sends email flow. Choose whether to send a sales or marketing email. Then, define your recipients, craft your message, and send your email. The List Sends tab provides a unified table where marketing users can view, search, sort, and act on all list emails—both marketing (promotional) and sales (relational).
Defining Your Audience for Email Lists: Salesforce Suites give you more than one way to send an email to a list, and each way defines its audience differently. Knowing which one you’re in explains what you see when you pick your recipients.
Draft Emails with the Email Authoring Agent: Use the Email Authoring Agent to create marketing emails faster. Draft emails in a conversation with the agent by describing the type of email, the purpose of your message, and what you want to share. The agent uses generative AI to propose a layout and copy that you refine in the conversational panel or edit directly.
Sync Your External Apps to Salesforce Suites: Connect the external apps that your business relies on to Salesforce Suites. Learn how our prebuilt integrations work and set up a connection to keep your external data in sync.
Discover and Set Up Features With Salesforce Go: Explore, set up and configure, and monitor feature usage in one streamlined setup location. Access content resources, such as videos, online tours, Trailhead, and Salesforce Help articles, to learn about features, and get help with configuration. Discover more features and add-on licenses that are available based on your Salesforce edition.
Sending Emails in Salesforce Suites: Use Salesforce Suites to send sales and marketing emails with the List Sends composer. You can define your audience from list views, Actionable Lists, or segments. Where you start determines how you define your audience.
Assign Permission Set Licenses: Assign the right permission set licenses so that internal users and supplier portal users can access Supplier Engagement.
Complete the Scorecard Wizard: Complete the scorecard wizard so that the buying organization gets your sustainability, cost, risk, and procurement data.
Supplier Engagement Components: Supplier Engagement is built from a small set of objects, a portal, and a guided wizard.
Configure the Supplier Portal: Configure the portal so that suppliers see the fields and navigation your business process requires, and configure access so suppliers can see their own records.
Supplier Engagement: Give procurement and sustainability teams a complete, end-to-end way to collect supplier sustainability, cost, risk, and procurement data.
Prepare Your Org for Supplier Engagement: Verify that your org has the required licenses and platform version, and assign permission set licenses, before you turn on Supplier Engagement.
Set Up Supplier Engagement: Configure Supplier Engagement in order, since later steps depend on features turned on in earlier ones.
Troubleshoot Supplier Engagement: Use Object Manager, Supplier Preferences, and the supplier portal's Experience Builder to diagnose common Supplier Engagement issues.
Turn On Supplier Engagement: Turn on Supplier Engagement using either Salesforce Go or Supplier Preferences in Setup. Both paths enable the same underlying feature; use whichever fits your workflow.
Verify Required Licenses: Verify the required licenses so that your org has the entitlements Supplier Engagement depends on before you assign access or turn on features.
Languages Supported by Loyalty Management: The Loyalty Management app is localized in languages that Salesforce fully supports and languages in which end users are supported. Your global users can choose the language in which they want to view and use the Loyalty Management app.
Surveys FAQs: Get answers to common questions about Salesforce Feedback Management.
Tag Records: Use tags to group records from various objects by a common theme. Add tags in a search criteria to find information faster and more intuitively.
Remove Tags from Records: Tags are words or short phrases that you can edit on the record detail page.
Show Survey Pages Based on Responses: Use page branching logic that's based on a participant's responses to determine the next page that the participant views.
Show Survey Pages Based on Merge Fields: Use page branching logic that's based on merge field conditions to determine the next page that a participant views.
Add the Survey Invitations and Responses Related List to Object Record Pages: Use the Survey Invitations and Responses related list to view the survey invitations and responses related to an object’s records. You can add the related list to the record detail pages of any object that Survey Subjects supports.
Schedule the Dataflow for the App: The app creation process includes a dataflow that imports the latest data to Analytics. Schedule the app to refresh every day to ensure that your app uses up-to-date data.
Enable CRM Analytics: Before you create an app from the Customer Lifecycle Analytics template, enable CRM Analytics in your Salesforce org.
Set Up Engagement Channel: To analyze a survey based on engagement channels, set up the engagement context for the survey. First, create a custom metadata type, add a custom field called Engagement Channel, and then select the new custom metadata type as the survey’s engagement context.
Enable Auto-Progress to the Next Survey Page: Help to speed participants through surveys by automatically sending them to the next page when they answer the last question on the current page.
Create a Survey from a Copy: Make a copy of a survey to duplicate its questions and logic. When you copy a survey, it’s not related to the original survey record. The copied survey becomes a new survey record.
Create a Timeline to View Survey Responses: Create a timeline for a Contact record to show survey response details. You can select the fields to show for each timeline entry, and even show fields from other related objects and custom objects.
Create Alerts for Survey Responses: Use record alerts on the Contact record page to receive alerts for survey responses. Service agents can view alerts related to customer feedback about closed cases, service quality, and more.
Create a Basic Survey: Create a basic survey that you can use to embed in a custom app or on an external website.
Create Survey Data Maps to Create or Update Records: Incorporate feedback into your Salesforce org by creating data maps that automatically create or update case or other records based on a participant's responses.
Configure Variables for Merge Fields: Configure variables that define the information that you want merge fields to insert, including field values from records related to survey invitations, participant details, company information, and custom values.
Capture Responses from Partially Completed Surveys: Participants sometimes exit before they complete the survey. Let participants pick up right where they left off by saving their in-progress work. The response status changes from Started to Partially Completed after the partial save window period, and the partial responses are stored in survey objects. Responses are saved when the participant clicks the Next button on a page. For surveys with auto-progress enabled, responses are saved up to the second-to-last page visited. Partial save isn't available for surveys with all questions on a single page.
Create a Data Map to Get Alerts: Create a data map to receive record alerts for survey responses when defined conditions are met. For example, service agents can view alerts related to survey responses with negative customer feedback.
Create Scheduled Reminders: Keep users informed about upcoming and past occurrences through scheduled reminders sent via emails.
Create Summaries from Survey Responses: Generate summaries of survey responses using generative AI to gather feedback and valuable insights. Use data maps to automatically create or update records, or send custom notifications whenever a summary is generated.
Create a Standard Survey: Create a standard survey to collect data from customers, employees, or other people whose feedback you need.
Create a Custom Report Type to View Survey Scores: Create a custom report type based on survey question scores so that you can analyze the responses for every type of question except for short text and long text questions. View the responses in custom reports and dashboards for surveys or survey invitations.
Create a Survey Version: Create a version of a survey to duplicate its questions and logic. The new survey version is related to the original survey record in Salesforce.
Create Standard Surveys With Generative AI: Generate surveys effortlessly using generative AI to gather feedback and insights from customers, employees, or other individuals.
Create a Data Map for Survey Responses: Create a data map that creates a Task record based on survey responses. You can show the details of the record in a timeline. For example, you can create a standard survey to collect feedback and then create a data map that automatically creates a Task record based on a participant's response. You can then view the responses in a timeline.
Track Satisfaction Across a Customer's Lifecycle: Understand how participants feel about your company, product, or service throughout their customer journey by tracking satisfaction metrics with Customer Lifecycle Maps.
Customize the Thank You Message: Customize the message that participants see when they finish the survey. Write multiple messages and then create the logic that determines which message participants view.
Define Default Settings: Define the default for email, language, engagement context, and invitation settings for your surveys.
Delete a Survey: Delete a survey that you no longer require.
Gather Feedback at the End of a Messaging Session: Share survey invitations with a wider audience on WhatsApp and Facebook Messenger, and allow participants to respond on the go by sharing invitation links in an SMS. This feature is available only in standard Messaging channels.
Export Survey Responses: Export responses for a survey version from the Analyze tab of the Survey Builder. Enable Survey Owners Can Manage Responses on the Survey Settings page to enable survey record owners to export responses associated with their invitations.
Add a Survey to Any Lightning Record Page: Use the Surveys component to add surveys to object records that support Lightning components. Your users can respond to the survey from the record page. You can also add the Surveys component to Experience Cloud sites to gather responses from guest users.
Add Topics to Survey Records: Use the Topics component to add themes to Survey, Survey Question, Survey Question Choice, and Survey Question Response records. You can analyze trending topics and learn how different areas of your business are performing in the Topic Analysis dashboard in Customer Lifecycle Analytics.
Select the Access Level for Merge Fields: Select the access level for merge fields to ensure that survey participants view only the Salesforce data that you want them to see. When a participant opens a survey, it resolves the merge fields that the participant has access to.
Insert Merge Fields: After you configure the merge fields, insert them to personalize welcome messages, questions, and thank you messages for each participant.
Send Surveys to a Different Salesforce Org: Use package to transfer your survey records from one Salesforce org to another, such as sending a test survey from a sandbox org to a production org.
Use APIs to Get Responses from Unauthenticated Guest Users: Use the SFM unAuth Response APIs to share basic survey invitations so that recipients outside your org can respond to the surveys without using their authentication credentials.
Email Survey Invitations to Individuals: For surveys with fewer participants, email the survey invitation by manually adding each address. You can email individual survey invitations to leads, contacts, or users in your Salesforce org. The invitation can include a single embedded survey question or a link to open the survey.
Email Survey Invitations to a Group of Participants: Target a large audience by sending survey invitations to a group of participants using an object list view. The invitation can include a single embedded survey question or a link to open the survey.
Send Survey Invitation Links: Generate a survey invitation link, configure the invitation settings to control your survey's security, and send the invitation to participants.
Send Survey Invitations with the Send Survey Action: Send a pulse or relationship survey invitation by email from record pages to individuals related to the record by using the Send Survey action. Personalize the email by adding merge fields and embed either a survey question or a link to the survey in the email.
Use a Flow Action to Get Sentiment Insights: Use the Perform Survey Sentiment Analysis action in Flows to trigger the Amazon Comprehend API. The Amazon Comprehend API uses your survey data map to process survey responses, and creates or updates AI Sentiment Result records with insights about the sentiment of the responses.
Use the Perform Survey Sentiment Analysis Flow Template: Use the Perform Survey Sentiment Analysis Flow template to understand the sentiment underlying the responses to text-based survey questions for all the survey version records in your org.
Create a Case for a Loyalty Program Member: Service representatives can create a case for a member when interacting with them from the member’s Loyalty Program Member record. The case is automatically associated with the member’s Contact record.
Share Surveys with Users: Collaborate with your team when designing surveys by manually sharing survey records with them.
Survey Question Properties: Use a question's properties to indicate whether the question is required and to add a description field to a question.
Use Rules to Target Survey Participants: Survey Invitation Rules allow you to send rule-based surveys when a record is created or updated for a Survey Subject supported object. Add a customer engagement context to the rule to collect information about the groups that are targeted.
Link to Webpages from the Thank You Page: Keep your customers engaged after they respond to surveys by adding links or redirects to your company website, social media pages, or other webpages on the Thank You page.
Translate Surveys: Gather insight from your global audience by translating your surveys into other languages.
Translate Surveys With Generative AI: Unlock insights from a global audience by using generative AI to translate surveys into different languages.
Specify the Survey Language for External Participants: When participants outside your Salesforce org open a survey invitation, they select the language in which they want to view the survey. However, you can edit the survey invitation link for external participants to ensure that they view the survey in a particular language.
Validate Short-Text Responses: Validate responses to short-text questions to help ensure the quality of feedback you receive.
Share Survey Invitations with Users: Let users view their survey invitations and responses on the Analyze tab of the Survey Builder and in reports based on the Survey Question Score object.
View the List of Users with Survey Access: View the list of users who have access to a survey and details of the user access, such as the type of user, reason for granting access, relationship, and access level.
Trailblazer Account Merges: Some actions trigger a Trailblazer account merge, combining activity from multiple accounts into one. You can choose to manually merge two or more accounts.
Certifications on Your Trailblazer Profile: Your Trailblazer profile lets you share your professional achievements, including Salesforce certifications, with the world.
Your Privacy and Trailblazer Profile: Your Trailblazer profile has public and private information. Take charge of who sees what using your account settings page.
Your Trailblazer Profile: Your Trailblazer profile contains information from different Salesforce-related sites so you have an at-a-glance view of your skills and activity.
Trailblazer Profile URLs: Your Trailblazer profile is your digital Salesforce resume, showing colleagues and employers what you learned. With a personalized profile URL, you can easily share your Trailblazer profile anywhere, with anyone.
Trailblazer Recovery Accounts: Connect your Trailblazer account to another email account or social login as a recovery account.
Device and Browser Best Practices: To improve device and browser performance, you can take some simple steps. Slow load times can result from devices that don't meet Salesforce minimum technical requirements. Also, plug-ins, extensions, and excessive tabs can consume processing power and memory, degrading performance.
What Is EPT?: Experienced Page Time (EPT) is a performance metric Salesforce uses in Lightning to measure page load time. EPT measures how long it takes for a page to load into a state that a user can meaningfully interact with.
Scale Test: To ensure that your Salesforce implementation meets your future needs, it’s important to develop and test your system with scale in mind. Meet Scale Test, your central hub of information and resources about scalability and performance testing with Salesforce.
Improve Speed and Performance of Lightning Experience Pages: Network, device, browser, and org configuration issues can all affect your Lightning Experience page performance. Learn best practices and common solutions to speed up your system if you’re experiencing sluggishness or long page-load times.
Improve Virtual Desktop Environment Performance: Virtual desktop environments sometimes have older processors and are shared by multiple users, potentially resulting in slower page load times. To predict how a virtual desktop performs with Lightning Experience, run performance tests from within the virtual environment.
Tier Assessment: Review the tier assignment of members at regular intervals and at the end of the tier period to check whether members are eligible for a tier upgrade based on their current qualifying points balance. You can either use a loyalty program process or a flow to upgrade the tier of the eligible members.
Assess Member Tier by Using Flows: Configure a flow to assess and upgrade the tier of members. Use Data Processing Engine to find the members who are eligible for a tier upgrade and a decision table to choose the tier that an eligible member can be upgraded to.
Assess Member Tier by Using Loyalty Program Process: Configure a Tier Processing type loyalty program process to change the tier of your members. To help assess and change member tiers based on your required schedule, use a Batch Management job to run the tier change process.
Essential Transaction Security Policies to Enhance Your Security Posture: Transaction Security Policies (TSPs) provide a dynamic and automated way to monitor and control user interactions with your Salesforce data, adding a crucial layer of security by responding to suspicious activities in real-time. These TSPs are some of the best for enhancing your security posture. TSPs are organized by Security Lenses, a group of topics that shows how security teams usually look at risk and enforce policy.
Traceability with Rebate Member Aggregate Items: Transaction journals are linked to rebate member product aggregates through the Rebate Member Aggregate Item. This linkage provides visibility into the origin of total quantities and transaction amounts.
Apply Promotions and Update Members' Progress: When processing transaction journals, use Flow actions to find promotions that are applicable for a transaction and the transaction's associated member. Use the Apply Promotion template flow to apply selected promotions to members. The flow template can credit points or issue a voucher.
Field History Tracking Overview: Select certain fields to track and show field history in an object history list. When Field Audit Trail is turned off, Salesforce retains field history data for up to 18 months, and up to 24 months via the API. If Field Audit Trail is turned on, Salesforce retains field history data until you manually delete it. The retention values serve as reminders and field history data can be deleted at any time. Field history tracking data does not count against storage limits.
Track Object Field History: Turn on field history tracking for standard or custom objects in the field history tracking settings. Changes made to a field are added to the History related list of an object. You can monitor changes to business critical fields, or audit text fields for values that might require extra security, privacy, or access controls.
Trailblazer Accounts: A Trailblazer account is a single identity that you use to log in to and interact with multiple Salesforce-related sites.
Export and Import Flexcards: Import or export Flexcards to use them in another org, such as when you create them in a sandbox or to use sample data packs that Salesforce provides. When exporting or importing data packs for Flexcards, if you encounter Apex limit errors such as heap or CPU limits, reduce the size of the data pack by unselecting dependencies during the export process. Additionally, break the data pack into multiple smaller data packs. As a best practice, we recommend including no more than 10 elements in each data pack.
Create a Loyalty Management Trial Org: Sign up for a Loyalty Management trial org, and get a firsthand experience of creating and managing a loyalty program.
Troubleshoot Synced Sharing: Synced Sharing can be complex, which means it’s sometimes difficult to know where document access went wrong when you or your users encounter unexpected results.
Trust Notification Guide: Trust notifications are near-real-time email or SMS notifications about service issues, maintenance events, and product releases posted to Trust Status. Subscribe to Trust notifications to receive information about the events that affect your products and services. You can receive notifications by email, SMS, or both. Trust email notifications are sent from alerts@mail.salesforce.com. Trust SMS notifications are sent from either 38767 or +447860019135.
Trust Status: Trust Status is the Salesforce website for learning about the availability and performance of your Salesforce products.
Trust User Guide: The Trust User Guide is your resource for learning how to find and interpret instance and service statuses, view informational messages, and update your settings on the Trust Status site.
Understand the Relationship Between MFA and a High Assurance Login Session (Salesforce Orgs): Certain operations in Salesforce are available only to admins and other privileged users who have a high assurance session. When multi-factor authentication (MFA) is enabled, a high assurance level of security is required to generate temporary verification codes. It’s also necessary for using the Login As feature without needing end users to respond to MFA challenges for you. If your org uses session-level policies, some sensitive actions such as accessing reports or managing IP addresses can require a high assurance session. Avoid access problems by making sure the appropriate users automatically get a high assurance session when they log in to Salesforce.
Unsubscribe From Trust Notifications: When you no longer want to receive notifications about events and instances from Trust Status, unsubscribe from all Trust notifications.
Configurations: Use these configurations to personalize Experience Cloud websites using Marketing Cloud Personalization (formerly Interaction Studio).
Design Considerations: Keep these design considerations in mind when you use Marketing Cloud Personalization (formerly Interaction Studio) to personalize Experience Cloud websites.
Run-time Workflow: Learn how data flows through the configurations when you use Marketing Cloud Personalization (formerly Interaction Studio) to personalize Experience Cloud websites.
Clone the Template Data Processing Engine Definitions: Loyalty Management provides a set of template Data Processing Engine definitions that can be used to automate processes for your loyalty program. Admins can clone these templates and customize them based on your loyalty program’s requirements. After the cloned definition is modified and activated, it’s available in the Flow Builder as an action. Use the action to run the definition at your required frequency.
User Roles and Access: End users, such as channel managers and partners (distributors and resellers), can efficiently manage and approve design registrations.
View and Apply Eligible Rebate Types: Account managers can use the Program Rebate Types panel to identify potential incentives and add them to a transaction using the automated screen flow.
Navigate Salesforce: At the top of each Salesforce page are tabs and links for navigating to major features in Salesforce.
Edit Your Email Settings: Specify your preferred address and name for emails sent from Salesforce, add a professional signature, and select your email composer. You can also opt to copy yourself on emails sent from Salesforce and subscribe to email alerts.
Anonymize Inactive Users: With Data Management and Right to Be Forgotten (RTBF) policies, you can anonymize data for users who no longer access your org or Experience Cloud sites. Understand the unique functionality and limitations that apply when processing data on the User object.
Personalize Your Salesforce Experience: Update your personal information, for example your email address. Change your password and security question. If you have administrator permissions, you can also customize your Salesforce org.
Personalize Lightning Experience Display: To change the look of Lightning Experience, select your preferred combination of field label alignment and the amount of space between page elements. If your admin has enabled dark mode, you can also choose whether to view Salesforce with a light or dark color theme.
Change Your Password: After you log in, you can change your password for better security. If you lost your password, click the Forgot Your Password link on the login page to reset your password via email.
Business Insights Dashboard: Analyze your rebate programs and learn how they’re affecting your business revenue. Get insights based on factors such as payouts, product sales, product pricing, and overall revenue.
Account Incentives Dashboard: Embed the Account Incentives dashboard on the Account page to monitor the impact of rebate programs on account revenue. The visualizations help you track account activity and identify products to upsell.
Operational Insights Dashboard: Embed the Operation Insights dashboard on the Rebate Program page to monitor the performance of the program, view a leaderboard of members and products, and identify products for upsell.
Orders Dashboard: Embed the Orders dashboard on the Order page to get insights into the associated rebate programs. Also, see how many purchases are required for tier upgrade.
Sales Agreement Dashboard: Embed the Sales Agreement dashboard on the Sales Agreement page to get insights into associated incentives. Track the compliance of products with incentives and devise strategies to improve overall product compliance.
Rebate Program Analysis: Get a detailed analysis of a rebate program based on member performance, rebate types, tiers, product sales, and revenue-to-payout ratio.
Rebates Insights Dashboard: The Rebates Insights dashboard provides original equipment manufacturers (OEMs) with a comprehensive view of their ship and debit rebate programs. Use the insights to track claims, analyze trends, identify high-rebate accounts, assess special-pricing impact, and optimize programs for stronger partner relationships.
Rebate Analytics Dashboards: Rebate Analytics dashboards give you actionable insights into rebate programs to help you fine-tune programs, achieve business goals, and boost product sales.
Activate a Rebate Program: Activate a rebate program to start the calculation of payouts for the enrolled members. To activate a rebate program, ensure the associated rebate types, members, and benefits are active.
Add Benefits and Benefit Mappings for a Rebate Type: Create benefits for a rebate type to define the thresholds of an incentive and how payouts are scaled for varying quantities and amounts. Add benefit tiers with a range of sales targets and applicable benefit values. Introduce granularity to the incentive structure by adding benefit-mapping criteria. With additional criteria, you can differentiate benefits by account territory, product category, ship-from location, and more.
Add a Member List to a Rebate Program: Enroll multiple members in a rebate program. Add an Accounts list view to a rebate program through the Members related list.
Enroll Members to a Rebate Program: Add partners, dealers, and distributors as members to a rebate program. Add Account records to a program to enroll members. Add one account at a time, or use an existing Accounts list view to enroll multiple members. You can enroll an account in multiple rebate programs. View the enrolled members on the Members related list of a rebate program record.
Activate a Rebate Program: Activate an advanced rebate program to start the calculation of accruals and payouts for the enrolled members. To activate a rebate program, ensure the associated rebate types, members, and benefit tiers are in Active status.
Add Benefit Mappings: Create qualifying criteria for your benefits to differentiate them by product category, region, and other business-specific dimensions. To introduce the criteria into the benefit structure, map similar fields in the Program Rebate Type Benefit and the Transaction Journal objects.
Add Benefits and Benefit Mappings for a Rebate Type: Create benefits for an advanced rebate type to define thresholds and how payouts are scaled. You can introduce granularity by adding benefit-mapping criteria, which the engine uses as Anchors during high-volume processing in Data Cloud.
Add a Member List: Enroll multiple members in a rebate program. Add an Accounts list view to a rebate program through the Members related list.
Add a Single Member: Add one account at a time to a rebate program and specify member details.
Calculation Engine and Data Output: When a rebate type's Calculation Basis is set to Payout or Payout and Accrual, the advanced engine executes a coordinated sequence of six DPE definitions on Data Cloud. The engine automatically runs delta calculations to evaluate new or modified transactions since the last run, aggregating high-volume data without affecting core org performance.
Clone a Rebate Program and Rebate Type: Use the Clone and Clone with Related actions on Rebate Program and Program Rebate Type records to copy a record along with its related records. For Advanced Rebate programs, this allows you to quickly replicate independent accrual and payout configurations for new regions or periods.
Create Benefits: Add benefits to a rebate type to define qualifying ranges and benefit values for each range. View and edit benefits from the Benefits tab on a Rebate Type record.
Create Payout Periods for a Rebate Program: Create payout periods to establish the specific timeframes for settling payouts within your program. Payout periods are based on the (payout) Frequency of the program and can differ from accrual periods.
Create an Advanced Rebate Program: Create a rebate program to offer incentives to your partners when they meet agreed-upon targets. Specify the details of the program such as its duration, accrual period frequency, payout frequency, and program description.
Create Rebate Types for a Program: Define a type of incentive for members with an advanced rebate type. In Advanced mode, the engine uses Source Matching Fields to link high-volume transactions to members. Create rebate types from the Related tab of a rebate program record. Define rebate types to specify the incentive structure within a rebate program. A rebate program can include multiple rebate types, each representing a different strategy, such as volume, revenue, or growth. To configure a rebate type, create a Program Rebate Type record. Define the calculation logic, eligibility, benefit thresholds, and product associations to determine how rebates are calculated and paid out.
Create Rebate Types with APIs: You can create program rebate types for migration and integration purposes by using APIs that are available with Rebate and Accrual Management Advanced. However, to define the eligibility criteria for rebate types that are created by using APIs, ensure that you complete these additional steps.
Define Product Eligibility for Rebate Types: To define when an advanced rebate applies to a product or a list of products, configure a filter on the program rebate type. The calculation engine uses this filter in Data Cloud to include or exclude specific transactions from the accrual and payout calculations.
Enroll Members to a Rebate Program: Add partners, dealers, and distributors as members to a rebate program. Add Account records to a program to enroll members. Add one account at a time, or use an existing Accounts list view to enroll multiple members. You can enroll an account in multiple rebate programs. View the enrolled members on the Members related list of a rebate program record.
Examples - Rebate and Accrual Calculation: Explore these real-world implementation scenarios to see how the Data Processing Engine (DPE) calculates financial liabilities, processes high-volume transaction data in Data Cloud, and applies program rules across various business models.
How Are Accruals Calculated?: Define the calculation basis of a rebate type and add an Accrual Frequency to specify how often to track financial liabilities. In the Advanced engine, you can decouple accruals from payouts to recognize accounting liabilities more frequently than cash disbursements.
How Are Payouts Calculated?: Define the calculation basis of a rebate type and add a payout Frequency to specify how often payouts are settled. In the Advanced engine, payouts run on Data Cloud and you can decouple payouts from accruals so that cash disbursements settle on a different cadence than the accounting liabilities you recognize.
Manage Accruals and Payouts: With Rebate and Accrual Management Advanced, you can calculate accruals and payouts for rebate types independently. Program managers can view the accrual and payout information for each member and each accrual period.
Rebate Type Fields: Review the fields in a Program Rebate Type record and understand how they work together to create an incentive structure. You can create a rebate type from the Related tab of a Rebate Program record.
Review Accruals and Payouts on Member Records: When Advanced Rebates is enabled, Rebate Program Member record pages feature dedicated Payout and Accrual tabs to give program managers and finance teams clear visibility into calculated financial metrics.
Run a Rebate Program for AMER and LATAM Partners (Example): This example shows how an administrator in an automotive company configures an end-to-end advanced rebate program to calculate monthly accruals for channel partners using Data Processing Engine definitions on Data Cloud.
View Accruals in Experience Cloud: Partners can view rebate program information and calculated accrual and payout amounts through the Experience Cloud site. This provides transparency into accrued financial liabilities for the programs they're enrolled in.
View Rebate Program and Accrual and Payout Information: Partners can view rebate program information and accrual and payout amounts in Experience Cloud sites. Configure partner access to enable them to monitor accrual and payout calculations for their enrolled programs.
Clone a Rebate Program and Rebate Types: Use the Clone and Clone with Related actions on Rebate Program and Program Rebate Type records to copy a record along with their related records.
Add Mappings to Vary Benefits by Criteria: Create qualifying criteria for your benefits to differentiate them by product category, region, and other business-specific dimensions. To introduce the criteria into the benefit structure, map similar fields in the Program Rebate Type Benefit and the Rebate Member Product Aggregate objects.
Create Benefits for a Rebate Type: Add benefits to a rebate type to define qualifying ranges and benefit values for each range. View and edit benefits from the Benefits tab on a Rebate Type record.
Create Payout Periods for a Rebate Program: You can manually create payout periods or automatically generate them for each rebate program. If you choose to automatically generate payout periods, they’re generated based on the program's frequency. Payouts are calculated during an active period and finalized at the end of each period. View the payout periods on the Payout Periods related list of a rebate program record.
How Do the Fields Work Together in a Rebate Type?: Review the fields in a Program Rebate Type record and understand how they work together to create an incentive structure. You can create a rebate type from the Related tab of a Rebate Program record.
Create a Rebate Program: Create a rebate program to offer incentives to your partners when they meet agreed-upon targets. Specify the details of the program such as its duration, payout period frequency, and program description.
Create Rebate Types for a Program: Define rebate types to specify the incentive structure within a rebate program. A rebate program can include multiple rebate types, each representing a different strategy, such as volume, revenue, or growth. To configure a rebate type, create a Program Rebate Type record. Define the calculation logic, eligibility, benefit thresholds, and product associations to determine how rebates are calculated and paid out.
Create and Manage Rebate Programs: Create a rebate program to reward your partners when they attain specific sales targets. Enroll program members and create payout periods. Set up rebate types within a rebate program. Add benefits, additional benefit criteria, and eligibility rules for rebate types. Track transactions and aggregated payout data for members.
Adjust Payout Amounts: Adjust payout amounts for a member and get the updates approved. Program managers can adjust the system-calculated payout amount for a period to reverse or roll back the payouts for a member. Typical use cases include changes in incentive terms, or when the payout amounts are adjusted for other amounts such as enrollment fee, or previous balance. Adjustments can be submitted for approval using the standard approval flow.
Define Eligibility for a Rebate Type: Filter transaction journal records applicable for a rebate type by defining eligibility rules. Based on the eligibility criteria, a member’s transaction records are considered or discarded for payout calculations.
Rebate Configuration Checks: A configuration check reviews whether a rebate program is set up correctly. A check on a Program Rebate Type record identifies common issues, including missing benefits, date mismatches, payout period gaps, mapping issues, and invalid eligibility fields. The check runs before program execution to catch setup errors early and ensure accurate calculations and payouts.
Set Record Type Preferences: Set an option to automatically insert your default record type when you create records. If you use this setting, you’re no longer prompted to select a particular record type.
Change Your Security Question: If you forget your password and have to reset it, you’re sometimes required to verify your identity by answering a security question that you previously chose. You can change the security question and answer on the Change My Password page in your personal settings.
Reset Your Security Token: To access Salesforce via a desktop client or via the API from an IP address that’s not in your company’s trusted IP range, use a security token. A security token is a case-sensitive alphanumeric code. Depending on how you access Salesforce, you either append the security token to your password or enter it in a separate field in a client application.
Verify Your Identity for Your Salesforce Org with a Temporary Code: If you don’t have access to the verification method that you usually use for multi-factor authentication (MFA), ask your Salesforce admin to give you a temporary verification code. The code is valid for 1 to 24 hours. Your admin sets the expiration time, but you can expire the code early if you no longer need it.
Create Shortcuts to Salesforce Pages with Favorites: Quickly access important records, lists, groups, and other frequently used pages in Salesforce. A favorite is similar to a bookmark in a web browser, but your favorites list is always available regardless of the browser or computer that you use to log in to Lightning Experience.
Personalize the Navigation Bar in Lightning Experience: Customize an app’s navigation bar so that the user interface suits the unique way you work. You can add and reorder items, and rename or remove items you’ve added.
Vertical Navigation Bar Personalization: Use the App Launcher to change what apps appear on the vertical navigation bar. Quickly access your most-used apps so you can work more efficiently.
Add Products and Licenses with the Your Account App: Purchase new products and licenses for your Salesforce org using the Your Account app. Products are pieces of Salesforce functionality, such as Sales Cloud, Sales Dialer, or extra file storage.
Manage Your Salesforce Account: Add products and licenses, manage your contracts and renewals, view and download invoices, access the Go-To-Market app, and get account support right in your org with the Your Account app.
Monitor Login History: As an admin, you can monitor all attempts to log in to Salesforce and to your Experience Cloud sites. The Login History page shows up to 20,000 records of user logins for the past 6 months. To see more records, download the information to a CSV or GZIP file.
Manage Your Contracts with the Your Account App: See all your contracts in one place and request updates to your Salesforce org with the Your Account app. The keys to the ignition that keep your org running are just a few clicks away.
Set Up an Experience Cloud Site for Rebate Management: Use Experience Cloud to give your partners access to Rebate Management. Create an Experience Cloud site where partners can view the rebate program and payout details and submit their claims and proof-of-sale documents. You can use the predefined Manufacturing Experience Cloud template to create a site for partners. You can also use an existing site in your org, or create a site from scratch and add the Rebate Management objects to your Experience Cloud site.
View Program Member Payout Details: After an admin configures the payout calculation schedule, payouts are calculated and created as Rebate Program Member Payout records. Rebate payouts are created in the Program Rebate Type Payout Source, Program Rebate Type Payout, and the Rebate Program Member Payout objects. Program managers can also view the payout details in the Member Payouts related list of Rebate Program Payout Period records.
Submit Rebate Claims: Customers and partners can input rebate claims either directly or from the Experience Cloud site. These documents can be validated against standard business rules, and partners and customers can edit and resubmit the claims if there are any errors.
Get Support with the Your Account App: Ask product questions, manage billing, get technical support, and send us feedback, all from the Your Account app. Find these contact options on the app’s home page.
Turn on the Your Account App: Use the Your Account app to add products and licenses, manage your contracts and renewals, view invoices, and get account support right in Salesforce. Manage your subscription to Your Account using the Manage Subscription setting.
Manage Your Quotes with the Your Account App: You can manage quotes and complete your purchase using the Pending Quotes tab on the Salesforce Contract page. Review and sign, approve, and place your order using Your Account.
Update Billing Contact Access to the Your Account App: Make sure that the billing contact on each Salesforce contract has access to the Your Account app by granting access from the Contract page or through Setup. When you give billing contacts access to Your Account, users get the permissions they must have to manage their billing and contracts.
Give Tab Access in Your Account: The Your Account app allows you to switch between your most frequent account management tasks by using a tabbed horizontal navigation menu. Tab settings determine the visibility of tabs in apps and navigation menus. If user profiles or permission sets don’t have tab visibility enabled, they can’t view the Your Account, Product Catalog, Your Contracts, and Your Invoices tabs. To make sure your team can use Your Account, give them permission to view tabs in their related user profile or permission set.
Manage Renewals: When your annual contract reaches 90 days before its renewal date, it’s indicated on the Contracts and contract details pages. You can confirm the renewal, request changes, or choose not to renew. We can’t accommodate cancellation requests until it’s time to renew.
View and Download Invoices: In the Your Account app, you can review and download invoices and credit memos.
Give Your Billing Users Free Access to the Your Account App: Use Identity licenses to give your users access to the Your Account app if they don't need full access to Salesforce. The editions that support the Your Account app include 100 free Identity licenses that can be assigned as needed by the admin. Save your Salesforce licenses for the members of your team who need them.
Update Personal Information: Update your name, phone number, email, address, and work information on the Personal Information page in My Settings.
Check for Desktop Client Updates: Desktop clients such as Salesforce for Outlook and Connect Offline integrate Salesforce with your PC. Your administrator controls which desktop clients you are allowed to install.
Edit Your Meeting and Availability Settings: Specify when you’re available for meetings. When you invite someone to choose a meeting time, they see available times only for the hours you set. These meeting settings are used when you select Add Scheduling Link or Add Next 3 Available Times in an email with Outlook or Gmail email integration or Salesforce’s email
My Settings: Update Your Personal Settings: Your personal settings help you customize your Salesforce experience. View or update your personal settings like your password and security question, email settings, and organize your tabs and pages.
Verify OAuth Policy and Settings Generation: When the OAuth Plugin is deployed, several external client app components are generated. There are a few places you can check to verify if the deployment was successful.
Apply Promotions Based on Members' Segments: When processing a transaction journal, you can apply promotions based on the associated loyalty program member's segment. If you’re using a loyalty program process to process transaction journals, the rule that’s associated with the promotion automatically filters transactions that don’t belong to members who are part of the promotion’s segment. If you’re using a flow to process transactions, an action to determine which promotions are applicable for a member based on their segment. Or, you can use an API to find the member's segment and the promotions associated with the segment.
View Member Benefits: You can view member benefit details, the status of benefits, and the records created or updated by Benefit Actions.
View and Track Member Promotions: View the promotions offered to a member in the loyalty program. For Cumulative type promotions, you can track the member's progress towards achieving the promotion's target usage.
View and Manage Privacy Jobs: See details about the jobs for your Data Management and Right to Be Forgotten policies. You can also cancel, reschedule, or immediately run privacy jobs.
View Rebate Payouts Using ARC Graphs: Track rebate relationships by viewing or creating Actionable Relationship Center (ARC) graphs. View connections between transaction journals and member payouts, and add graphs to record pages for clear insights into data dependencies.
Automatic Generation of Voucher Codes: You can configure a voucher definition to ensure that codes of the vouchers issued by using the voucher definition are automatically generated. The codes that are automatically generated contain a prefix and a suffix that you specify. The codes also consist of alphanumeric characters that make the voucher code unique and you can specify the length of the alphanumeric characters in the voucher definition.
About Digital Wallet: Welcome! Digital Wallet is a free account management tool that's your one-stop hub for viewing and analyzing your footprint across your Salesforce product portfolio.
Access Digital Wallet: You can access Digital Wallet from the Digital Wallet app or the Your Account app. The Digital Wallet app provides access to all Digital Wallet features.
Buying Models for Consumption-Based Products: Salesforce consumption-based products, such as Agentforce and Data 360, have multiple buying models: pre-purchased, pre-committed, pay-as-you-go, and unlimited. Digital Wallet supports the usage tracking and analysis for all of these buying models.
Change a Consumption Threshold for a Specific Card: Learn how to configure the Digital Wallet Consumption Threshold Alerts flow to only send notifications when a specific card reach a certain usage threshold.
Change Who Gets Consumption Threshold Alerts: By default, the Digital Wallet Consumption Threshold Alerts flow sends notifications to all users who are assigned the System Administrator profile. However, you can change the flow behavior to send notifications to users who belong to a public group or are assigned a specific permission set.
Consumption Analytics Dashboard (Tableau Next): The Consumption Analytics dashboard, powered by Tableau Next, provides deeper and actionable usage insights. It enables you to drill down to granular analysis for standard consumption tags, for example, flex credits usage per agent or action, and Data 360 consumption by resource.
Consumption Analytics Consumption Explorer: The Consumption Analytics dashboard’s Consumption Explorer section contains visualizations that drill down deeper to show consumption based on a specific dimension, such as agent, agent action, or Data 360 source.
Consumption Analytics Consumption Overview: The Consumption Analytics dashboard’s Consumption Overview section contains a metric and visualizations that give you a high-level overview of what’s driving consumption. This information includes total credits consumed, daily credits consumed by consumption card, sources and usage types that use the most consumption, as well as a consumption forecast by consumption card.
Install the Consumption Tagging App: The Consumption Tagging app contains the required metadata and objects (data lake objects and semantic data models) for consumption tags and the Tableau Next assets for the Consumption Analytics dashboard. This Tableau Next dashboard uses billing data and standard consumption tags to provide you with granular insights, interactive visualizations, and usage forecasts.
(Optional) View the Consumption Tagging App Installation Artifacts: The Digital Wallet setup page indicates when you have successfully installed the Consumption Tagging app. However, you can optionally dig deeper to verify that the metadata, objects, and Tableau Next assets were installed, and where you can see them.
Understand Root Resource and Resource IDs: The Digital Wallet data model includes two key identifiers, “Root Resource ID or API Name” and “Resource ID or API Name,” that capture what consumes credits in your consumption-based products. Knowing when each field populates or remains empty helps you accurately interpret usage reports and pinpoint what’s driving consumption.
Share Consumption Tags for Enhanced Support: Share your consumption tags data to receive enhanced support and maximize your Salesforce investment. By default, your Digital Wallet consumption tags are private. You can opt to share this data to unlock enhanced support, tailored recommendations, and strategic guidance based on your specific usage patterns.
Create a Report or Visualization on Usage by Data Space: If you use multiple data spaces, you can build a Data 360 report or Tableau Next visualization that breaks down consumption by data space. Data is often partitioned by region, business unit, geography, or security requirements. Select a method based on the reporting tool that you want to use and the underlying data objects available to you.
Create a Report on Usage by Data Space Using Our DMO: Build a Data 360 report that breaks down consumption by data space by using the Additional Info data space attribute. If you use multiple data spaces, you can create reports to see granular consumption data based on how you partitioned that data. Data is often partitioned by region, business unit, geography, or security requirements. This method shows you how to create a calculated field from the Consumption Insights Extended data model object (DMO). You don’t incur any costs to use this method.
Create a Report on Usage by Data Space Using Our DLOs: Build a Data 360 report that breaks down consumption by data space by joining the TenantEnrichedUsageEvent and TenantUsageAttrDetail data lake objects (DLOs).
Create a Tableau Next Viz on Usage by Data Space: Build a Tableau Next report that breaks down consumption by data space by using the Additional Info data space attribute. If you use multiple data spaces, you can create reports to see granular consumption data based on how you partitioned that data. Data is often partitioned by region, business unit, geography, or security requirements.
Create a Report on Usage by User ID: Build a Data 360 report that uses the User ID field to see which individual users are driving Agentforce credit consumption in your org. Because you build this report directly on the TenantEnrichedUsageEvent data lake object (DLO), you don't incur costs.
Build Custom Reports for Consumption Insights: Beyond the predefined reports, the underlying tagged data in Data 360 provides more tailored insights through the TenantEnrichedUsageEvent data lake object (DLO). You can create your own custom reports and dashboards based on your unique business needs.
Build a Data 360 Report Based on Your Custom Tags: After you have your tags defined and have assigned them to resources, you’re ready to build a report. For example, if you create a tag group called Department and assign the tag Marketing to a data stream, a new calculated field called Department is created in the extended semantic data model (SDM). You can then start building reports using this field, such as to see consumption by Department.
Manage and Report on Business-Specific Custom Tags: Track and optimize your consumption through your specific business lens. Custom consumption tags empower you to gain deeper, business-specific insights by creating and managing your own tags to track consumption based on unique categories, such as department and cost center.
Objects Used for Custom Consumption Tags: Digital Wallet creates and populates these objects. Some of these objects are installed as part of Digital Wallet, while others are installed as part of the Consumption Tagging app. You can access these objects in Data 360 in the Data Lake Objects, Data Model Objects, and Semantic Layer tabs.
How Usage Events Are Tagged: When a resource that you’ve tagged is running and generating usage, the resulting usage events are automatically stamped in the background with the custom tags that you applied to that resource, approximately every 24 hours.
Digital Wallet-Enabled Consumption-Based Products: Consumption-based products that have been enabled in Digital Wallet have an associated consumption card on the Consumption Cards tab in Digital Wallet. You can also find links to each product’s rate card and information on what counts as usage (usage types).
Understand Entitlement Pooling for Data Cloud One: In a Data Cloud One configuration, Data 360 pools your entitlements in the home org, while all other products, such as Flex Credits, keep separate entitlements in the org in which usage is generated.
Digital Wallet FAQ: Find answers to frequently asked questions about how to understand how Digital Wallet works, interpret your consumption data, and understand billing discrepancies.
Match Prompt ID to Prompt Name to Interpret Report Data: After you build a report for tracking Generative AI (GenAI) consumption by prompt, the reports lists the prompts using the prompt ID or API name. The API name usually mirrors the actual prompt name; however, the internal prompt ID isn’t descriptive enough to identify which prompt. But we’ll show you how to map the prompt ID with the prompt name.
Build a Report for Generative AI Prompts Usage: Build a Data 360 report for Generative AI (GenAI) prompts for Flex Credits from scratch that uses the Calculated Insights data model object (DMO). Using this DMO to build a report from scratch allows you to create a completely custom report structure.
Track Consumption for Generative AI Prompts for Flex Credits: For enterprises running Agentforce, tracking consumption by agent, action and usage type might not be enough. But how do you know which Generative AI (GenAI) prompt for Flex Credits is generating the highest consumption? You build a Data 360 report that breaks down consumption by GenAI prompt.
Get Notified When You Cross Usage Thresholds: Digital Wallet provides several flow templates that offer solutions for proactively managing your org’s resources by notifying stakeholders when specific utilization thresholds are reached. Instead of manually monitoring usage, you can establish automated guardrails by using flows to flag critical milestones, such as 80% consumption or 95% license allocation.
Get Digital Wallet Support: Learn how to get help with your Digital Wallet integration, usage data, or overages related to Digital Wallet-enabled products.
Digital Wallet Glossary of Terms: Review Digital Wallet’s key terms to help you understand your consumption data in Digital Wallet’s interface.
View License Utilization in Digital Wallet: License Utilization is your one-stop hub for viewing your seat-based licenses information in Digital Wallet. License Utilization provides a clear, unified picture of the products you’ve purchased and their corresponding licenses. It provides accurate, real-time data, in a single, trusted place. All license data, including metrics, percentages, and totals, pertain to the org where you’re viewing the license information.
Manage License Utilization Threshold Alerts and Notifications: Create License Utilization alerts and notifications by using the provided templates. The templates make it easy to indicate the licenses to monitor and who to notify when the thresholds are met.
Create a License Utilization Notifications Flow: After you configured which licenses to monitor and defined the thresholds to trigger alerts, you can create the flow for alert notifications. You can send notifications to members of a profile, permission set, or public group. You can also create separate notification flows for each member group.
Send License Utilization Alerts to a Profile's Users: Send alerts to everyone assigned to a single specific profile. Because the License Utilization Notification template is configured to notify via the System Administrator profile by default, no flow changes are required if this is the profile you want to notify. However, you can swap out the System Administrator profile and indicate another profile, without any other flow modifications required. Use this method when your alert audience maps cleanly to an existing profile.
Export License Utilization Data: Export your license utilization data to a CSV file to review it holistically or analyze it in an external tool.
Send License Utilization Alerts to Multiple Profiles: Send alerts to everyone assigned to the specified profiles. Because the License Utilization Notification template’s default behavior is to send notifications to only the System Administrator profile, the flow requires some changes.
Monitor Usage for Consumption-Based Products in Digital Wallet: Digital Wallet Consumption Cards provides consumption information for monitoring and observing usage trends over time. It uses Data 360 core features to collect usage data from various services, process it in near real-time, and store the consumption records as data lake objects (DLOs). This architecture allows Digital Wallet to provide granular, unified tracking of consumption-based products, including Data 360, Agentforce, and more.
Consumption Overviews in the Monthly Account Summary: The Monthly Account Summary email is a monthly usage statement you can use to get an overview of your org’s consumption. Learn more about it on this page.
Multi-Contract Consumption in Digital Wallet: A multi-contract scenario happens when your company purchases the same Digital Wallet entitlement under multiple contracts on the same org. Learn how to identify a multi-contract sceanrio in Digital Wallet.
View Consumption Insights for a Data Cloud One Companion Org: By default, the predefined (out-of-the-box) Consumption Insights reports provide you with granular insights for consumption billed to your home org. To view reporting for consumption billed to a companion org, you simply save a copy of a relevant report and add a filter to narrow consumption details to just the companion org.
Export Data from a Digital Wallet Data 360 Report: To analyze Digital Wallet consumption data in an external business intelligence (BI) tool, you can export the data from one of our Data 360 pre-defined reports or a custom Data 360 report built on the TenantEnrichedUsageEvent data lake object (DLO).
Consumption Insights Dashboard (Data 360 Reports): As part of Data Cloud provisioning, the Consumption Insights dashboard is installed. This Data 360 dashboard contains several predefined (out-of-the-box) reports that were built using standard consumption tags. How you complete the configuration to view the reports depends on if you're a new or existing Data 360 customer.
Access and View the Consumption Insights Dashboard: The Digital Wallet Consumption Insights dashboard gives you an easy entry point to the out-of-the-box (predefined) reports that leverage standard consumption tags. These reports give you a granular view of your consumption by agent, action, and other consumption sources. Each dashboard widget shows a bar chart so you can quickly visualize consumption information, and has a link to its corresponding report.
Digital Wallet Permissions: To access Digital Wallet and its features, users require a combination of user permissions, permission sets, and licenses. To access Digital Wallet, you must have a Data 360 license and not a Customer Data Platform (CDP) license.
Track Product Limits Utilization: Track your product limits in Digital Wallet to stay on top of your usage and proactively plan for your organization's capacity needs. Product Limits provides a single view of your purchased allowances and utilization, helping you manage overall product limits consumption.
Create the Product Limit Alerts Flow: Create a scheduled flow to monitor product limits and send custom notifications when usage thresholds are crossed.
Query Digital Wallet Data in Tableau: To analyze and visualize Digital Wallet data in Tableau, you can link to Data Cloud with Tableau’s Data Cloud Connector and query directly from Digital Wallet’s Data Lake Objects (DLOs). Learn how on this page.
Report On Usage by Feature With Digital Wallet: To gain deeper insights into your consumption for specific features, you can build a custom report to monitor and analyze usage patterns. For a streamlined setup, you can base your new report on the out-of-the-box Consumption by Feature report found in the Consumption Insights dashboard. Optionally, to boost the readability of your report, you can swap the cryptic developer (API) feature name for the customer-facing feature name by creating a batch data transform.
Create a Report from the Consumption by Feature Report: Leverage the existing Consumption by Feature report in the Consumption Insights dashboard to quickly build a custom report to track and monitor specific features of interest. This method is the quickest and easiest way to build a consumption report by feature.
Digital Wallet Report by Feature Examples: After you create your own version of a Consumption by Feature report, you can decide which features you want to track consumption for in this report. Here are some example feature reports for some popular Salesforce features.
Display User-Friendly Feature Names in Your Report: To increase readability of your Digital Wallet feature report, you can swap cryptic Feature Developer (API) Names for the customer-facing feature name. You accomplish this goal by creating a batch data transform that maps the feature developer name to the user-friendly provisioned feature name.
Spot Potential Overages with Digital Wallet: Learn how to spot potential consumption overages in your org’s via your Digital Wallet homepage, the Digital Wallet Consumption Insights page, the Consumption Threshold Alerts flow, or the Monthly Account Summary email, if you receive one.
TenantBillingUsageEvent Data Lake Object: The TenantBillingUsageEvent data lake object (DLO) captures the raw consumption data sent from a service to Digital Wallet.
TenantEntitlementTransaction Data Lake Object: The TenantEntitlementTransaction data lake object (DLO) represents the entitlements available for an org. Entitlements have a start and end date, and supported usage types. This object tracks what you purchased, your contract IDs, and their associated entitlements.
TenantEnrichedUsageEvent Data Lake Object: The TenantEnrichedUsageEvent Data Lake Object (DLO) is an enriched version of the TenantBillingUsageEvent DLO, specifically created and optimzed for consumption reporting. In addition to capturing raw usage data, it contains standard consumption tags that provide metadata alongside billing usage to enable further slicing and dicing for more advanced insights. This DLO fuels the data provided in the Digital Wallet out-the-box-reports and dashboards, and enables you to build your own custom reports. And best of all, you can create reports directly from it, and you don’t incur any costs when building a report based on it.
Troubleshoot Digital Wallet: Find solutions and guidance for common issues you can encounter when using Digital Wallet and its associated features.
TenantUsageAttrDetail Data Lake Object: The TenantUsageAttrDetail data lake object provides the ability for you to create reports for additional Data 360 attributes, for example, by data space. We plan to add additional attributes over time.
TenantUsageTypeMultiplier Data Lake Object: The TenantUsageTypeMultiplier data lake object (DLO) captures the information used when calculating the TenantHourlyEntitlementConsumption. The multiplier determines the rate at which consumption is calculated according to your contract. This information determines how Digital Wallet converts raw usage to consumption credits for the specified usage type and usage subtype.
Get Actionable Insights with Standard Consumption Tags: Consumption tags are a framework that provides enhanced transparency into your consumption-based products. Digital Wallet provides a set of standard consumption tags, which are additional metadata alongside the standard billing metrics. These tags provide more granular data that enables you to uncover deeper insights into usage patterns. Reports built with standard consumption tags provide visual representations of what agents, usage types, features, and sources (to name a few) are driving consumption and help you determine where you want to further invest.
Digital Wallet Data Lake Objects (DLOs): During the Digital Wallet setup process, Digital Wallet creates data streams and data lake objects (DLOs) in your org. These DLOs capture your raw consumption data and track your entitlement usage on both an hourly and daily basis. They apply contractual multipliers to convert raw usage into consumption credits, all while keeping a record of the specific entitlements your company has purchased. Our enriched DLO provides critical metadata that fuels ready-to-use reports and dashboards. It also enables you to create powerful custom reports, letting you easily slice and dice your data to find advanced insights.
Trailblazer Single-Use Codes: A Trailblazer account provides the ability to sign up and log in using an email address, without creating a password. Trailblazer verifies your identity by using a single-use code.
When to Use Omniscript Edit Blocks and Blocks: To decide when to use edit blocks and blocks, check if you need to limit repeating the block, directly modify sObjects, show fields when the block is collapsed, display the block in different layouts, or use the custom LWC element.
Who Is Salesforce Identity For?: Salesforce identity services are for all users who interact with your Salesforce org, Experience Cloud sites, other apps, and other services. These users are employees, customers, potential customers, and partners of your company, and they all have unique identity needs.
Customize Widgets with Components and Data of Your Choice: Use Loyalty Widget Designer to customize the look and feel, and text of a widget. To use custom components or data of your choice, use the Apex classes of the widget templates based on your requirements. To add a custom icon or a new merge field in the widget, customize the widget’s Apex class to update the widget.
Apex Class for the View Member Badges Widget Template: Customize the View Member Badges widget template by adding to the widget, components, and data that aren’t available by default. For example, customize the widget to show the three badges that the member is close to achieving based on their activity.
Apex Class for the Select Member Benefits Widget Template: Customize the Select Member Benefits widget template by adding to the widget, components, and data that aren’t available by default. For example, add the Description field below the benefit name to show members the details of each benefit.
Apex Class for the View Member Benefits Widget Template: Customize the View Member Benefits widget template by adding to the widget, components, and data that aren’t available by default. For example, add benefits and make benefits that have expired in the last month unavailable.
Apex Class for the Refer Friends Widget Template: Customize the Refer Friends widget template by adding to the widget, components, and data that aren’t available by default. For example, add a state that shows the member’s five most recent referrals.
Apex Class for the View Member Profile Widget Template: Customize the View Member Profile widget template by adding to the widget, components, and data that aren’t available by default. For example, add an icon that shows the member’s profile picture on the widget.
Apex Class for the Remind About Expiring Points Widget Template: Customize the Remind About Expiring Points widget template by adding to the widget, components, and data that aren’t available by default. For example, add merge field that also shows the member’s current points balance.
Apex Class for the View Cumulative Promotion Progress Widget Template: Customize the View Cumulative Promotion Progress widget template by adding to the widget, components, and data that aren’t available by default. For example, replace the progress bar with a progress indicator of your choice.
Apex Class for the Join Promotion Widget Template: Customize the Join Promotion widget template by adding to the widget, components, and data that aren’t available by default. For example, add a merge field for a custom Promotion field.
Apex Class for the View Transaction History Widget Template: Customize the View Transaction History widget template by adding to the widget, components, and data that aren’t available by default. For example, add a component that can be used by members to download their transaction receipts.
Apex Class for the View Active Vouchers Widget Template: Customize the View Active Vouchers widget template by adding to the widget, components, and data that aren’t available by default. For example, add icons for each voucher.
View Member Badges Widget Template: The View Member Badges widget template lets members view the badges currently assigned to them. The widget displays badges based on their start date, with the badge with the nearest start date listed first.
Select Member Benefits Widget Template: The Select Member Benefits widget template can be used to let members select benefits from the ones available to them. Loyalty program managers can decide the benefits to be made available on the widget, for selection by the members.
View Member Benefits Widget Template: The View Member Benefits widget template lets members view the tier benefits and personalized benefits that have been assigned to them. The widget displays benefits alphabetically based on the name of the benefit.
Clone Member Engagement Widget FlexCards: Loyalty Management provides widgets as FlexCard templates. Before you customize a widget, clone the widget’s FlexCard template.
Clone Member Engagement Widget Templates: Loyalty Management provides 11 member engagement widget templates. Clone a widget template, and then customize the widget to suit your use case and your company’s requirements.
Activate and Embed Loyalty Management Widgets: Embed member engagement widgets on Experience Cloud site pages or on external portals. After you customize your widget and test it in preview, activate the widget, and embed it.
Clone Child Cards of Widget FlexCards: Some member engagement widgets use child cards to show the details. Clone a child card and then make the desired changes. After you customize a cloned child card, embed the child card in the parent FlexCard. You can also activate a child card and use it as an independent FlexCard.
Remind About Expiring Points Widget Template: The Remind About Expiring Points widget template lets members view the number of points about to expire and the date that the points are set to expire on. The widget shows members the points set to expire for their non-qualifying currency. If a loyalty program has two non-qualifying currencies, then the expiring points of the primary currency are shown.
Activation and Download of Widget FlexCards: After you customize and activate a widget FlexCard, a Lightning Web Component (LWC) is generated for the widget. Use the LWC to embed the widget on Experience Cloud site pages and on Lightning pages. After you activate a widget FlexCard, download the widget’s LWC and use the LWC to embed the widget on external websites by using OmniOut.
Learn About Member Engagement Widgets: The Member Engagement Widgets templates in Loyalty Management can be cloned and customized by using Loyalty Widget Designer within the Loyalty Management app or by using OmniStudio’s FlexCard Designer. Each widget template has personalized content and design. Modify the content and the design as per your requirements.
Loyalty Widget Designer: Loyalty Widget Designer is a point and click canvas that lets you customize the widgets that you’ve cloned by using the widget templates. After you customize your widgets, you can preview, activate, and download the widgets.
View Member Profile Widget Template: The View Member Profile widget template lets members view their current points balance, their current tier, and their membership number. The widget also consists of a logo that you can replace with your company logo or your loyalty program’s logo.
OmniStudio FlexCard Designer: Customize Loyalty Member Engagement widget templates by using OmniStudio FlexCard Designer. To add components to or remove components from a widget, use FlexCard Designer.
Prerequisites for Working with Member Engagement Widgets: The member engagement widget templates in Loyalty Management are based on Omnistudio Flexcards. You can deploy widgets on your company’s website or external portals by using OmniOut or Lightning Out 2.0. Before loyalty program managers create and customize widgets, complete the prerequisites.
Join Loyalty Program Widget Template: The Join Loyalty Program widget template lets your customers join your loyalty program. Customers can fill up a simple form within the widget and join your loyalty program.
Apex Class for the Join Loyalty Program Widget Template: Customize the Join Loyalty Program widget template by adding to the widget, components, and data that aren’t available by default. For example, add a button that redirects members to your shopping site after they’ve joined the loyalty program.
View Cumulative Promotion Progress Widget Template: The View Cumulative Promotion Progress lets members view their progress towards achieving the target of an engagement attribute. The widget also contains a button that redirects members to your shopping site.
Join Promotion Widget Template: The Join Promotion widget template lets members join a promotion. Loyalty program managers can choose the promotion that is shown on the widget.
Refer Friends Widget Template: Members can use the Refer Friends widget template to refer their friends and family to join the loyalty program. The widget lets members share their referral code across their social media accounts.
Preview Widgets in Loyalty Widget Designer: After you customize widgets, preview them by using data from your org, before you embed the widgets on websites and external portals. The preview lets you verify whether a widget is working as expected and also to check if the widget style is as per your branding requirements.
View Transaction History Widget Template: The View Transaction History widget shows members the most recent transactions. The widget provides the flexibility to show members a set of transactions in the compact view. Members can expand the widget to view more of their recent transactions.
View Active Vouchers Widget Template: The View Active Vouchers widget template lets members see the vouchers that they can redeem. Members can also view the name, description, expiration date, and code of their redeemable voucher. The widget also enables members to copy the code of the widget. The widget doesn’t show expired vouchers and the vouchers that members have already redeemed. The widget displays vouchers based on their expiration date, with the voucher with the nearest expiration date listed first.
Customize the Loyalty Member Portal: The Loyalty Member Portal home page is ready to brand and personalize your member experience. You can use the out-of-the-box components provided by Experience Cloud site to customize the portal.
