[SalesForce] How to update a namespaced Custom Metadata Type record after making a package

Here's the situation:

We have a Lightning App that reads from a Custom Metadata Type to populate a settings/configuration page.
Then you can edit the page and click save and that will create a Metadata.CustomMetadata object with containing details (such as fullName and Label, along with the configuration fields) which it then sends to Metadata.Operations.enqueueDeployment.

This all works perfectly in an unmanaged environment (Both namespaced and not). Once it's put into a managed package though, the behavior becomes strange. Instead of updating the record with the package's namespace, it instead makes a new record without any namespace (or with the namespace of the local org if ther is one).

So our product is looking at the namespaced record for it's configurations. I am able to manually edit the namespaced one (It's not protected, either the object or the record) but whenever the app tries to update it, it makes a new record. Second and third updates change this newly created record as well (it doesn't always make new records).

The question here is:
How do I assign a namespace to the Metadata object records. We tried NameSpace__value as the MasterLabel and that just saved all in one string, making NameSpace__value the MasterLabel. We tried writing directly to the NamespacePrefix field and it responded with a "no such field" error. We got the same error when trying to write to DeveloperName.

I'm not including code here but it's as simple as could be, because it works fine in all non-packaged tests, I just need to know how to assign a namespace to the Custom Metadata Type record.

Thank you for your time an assistance in this.

Best Answer

The app needs to be using the full, qualified name of the record. If both the type and the particular record are in NameSpace, you need:

cm.fullName = 'NameSpace__type.NameSpace__record'

Related Solutions

[SalesForce] SFDX & How to handle namespace in lwc with a managed package

Thanks @Anshul Agrawal, you've confirmed what I figured out yesterday. For others facing the same issues, here's what I've discovered:

You don't need to include the package namespace in the @import for apexMethods or fieldnames. Within the javascript file, it appears to pick up on Apex's ability to adapt to the namespace.

However, if you want to use any of the lightning components like lightning-record-edit-form, when you put the api-object-name into the html tags, you DO need to add the namespace to both the object name, as well as any fields you specify in the markup. These components interact with the server without any explicit apex intervention, so you have to include the namespace.

Therefore, in answer to my own question #2, yes, I'm working in a scratch org with my package namespace. To accomplish that, first you have to link the packaging org that owns the namespace to your dev hub.

Then you have to specify the namespace in the scratch-org definition file in VS Code. You'll find that file in .sfdx/config/whatever.json. This is the definition file you'll specify as you create the scratch org. Looks like this...

{
"orgName": "your Company",
"edition": "Enterprise",
"namespace": "your_namespace",
"orgPreferences" : {
    "enabled": ["S1DesktopEnabled"],
    "disabled": ["S1EncryptedStoragePref2"]
}

}

[SalesForce] LWC “Record Detail Page” for Custom Metadata Type

OK, the main part of the answer turns out to be...

Put your LWC in an Aura component that implements lightning:isUrlAddressable (see ref)

Here's an example with a Custom Metadata Type called Region__mdt. You can access it via the relative URL /lightning/cmp/c__Region?c__apiName=YOUR_IDENTIFIER_HERE:

Region.cmp (Aura)

<aura:component implements="lightning:isUrlAddressable" description="Region: {!v.apiName}" >
    <aura:attribute name="apiName" type="String" />
    <aura:handler name="init" value="{!this}" action="{!c.onPageReferenceChange}"/>
    <aura:handler name="change" value="{!v.pageReference}" action="{!c.onPageReferenceChange}"/>
    <!-- Embed the LWC like this -->
    <c:regionDetail apiName="{!v.apiName}" />
</aura:component>

RegionController.js (Aura)

({
    onPageReferenceChange: function(component) {
        var myPageRef = component.get('v.pageReference');
        component.set('v.apiName', myPageRef.state.c__apiName);
    }
})

regionDetail.html (LWC)

<template>
    <header class="slds-page-header slds-page-header__row slds-page-header__col-title slds-media slds-m-bottom_medium">
        <lightning-icon class="slds-media__figure" icon-name="custom:custom78"></lightning-icon>
        <h1 class="slds-media__body slds-page-header__name slds-page-header__name-title slds-page-header__title">
            {region.Label}
        </h1>
    </header>
    <section class="slds-box slds-theme_default">
        <dl class="slds-list_stacked">
            <dt class="slds-item_label slds-text-color_weak slds-truncate">Region ID</dt>
            <dd class="slds-item_detail slds-truncate slds-m-bottom_small">{apiName}</dd>
            <dt class="slds-item_label slds-text-color_weak slds-truncate">Area Factor</dt>
            <dd class="slds-item_detail slds-truncate slds-m-bottom_small">{region.Area_Factor__c}</dd>
        </dl>
    </section>
</template>

regionDetail.js (LWC)

import { LightningElement, api, track, wire } from 'lwc';
import getRegion from '@salesforce/apex/RegionController.getRegion';

export default class RegionDetail extends LightningElement {
    @api apiName;
    @track region = {};

    @wire(getRegion, { developerName: '$apiName' })
    loadRegion(response) {
        if (response && response.data) {
            this.region = response.data;
        }
    }
}

RegionController.cls (Apex)

public with sharing class RegionController {
    @AuraEnabled(cacheable=true)
    public static Region__mdt getRegion(String developerName) {
        return [SELECT DeveloperName, Label, Area_Factor__c
            FROM Region__mdt WHERE DeveloperName = :developerName];
    }
}

Best Answer

Related Solutions

[SalesForce] SFDX & How to handle namespace in lwc with a managed package

[SalesForce] LWC “Record Detail Page” for Custom Metadata Type

Related Topic