UiPreviewMessageTabDef Metadata Type in SFDX

Architectural Overview#

The UiPreviewMessageTabDef metadata type defines tabbed message preview interfaces utilized by contact center agents and service representatives within Salesforce Service Cloud and Digital Engagement consoles. Modern customer service interactions span a diverse spectrum of asynchronous channels—including SMS, WhatsApp, social direct messaging, and in-app chat.

Before dispatching sensitive transactional communications or structured interactive templates (such as authentication requests or payment links), service agents must preview exactly how content will render on recipient mobile devices. UiPreviewMessageTabDef provides the declarative schema that binds communication channels, preview layout tabs, and validation renderers into a unified console surface.

Directory and File Conventions#

In the Salesforce DX project repository, UiPreviewMessageTabDef metadata files reside within the uiPreviewMessageTabDefs/ directory.

Key Metadata Fields#

The XML schema for UiPreviewMessageTabDef incorporates the following key properties:

Declarative XML and Package Manifest Examples#

Below is an enterprise XML definition for a multi-channel customer service preview tab:

<?xml version="1.0" encoding="UTF-8"?>
<UiPreviewMessageTabDef xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelType>WhatsApp</channelType>
    <developerName>WhatsAppCarePreview</developerName>
    <isActive>true</isActive>
    <masterLabel>WhatsApp Customer Care Preview</masterLabel>
    <tabLabel>WhatsApp Preview</tabLabel>
    <targetComponent>c:whatsAppMessageRenderer</targetComponent>
</UiPreviewMessageTabDef>

Manifest Definition (package.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>WhatsAppCarePreview</members>
        <name>UiPreviewMessageTabDef</name>
    </types>
    <version>68.0</version>
</Package>

CLI Retrieval and Deployment Commands#

Manage UiPreviewMessageTabDef records using the Salesforce CLI:

# Retrieve all message preview tab definitions
sf project retrieve start --metadata UiPreviewMessageTabDef

# Retrieve a specific tab definition
sf project retrieve start --metadata UiPreviewMessageTabDef:WhatsAppCarePreview

# Deploy to a target scratch org or sandbox
sf project deploy start --metadata UiPreviewMessageTabDef:WhatsAppCarePreview --target-org service-dev

Architect Best Practices and Gotchas#

• Feature Entitlements: Always ensure destination environments have Digital Engagement or Messaging entitlements provisioned before initiating deployment to prevent unentitled feature errors.
• Component Lifecycle Synchronization: Package the rendering component specified in targetComponent within the same deployment changeset or unlocked package to prevent broken preview panels.
• Multi-Channel Consistency: When standardizing contact center agent workflows, create corresponding preview tab definitions for every supported messaging channel to maintain a uniform agent experience.

Frequently asked questions

What does UiPreviewMessageTabDef configure in Salesforce Service Cloud?

It defines preview tabs that allow contact center agents to review outbound messages, interactive templates, and omni-channel communications before delivery.

How do you retrieve UiPreviewMessageTabDef metadata with Salesforce CLI?

Use sf project retrieve start with the metadata flag set to UiPreviewMessageTabDef to fetch all message tab definitions into your local project repository.

Which messaging channels are supported by preview tab definitions?

Supported channels include SMS, WhatsApp, Facebook Messenger, Apple Messages for Business, and in-app customer service chat channels.

Does deploying UiPreviewMessageTabDef require active Digital Engagement licenses?

Yes, deploying messaging preview components requires an active Digital Engagement or Service Cloud Messaging license in the destination environment.