Overview:

MergeUp offers a simple number formatting function to enhance the display of numerical values in your document templates. Whether you need to format numbers sourced from Salesforce merge fields or calculate them dynamically within JavaScript, this function has you covered. In this comprehensive guide, we will walk you through the syntax, parameters, provide practical examples, and share some important notes to help you make the most of this versatile number formatting function.

Syntax

{# n(field, locale) #}

Parameters:

• field: This parameter represents the numeric value you want to format. It can be a merge field from Salesforce or a variable containing a numeric value calculated in JavaScript within your template.

• locale (optional): The locale parameter accepts any valid BCP 47 language tag, which specifies the desired language and region format for the number. Here is the full list of accepted values: BCP 47 Language Codes List - AppMakers.Dev

Examples:

Example 1: Formatting a Merge Field

Imagine you have a template based on Salesforce opportunities, and you want to display the number of opportunity line items in your document. You can achieve this by using the n function as follows:

{# n(Opportunity.Number_of_Lines__c) #}

Assuming the template defines the locale as 'en-US,' and there are 1,050 related opportunity line items, the output would be as follows:

1,050

Example 2: Formatting a Calculated Number

In situations where you need to calculate a numeric value within your template and format it, you can utilize the n function as well. Let's say you want to display the number of opportunity line items but don't have a corresponding merge field. You can calculate the number within your template and then format it:

{#!
numOfOLIs = 0;
for (let i = 0; i < Opportunity.OLIs.length; i++) {
    numOfOLIs += 1;
}
#}
{# n(numOfOLIs, 'en-US') #}

This code calculates the number of opportunity line items, and the n function formats it using the 'en-US' locale. If there are 1,050 line items, the output will match the formatting convention for 'en-US':

1,050

Notes:

• If you don't specify a locale, the function will default to using the locale settings defined in your template or organization.
• Ensure that the field parameter contains a valid numeric value; otherwise, the function will return an empty string.
• You can easily adapt the n function to your specific document formatting needs, whether it involves currencies, decimal places, or other numerical formats.