[SalesForce] How a Custom Metadata Type’s field value can be referred in Lightning Component

I have an URL that was saved in a Text(255) field of the Custom Metadata Type. I wanted to refer this Url on to the Lightning component, to make my custom onClick() to redirect to this Url. How can I pass this URL to window.location.href?

Do I need to query the field in an Apex Controller class using:

Select Id, UrlField from MyPortal_Configuration_Setting__mdt

If yes, how can implement in Component's JS controller?
If no, what is the valid workaround for referring URL from Custom Metadata type? Can someone take a look at this please?

Best Answer

To redirect to an url, if you're in Lightning Experience you should make use of the force:navigateToURL event.

To get the Custom Metadata Type, I'm afraid you'll have to query the server via an Apex Controller, yes. I tried to use Lightning Data Service, but unfortunately it doesn't work with Custom Metadata. But I would definitely keep an eye on it as it would make sense to support Custom Metadata Types in LDS in the future.

Related Solutions

[SalesForce] Custom MetaData Types reference in Formula Field

Unfortunately, you can't reference custom metadata types in formulas at all. Their primary purpose is to provide metadata that's easy to package and transport between orgs, and primarily intended for use in Apex Code.

You can now reference custom metadata types in validation rules. To do so, specify the object name, record name, and field value:

$CustomMetadata.MyCustomSetting__mdt.DeveloperName.SomeFieldValue__c

[SalesForce] Parse custom metadata in lightning component

You can use the reduce function to map the values into an object you can use to refer to individual elements:

action.setCallback(this, function(response){
  var results = response.getReturnValue()
   .reduce((a,v) => { a[v.DeveloperName] = v; return a; }, {});
  component.set("v.metricMap", results);
});

At that point, you can refer to the individual items by name:

<lightning:formattedText value="{!v.metricMap.A.Value__c}" />

Note that the attribute type should be a Map, not a List.

Best Answer

Related Solutions

[SalesForce] Custom MetaData Types reference in Formula Field

[SalesForce] Parse custom metadata in lightning component

Related Topic