How can I navigate into sObject FieldSet View/Edit page layout from Lightning Component?

Question

I'm trying to build a component that render fields from an sObject FieldSet dynamically - The feature I'de like to add is the ability to navigate from component UI into the FieldSet page layout in order to add/remove fields as needed. Is this possible to do using standard sObject fieldSet in lightning experience mode active? is there a better approach for this functionality in lightning ? as seems like FieldSet are not completely supported within lightning... at least not yet?

Answer 1

After searching a bit more seems like the only way currently to navigate to FieldSet Edit/View page is by enforcing navigation to classic with a URL hack.

Edit/View page by Fieldset Id :

"https://<your instance url>.my.salesforce.com/<FieldsetId>"

All FieldSets by sObject Id :

"https://<your instance url>.my.salesforce.com/_ui/common/config/entity/FieldSetListUI/d?retURL=%2F0IX%2Fe%3Fsetupid%3DCustomObjects&setupid=CustomObjects&tableEnumOrId=<EntityDefinitionId>"

To Get the base URL dynamically in APEX:

private static String baseUrl = URL.getSalesforceBaseUrl().toExternalForm();

To Get the FieldSet Id - Quickest way would be to ask the admins to copy paste it once initially and store it in a place that can be query (eg.custom metadata type, sObject..) - then the FieldSetId or EntityDefinitionId can be merged into that FieldSetURL string. which from JS I just allowed the navigation onclick to :

window.location.href = FieldSetURL; 

In case someone wish to go the extra mile and fetch either the FieldSetId or EntityDefinitionId - Apparently only way to get those dynamically will be via REST Tooling API - below post shows example : https://success.salesforce.com/answers?id=90630000000Cjf2AAC

string fieldSetName = 'xxx'; // replace to the Name of your fieldSet
string query = 'Select Id,ManageableState,MasterLabel,DeveloperName,NamespacePrefix,Description,EntityDefinitionId from FieldSet Where DeveloperName=\''.replace(' ','+') +fieldSetName +'\'';

String baseUrl = URL.getSalesforceBaseUrl().toExternalForm();
String toolingAPIString = '/services/data/v43.0/tooling/query/?q='+query;
String reqMethodType ='GET';

    Httprequest request =new HttpRequest();
    request.setEndpoint(baseUrl + toolingAPIString);
    request.setMethod(reqMethodType);
    request.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionID());
    request.setHeader('Content-Type', 'application/json');

    Http httpReq = new Http();
    HttpResponse res = httpReq.send(request);
    System.debug(res.getBody());

But if the goal is to be able to move this code between orgs- Using the Tooling API will still brings extra admin efforts as setup of Remote Sites settings will be required in each org (which takes more or less same amount of time to configure as the hard coded Id copy paste solution and much less code - but it's an option).

Answer 2

Another approach that I am using, is using an update record action.

In short - you add an update record action to your object, and select the fields that you want.

Then you add this action as a Related Record component in the app builder record home of this object.

I have written a detailed answer on how to do this here:

Lightning, display object fields on a different tab

Answer 3

UPDATE

With Winter '19, Field Sets are now available in Lightning Experience.

---

As of now, accessing the Field Set is not possible in LEX and you need to Switch to Classic to do so. There is an idea for this feature to be included in LEX.

Further, based on your comment which details out your requirement where you want to facilitate this from a custom component:

Yes functionality will available only for system admins that has access to configure which fields will be available on screen. The use case is mainly just to ease the access - currently to get there you must switch to classic > go to setup > search object and look for the fieldset in order to edit which fields will be shown

As I observed with a quick test, it seems you can do what you want to achieve. I am just not sure if you should be using this approach or not because if this is for system admin only then my take will be to switch to classic instead of going this route.

But on the idea for a component, you will need to know the URL to the Field Set of the object that you are trying to reach to in Classic and then simply provide a link to it from your component, which will navigate you to the Field Set setup screen in Classic.

The example that I used was as below to open the Account's Field Set page from a custom lightning component.

Sample Component:

<aura:handler name="init" value="{!this}" action="{!c.doInit}"/>
<aura:attribute name="myUrl" type="String" />

<a href="{!v.myUrl}">Account Field Set</a>

In the JS Controller, populate the URL (the hard coded URL in the component was not saving the component, thus moved it to the JS)

doInit : function(cmp,event,helper){
    cmp.set("v.myUrl", "https://<my instance url>/_ui/common/config/entity/FieldSetListUI/d?retURL=%2Fui%2Fsetup%2FSetup%3Fsetupid%3DAccount&tableEnumOrId=Account&setupid=AccountFieldSets");
    ....
}