Retrieve Lighting App Utility Bar with package.xml

How to retrieve App/Custom Application With package.xml

Retrieve Utility Bar In Salesforce

Syntax to retrieve lightning app Utility Bar with package.xml

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

Explanation:

In Salesforce we we two types of applications

  1. Custom Apps
  2. Standard Apps

Both types app application are supported in Salesforce Classic & Lighting Environment. If we created app for salesforce lightning view then we can cannot leverage that classic view.

Find how to retrieve apps metadata using package.xml.

Utility Bar provides users with quick access to productivity tools. To retrieve utility bar metadata we use FlexiPage as metadata type.

What is FlexiPage in Salesforce?

The Utility Bar of a Lightning app is stored as a FlexiPage. Retrieving it gives you the list of utility items, their size, and their position for that app.

Steps to retrieve it in VS Code

  1. Open your Salesforce DX project in VS Code and authorize your org with SFDX: Authorize an Org.
  2. Open manifest/package.xml, or create the file, and paste the XML shown above.
  3. Right-click package.xml and choose SFDX: Retrieve Source in Manifest from Org.
  4. When the command finishes, open the folder force-app/main/default/flexipages to see the retrieved files.

The member name is the app developer name followed by _UtilityBar. If the retrieve returns nothing, open the app in Setup and check that it has a Utility Bar configured.

Retrieve it with the Salesforce CLI

If you prefer the terminal, run one of these commands from your project folder:

sf project retrieve start --manifest manifest/package.xml
sf project retrieve start --metadata FlexiPage:AppDeveloperName_UtilityBar

Where the files are saved

After a successful retrieve, the files are placed inside your project, for example in force-app/main/default/flexipages/AppDeveloperName_UtilityBar.flexipage-meta.xml.

Common problems and fixes

  • Entity of type FlexiPage cannot be found: check the spelling and the API name of the member, and make sure you are authorized to the correct org.
  • Nothing was retrieved: run sf org list to confirm the default org, and check that the component actually exists there.
  • API version: the examples use version 62.0. You can use a higher version if your org supports it.

FAQ

Why is the Utility Bar a FlexiPage?
Lightning stores the Utility Bar like a Lightning page, so the Metadata API uses the FlexiPage type for it.

Do I need to retrieve the app as well?
Only if you also want the app definition. The Utility Bar file is separate from the CustomApplication file.

Looking for Job Change?

Find company wise Interview Questions Here:

Leave a Reply