Loading
Get Started with Communications, Media, and Energy & Utilities (CME)...
Table of Contents
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

          Search all of Salesforce Help
          Additional Lookup or Other Line Item (OLI) Fields in Additional Settings

          Additional Lookup or Other Line Item (OLI) Fields in Additional Settings

          This section explains how to configure specific line item and lookup fields for display in the Additional Settings panel of the CPQ interface using the additionalCustomJson configuration.

          Adding Line Item Fields

          To display specific line item fields in the Additional Settings panel, define them in theadditionalCustomJson configuration using the following format.

          {"additionalFields": "FieldAPIName1,FieldAPIName2"}

          Configuration Details: A comma-separated list of API names for each field to display.

          Requirements:

          • Field must already be part of the getCartsItems API response.
          • Fields must have their isHidden attribute set to false.
          • Editable fields must have the editable attribute set to true.JSON structure example for defining line item fields in the Additional Settings panel
          Example
          Example JSON Configuration
          {
            "additionalFields": "ProductCode,Description"
          }
          

          Adding Type and Formatter Fields

          These new parameters can help you provide customized inputs.

          "additionalFields": [
          
            {
          
             "field": "vlocity_cpq9__EffectiveOneTimeTotal__c",
          
             "type": "number",
          
             "formatter": "currency"
          
            },
          
            {
          
             "field": "vlocity_cpq9__RecurringManualDiscount__c",
          
             "type": "number",
          
             "formatter": "percent"
          
            },
          
            {
          
             "field": "vlocity_cpq9__CatalogItemReferenceDateTime__c",
          
             "type": "datetime"
          
            }
          
           ]

          Adding Lookup Fields

          Lookup fields reference related records. To display lookup fields in the Additional Settingspanel, define them in the lookupFieldssection of the additionalCustomJson.

          {
            "lookupFields": [
              {
                "fieldName": "vlocity_cmt__ServiceAccountId__r",
                "hidden": false
              },
              {
                "fieldName": "vlocity_cmt__BillingAccountId__r",
                "hidden": false
              }
            ]
          }
          

          Configuration Details:

          • API name of the lookup field, typically ending in __r.
          • Set to false to make the field visible in the Additional Settings panel.

          Requirements:

          • Lookup fields must be part of the getCartsItems API response.
          • Lookup fields must follow a naming convention ending in __r, signifying their relational structure.
          Example
          Example JSON Configuration
          {
            "lookupFields": [
              {
                "fieldName": "vlocity_cmt__ServiceAccountId__r",
                "hidden": false
              },
              {
                "fieldName": "vlocity_cmt__BillingAccountId__r",
                "hidden": false
              }
            ]
          }
          

          Adding Decimal Precision

          You can choose the maximumFractionDigits between 0 to 5 according to your preference in your additionalCustomJson script. Here is the format for the JSON configuration:

          
          {  "decimalPrecision": {   "maximumFractionDigits": "3"  } }
          
           
          Loading
          Salesforce Help | Article