Salesforce CPQ – How to hide or make fields uneditable in QLE (Quote Line Editor)

					
// At the top of our QCP script, we initialise a list of fields for error reduction and easier script maintenance.

// FIELDS are frozen to make immutable
const FIELDS = Object.freeze({
    ACCOUNT_SLA: 'AccountSLA__c',
    ADDITIONAL_DISCOUNT: 'SBQQ__AdditionalDiscount__c',
    CUSTOMER_DISCOUNT: 'SBQQ__CustomerDiscount__c',
    LIST_PRICE: 'SBQQ__ListPrice__c'
});

const always = () => true; // used this to hide or lock fields without any condition
const hasListPriceLessThanOrEqual150 = (record) => record[FIELDS.LIST_PRICE] <= 150;
const hasSilverSLA = (record) => record[FIELDS.ACCOUNT_SLA] === 'Silver';

/**
 * @description array of the editability settings on quote or quoteline
 * @property {string} objectName - name of the object for which fields must be set uneditable
 * @property {string} condition - condition defining when to make fields uneditable,
 *                                access the field using square bracket property access notation, e.g. record[FIELD_NAME]
 * @property {string[]} fields - list of fields to make uneditable for the specified condition and object
 */
const editabilitySettings = {
    QuoteLine__c: [
        {
            // Make SBQQ__AdditionalDiscount__c on QuoteLine__c uneditable if SBQQ__ListPrice__c <= 150
            condition: hasListPriceLessThanOrEqual150,
            fields: new Set([
                FIELDS.ADDITIONAL_DISCOUNT
            ])
        }
    ],
    Quote__c: []
};

/**
 * @description array of the visibility settings on quote or quoteline
 * @property {string} objectName - name of the object for which fields must be hidden
 * @property {string} condition - condition defining when to hide fields,
 *                                access the field using square bracket property access notation, e.g. record[FIELD_NAME]
 * @property {string[]} fields - list of fields to hide for the specified condition and object
 */
const visibilitySettings = {
    QuoteLine__c: [],
    Quote__c: [
        {
            // Hide SBQQ__CustomerDiscount__c on Quote__c if AccountSLA__c === 'Silver'
            condition: hasSilverSLA,
            fields: new Set([
                FIELDS.CUSTOMER_DISCOUNT
            ]),

        }
    ]
};

// In Salesforce CPQ, utilise QCP for a Page Security Plugin in the Quote Line Editor (QLE) to manage field editing and viewing.
// As a best practice, avoid coding directly in PSP functions isFieldEditableForObject and isFieldVisibleForObject to maintain code readability.
// Instead, use visibilitySettings and editabilitySettings objects to centralise visibility and editability logic.
// This way, we can modify our settings and conditions and simply add or remove fields from the object as our requirements change.

/**
 * @description method used to make fields uneditable on the QLE
 * @param {string} fieldName - field name to lock from editing
 * @param {object} record - Quote__c or QuoteLine__c record containing the field to lock
 * @param {object} conn - optional parameter to access JSforce methods
 * @param {string} objectName - object that holds the field, either Quote__c or QuoteLine__c
 * @returns {boolean} field is uneditable if false
 */
export function isFieldEditableForObject(fieldName, record, conn, objectName) {
    for (const setting of editabilitySettings[objectName]) {
        if (setting.fields.has(fieldName) && setting.condition(record)) return false;
    }
}

/**
 * @description method used to hide fields on the QLE
 * @param {string} fieldName - field name to hide
 * @param {object} record - Quote__c or QuoteLine__c record containing the field to hide
 * @param {object} conn - optional parameter to access JSforce methods
 * @param {string} objectName - object that holds the field, either Quote__c or QuoteLine__c
 * @returns {boolean} - field is hidden if false
 */
export function isFieldVisibleForObject(fieldName, record, conn, objectName) {
    for (const setting of visibilitySettings[objectName]) {
        if (setting.fields.has(fieldName) && setting.condition(record)) return false;
    }
}