[SalesForce] How to activate a Lightning Page via metadata

I am deploying a solution which includes Lightning Pages and I would like to programmatically activate the FlexiPage in the target org when it is deployed.

In the Configure Lightning Experience documentation it describes Activation on Save or performed later using the Activation button.

Is it possible to programmatically activate a Lightning Page as the default for an object or must it be activated manually after deployment?
Where is the default Lightning Page per object stored in metadata?

Best Answer

[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.

Related Solutions

[SalesForce] Activate Lightning Record Page via Metadata API

I have the same issue and spent quite a lot of time to find the solution. Unfortunately, there are nothing about ability to activate Lightning record page via API. So it turns out that we have only Lightning App Builder for now to do this. Finally I left post at IdeaExchange. Hope Salesforce could offer any solution in the future.

Lightning – How to Override Standard Buttons with a Custom Lightning Page

After a day of searching, I wasn't able to come up with an easy answer, so I implemented a work-around. I wrapped my Lightning component in a VisualForce page and overrode the content source for the New and Edit actions to use the new host page. Using Lightning within a VisualForce page takes some work. See the link below to get started.

Use Lightning Components in Visualforce Pages

Here's the code I wrote to get things working. One issue I'm still researching is getting the force:* events (ex: force:showToast and force:navigateToObjectHome) to fire correctly. I added them as a dependency with no luck.

Host.page

<apex:page standardcontroller="CallReport__c">
    <!-- This page is a host page for the call report lightning component. -->
    <apex:includeLightning />

    <div class="slds">
        <div class="slds-grid slds-grid--align-center slds-p-around--small">
            <div class="slds-large-size--3-of-12"></div>

            <div class="slds-size--1-of-1 slds-large-size--6-of-12">
                <div id="callReport"></div>         
            </div>

            <div class="slds-large-size--3-of-12"></div>
        </div>
    </div>

    <script>
        var recordId = '{!callreport__c.id}';

        // c:callReport implements force:hasRecordId and requires the call report ID
        $Lightning.use("c:DepApp", function() {
          $Lightning.createComponent('c:callReport',
              { recordId : recordId },
              'callReport',
              function(cmp) {
                // do some stuff
              });
        });
    </script>
</apex:page>

DepApp.app

<aura:application access="GLOBAL" extends="ltng:outApp">
    <aura:dependency resource="c:callReport"/>
    <aura:dependency resource="markup://force:*" type="EVENT"/>
</aura:application>

Best Answer

Related Solutions

[SalesForce] Activate Lightning Record Page via Metadata API

Lightning – How to Override Standard Buttons with a Custom Lightning Page

Related Topic