[SalesForce] Spring 17 Lightning metadata: Assign Record Pages by App, Record Type, and Profile

Spring '17 includes the ability to assign lightning pages with far more granularity with the functionality delivered in Assign Record Pages by App, Record Type, and Profile.

Are these assignments and activations of lightning pages by App, Record Type & Profile exposed to us in metadata that can be retrieved from the org? (to be deployed later to another org)

Best Answer

This has been exposed via the metadata API documented here

ProfileActionOverride

Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes precedence over existing overrides for the Home tab or record page specified in ActionOverride. You can only access ProfileActionOverride by accessing its encompassing CustomApplication or Profile. Available in API version 39.0 and later.

Metadata XML Sample

<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
<profileActionOverrides>
    <actionName>View</actionName>
    <content>CustomObjectFlexiPage</content>
    <formFactor>Large</formFactor>
    <pageOrSobjectType>TestObj__c</pageOrSobjectType>
    <type>Flexipage</type>
    <profile>standard</profile>
    <recordType>TestObj__c.TestRecordType</recordType>
</profileActionOverrides>
<defaultLandingTab>standard-home</defaultLandingTab>
 <formFactors>Large</formFactors>
  <label>My Custom App</label>
  <tab>standard-Account</tab>
  <tab>standard-Opportunity</tab>
  <uiType>Lightning</uiType>
  <navType>Standard</navType>
 </CustomApplication>

Package.xml

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

Related Solutions

[SalesForce] How to activate a Lightning Page via metadata

[This] can be achieved by using the following in an applications/AppName.app metadata file:

<profileActionOverrides>
    <actionName>View</actionName>
    <content>PageName</content>
    <formFactor>Large</formFactor>
    <pageOrSobjectType>Account</pageOrSobjectType>
    <recordType>Account.RecordType</recordType>
    <type>Flexipage</type>
    <profile>ProfileName</profile>
</profileActionOverrides>

Courtesy of Stephen Titley, https://success.salesforce.com/ideaView?id=0873A000000cLetQAE

And also this article: Activate Lightning Record Page via Metadata API

The docs say "The only valid values are record-home and standard-home" for <pageOrSobjectType>. You can put an sObject in there; if you haven't sub-classed record type (you are using master) you can just remove the <recordType /> element.

Lightning – Fix Losing Lightning Page’s App/Record Type/Profile Level Assignments After Deploying

The lightning app metadata (src/applications/YourAppName.app) contains the overrides for the app as a whole and also the per recordtype & profile assignments.

<CustomApplication xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionOverrides>
        <actionName>View</actionName>
        <comment>Action override created by Lightning App Builder during activation.</comment>
        <content>My_Page</content>
        <formFactor>Large</formFactor>
        <skipRecordTypeSelect>false</skipRecordTypeSelect>
        <type>Flexipage</type>
        <pageOrSobjectType>My_Object__c</pageOrSobjectType>
    </actionOverrides>
    <brand>
        <headerColor>#106550</headerColor>
        <logo>myLogo</logo>
        <logoVersion>1</logoVersion>
        <shouldOverrideOrgTheme>false</shouldOverrideOrgTheme>
    </brand>
    <formFactors>Large</formFactors>
    <isNavAutoTempTabsDisabled>false</isNavAutoTempTabsDisabled>
    <isNavPersonalizationDisabled>true</isNavPersonalizationDisabled>
    <label>My Awesome Application</label>
    <navType>Standard</navType>
    <profileActionOverrides>
        <actionName>View</actionName>
        <content>MyFlexipageName</content>
        <formFactor>Large</formFactor>
        <pageOrSobjectType>My_RecordTypedObject__c</pageOrSobjectType>
        <recordType>My_RecordTypedObject__c.RecordType1</recordType>
        <type>Flexipage</type>
        <profile>Admin</profile>
    </profileActionOverrides>
    <profileActionOverrides>
        <actionName>View</actionName>
        <content>MyFlexipageName</content>
        <formFactor>Large</formFactor>
        <pageOrSobjectType>My_RecordTypedObject__c</pageOrSobjectType>
        <recordType>My_RecordTypedObject__c.RecordType1</recordType>
        <type>Flexipage</type>
        <profile>Standard</profile>
    </profileActionOverrides>

The object level flexipage override is similarly contained in the objectName.object metadata for each object.

<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <!-- snip -->
    <actionOverrides>
        <actionName>Tab</actionName>
        <type>Default</type>
    </actionOverrides>
    <actionOverrides>
        <actionName>View</actionName>
        <comment>Action override updated by Lightning App Builder during activation.</comment>
        <content>My_Page</content>
        <formFactor>Large</formFactor>
        <skipRecordTypeSelect>false</skipRecordTypeSelect>
        <type>Flexipage</type>
    </actionOverrides>
    <allowInChatterGroups>false</allowInChatterGroups>

The profile settings themselves do not contain this flexipage assignment metadata. The profile settings does include the home tab override per profile.

<Profile xmlns="http://soap.sforce.com/2006/04/metadata">
    <profileActionOverrides>
        <actionName>Tab</actionName>
        <content>MyFlexipage_For_Home_Tab</content>
        <formFactor>Large</formFactor>
        <pageOrSobjectType>standard-home</pageOrSobjectType>
        <type>Flexipage</type>
    </profileActionOverrides>

This can all be retrieved and deployed via the metadata API, so it should work the same in Change Sets.

Update: Looking at the documentation for the ProfileActionOverrides, it looks like other profile based overrides can be selected when creating the Change Set that aren't available in a packaging scenario.

ProfileActionOverrides aren’t supported in packaging. They are supported in change sets, but you have to add them manually.

Can you confirm which elements you included as part of the change set?

Best Answer

Related Solutions

[SalesForce] How to activate a Lightning Page via metadata

Lightning – Fix Losing Lightning Page’s App/Record Type/Profile Level Assignments After Deploying

Related Topic