[SalesForce] How to Retrieve & Deploy Salesforce Lightning Theme using metadata api

We created a custom Lightning Theme (Setup > User Interface > Themes and Branding) in the sandbox and have to push it to another org using Metadata API.

We were able to retrieve Branding Set from Source Org by specifying below in package xml, however, when we deploy the same to Target org (Specified in package xml & Branding Set folder is available in src), it doesn't show up in the Target org.

<types>
    <members>LEXTHEMINGMy_Theme</members>
    <name>BrandingSet</name>
</types>

Do you know the right way of deploying Themes & Branding using metadata API?

Based on the Answer below, I used following package XML to retreive all the components related to my Lightning theme

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>ThemeName</members>
        <name>BrandingSet</name>
    </types>
    <types>
        <members>ImageName</members>
        <members>BG_ImageName</members>
        <name>ContentAsset</name>
    </types>
    <types>
        <members>ThemeName</members>
        <name>LightningExperienceTheme</name>
    </types>
    <version>43.0</version>
</Package>

Best Answer

Add this to your package and this will work:

<types>
    <members>YourThemeHere!!!</members>
    <name>LightningExperienceTheme</name>
</types>

If you don't know what your theme name is, you can reference it by checking what's in the masterLabel tab within your brandingSet xml file.

I had the same problem and found the solution by searching the metadata within the workbench. https://workbench.developerforce.com/login.php

Related Solutions

[SalesForce] How to retrieve translations using Metadata API

Include your objects in that package.xml and you will be golden. Here is what your package.xml should look like:

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>Account</members>
        <members>AccountContactRole</members>
        <members>Activity</members>
        <members>Asset</members>
        <members>AssistantProgress</members>
        <members>Campaign</members>
        <members>CampaignMember</members>
        <members>Case</members>
        <members>CaseContactRole</members>
        <members>CaseMilestone</members>
        <members>Contact</members>
        <members>ContentVersion</members>
        <members>Contract</members>
        <members>ContractContactRole</members>
        <members>ContractLineItem</members>
        <members>DuplicateRecordItem</members>
        <members>DuplicateRecordSet</members>
        <members>Entitlement</members>
        <members>EntitlementContact</members>
        <members>Event</members>
        <members>FeedItem</members>
        <members>ForecastingAdjustment</members>
        <members>ForecastingCategoryMapping</members>
        <members>ForecastingOwnerAdjustment</members>
        <members>ForecastingQuota</members>
        <members>ForecastingTypeToCategory</members>
        <members>Idea</members>
        <members>Lead</members>
        <members>LiveAgentSession</members>
        <members>LiveChatTranscript</members>
        <members>LiveChatTranscriptEvent</members>
        <members>LiveChatTranscriptSkill</members>
        <members>LiveChatVisitor</members>
        <members>Macro</members>
        <members>MacroAction</members>
        <members>MacroInstruction</members>
        <members>Opportunity</members>
        <members>OpportunityCompetitor</members>
        <members>OpportunityContactRole</members>
        <members>OpportunityLineItem</members>
        <members>PartnerRole</members>
        <members>Pricebook2</members>
        <members>PricebookEntry</members>
        <members>Product2</members>
        <members>Question</members>
        <members>QuickText</members>
        <members>Quote</members>
        <members>QuoteLineItem</members>
        <members>Reply</members>
        <members>ServiceContract</members>
        <members>Site</members>
        <members>SocialPersona</members>
        <members>Solution</members>
        <members>StreamingChannel</members>
        <members>Task</members>
        <members>Territory2</members>
        <members>Territory2Model</members>
        <members>User</members>
        <members>UserProvisioningRequest</members>
        <members>UserTerritory2Association</members>
        <members>WorkBadge</members>
        <members>WorkBadgeDefinition</members>
        <members>WorkThanks</members>
        <members>*</members>
        <name>CustomObject</name>
    </types>
    <types>
        <members>*</members>
        <name>CustomObjectTranslation</name>
    </types>
    <version>36.0</version>
</Package>

You may not need all the standard objects that I have listed here but this is what I have found works best.

[SalesForce] Retrieve fields under a certain Custom object using Metadata API/Metadata Service class

Found the answer, I used ReadMetadata of CRUD based calls to get custom field names of certain custom object. Pass the custom object name to below method to get the list of Field names.

public static list < String > readCustomObjectSync(String objectName) {

    //Creating a Service for Callout
    MetadataService.MetadataPort metadataConnection = createService();

    //Checking for namespace
    MetadataService.DescribeMetadataResult describeRes = metadataConnection.describeMetadata('36.0');
    if(describeRes!=null){
        List<MetadataService.DescribeMetadataObject> objectList = describeRes.MetadataObjects;
        String namespace = describeRes.organizationNamespace;

        if(objectName.contains('__c')) {
            if(namespace != null && namespace !='') {
                objectName=namespace+'__'+objectName;
            }
        }
    }

    List <String> objectNames = new List <String>();
    objectNames.add(objectName);

    List <String> fieldName = new List <String>();

    try {
        MetadataService.IReadResult readResult = metadataConnection.readMetadata('CustomObject', objectNames);
        MetadataService.Metadata[] mdInfo = readResult.getRecords();
        System.debug('Number of component info returned: '
                     + mdInfo);
        for (MetadataService.Metadata md : mdInfo) {
            if (md != null) {
                MetadataService.CustomObject obj = (MetadataService.CustomObject) md;
                System.debug('Custom object full name: '+ obj);
                if(obj.fields != null) {
                    for(MetadataService.CustomField field : obj.fields) {
                        if(field != null) {
                            fieldName.add(field.fullName);
                            System.debug('Field Name: ' + field.fullName);
                        }
                    }
                }
            } else {
                System.debug('Empty metadata.');
            }
        }
    } catch (Exception ce) {
        System.debug('exception ' + ce.getMessage());
    }

    return fieldName;
}

Best Answer

Related Solutions

[SalesForce] How to retrieve translations using Metadata API

[SalesForce] Retrieve fields under a certain Custom object using Metadata API/Metadata Service class

Related Topic