Parameter sublines

Use the following procedures to configure parameter sublines display:

1. Configure Line Parameters.
2. Organize Line Parameters into Line Parameter Groups.

Each Line Parameter Group with at least one subline on a line appears as a subline table below the line.

During the configuration process, each Line Parameter is tied to a specific field on the Subline record. The Line Parameter is assigned as a column to the Line Parameter Group.

Configure Line Parameters

Use one of the following options to tie Line Parameters into a single group:

• Option 1 (recommended)—Create a Line Parameter Group record.
• Option 2—Define a Group Name.

Option 1: Configure parameter sublines by creating Line Parameter Group records

You can establish a many-to-many relationship between line parameter fields and products. Specifically, you can link line parameter records to as many product lines as you need. For example, if a sales rep has 1000 different products but all of them have the same two parameters—weight and length, they could create one Line Parameter Group and use this single group for agreement lines for all 1000 products.

Prerequisites

Before configuring this feature, make sure that the following fields are visible and editable:

• Subline object (Contract Subline/Deal Subline/Price Lookup Subline)
  • Is Tiered Pricing
  • Line Parameter Group
• Line Parameter object
  • Line Parameter Group
• Line Parameter Group object
  • Show Parameter Group Name
  • Field Text Wrapping
  • Column Width
  • Use Translatable Header
  • Parameter Header Text Wrap

If the fields are not visible or editable, you must confirm that they are added to the object's page layout and are visible in the user's profile. For detailed instructions on how to add fields and check for visibility, refer to Make fields visible or editable.

Define the Line Parameter Group

1. From the Lightning App Launcher, go to Line Parameter Groups tab, then select New.

2. In the New Line Parameter Group dialog, enter or select values to define the line parameter group:

   • Line Parameter Group Name—Specify a descriptive name for this line parameter group.
   • Show Parameter Group Name—Select this option to display the group name on UI.
   • Field Text Wrapping—Select the expected behavior of the field value:
     • To truncate the field value at the borders of the column, select Clip.
     • To display the full field value, select Wrap.
   • Column Width—Set the width for the column, from 50 to 1000 pixels. The default column width is 180 pixels.
   • Parameter Header Text Wrap—Select this option to automatically wrap text values of the header row fields.
   Note

   Read Use Translatable Header to review the settings that control Line Parameter Group Name column display.

3. Select Save.

Define subline parameters

1. From the Lightning App Launcher, go to the Line Parameters tab, then select New.
2. In the New Line Parameter dialog, enter or select values:

   • Line Parameter Name—Enter a descriptive name for the parameter.

   • Product—​Leave empty.

   • Subline Field—​Enter the API name of the field from the Subline object whose value should be shown in this column.

     Note

     You can use the same subline field for multiple Line Parameters across different Line Parameter Groups. This can prevent having to create multiple fields of the same type, where only one is needed. But it can also cause complexity in the configuration and in integration processes, so consider those trade-offs when determining whether to make or re-use fields​.

   • Option Type—Select the data type of the field’s value.

   • Column Width—Enter a column width. The default width is 180px.

   • Column Order—​Enter the integer value that will define the priority of the column. If you specify the same order for both columns, then the system orders columns alphabetically.

   • Parameter Group Name—​Leave empty.

   • Parameter Group Order—​Define the order of parameter groups, if there is more than one. If you specify the same order for both groups, the system orders the parameter groups alphabetically.

   • Field Text Wrapping—Select the expected behavior of the field’s value:

     • To truncate the field value at the border of the column, select Clip.
     • To display the full field value, select Wrap.
     Tip

     The Field Text Wrapping drop-down value applies only if the parameter subline field is read only. Otherwise, its content is truncated regardless of the value you select in the Field Text Wrapping dropdown list.

   • Line Parameter Group—Select the Line Parameter Group that you defined.

3. Select Save.

Repeat these steps for each field that you want to see from your parameter subline in the same group.

Manually create sublines on the line and map sublines to the new Line Parameter Group

To see the Line Parameters displayed in the UI, you must enter the following fields on the Subline record (in addition to other Subline fields mapped to Line Parameters in that Line Parameter Group):

1. The Is Tiered Pricing checkbox must be set to false.
2. The Is Active check must be set to true
3. Line Parameter Group— Enter the Line Parameter Group that you defined in the previous step.

Option 2: Configure parameter sublines by specifying Parameter Group Name field

If you use this approach, you will link every Line Parameter record to a specific Product2 record.

Prerequisites

Before configuring this feature, make sure that the following fields are visible and editable:

• Subline object (Contract Subline/Deal Subline/Price Lookup Subline)
  • Is Tiered Pricing
  • Parameter Group Name
• Line Parameter object
  • Product
  • Subline Field
  • Option Type
  • Column Width
  • Column Order
  • Parameter Group Name
  • Parameter Group Order
  • Field Text Wrapping

If the fields are not visible or editable, you must confirm that they are added to the object's page layout and are visible in the user's profile. For detailed instructions on how to add fields and check for visibility, refer to Make fields visible or editable.

Define subline parameters

1. From the Lightning App Launcher, go to the Line Parameters tab, and select New.
2. In the New Line Parameter dialog, enter or select values:

   • Line Parameter Name—​Enter a descriptive name for the parameter.

   • Product—​Enter the record of the Product2 object. This should be a product, for which you have a Line Item created, that is a parent to your Subline.

   • Subline Field—​Enter the API name of the field from subline object, value from which should be shown in this column.

     Note

     You can use the same subline field for multiple Line Parameters across different Line Parameter Groups. This can prevent having to create multiple fields of the same type, where only one is needed. But it can also cause complexity in the configuration and in integration processes, so consider those trade-offs when determining whether to make or re-use fields​.

   • Option Type—​Select the data type of field’s value.

   • Column Width—​Enter the width of the column. The default width is 180px.

   • Column Order—​Enter the integer value that will define the priority of the column. If the two columns will have the same order specified, then the system will order columns alphabetically.

   • Parameter Group Name—​Enter the name of the group, within which you want this parameter to be displayed on UI.

     Tip

     Later in the procedure you will enter the same value in the Parameter Group Name field of the Subline object.

   8. Parameter Group Order—​Enter the order of parameter groups, if there is more than one. If the two groups will have same number specified, the system will order the parameter groups alphabetically.

   9. Field Text Wrapping—​Select the expected behavior of the field’s value.

      Tip

      • If you want the field’s value to be truncated at the border of the column, select Clip​.
      • If you want the field’s value to be displayed in full, select Wrap.
        The Field Text Wrapping drop-down value applies ONLY if the parameter subline field is read-only. Otherwise, its content will always be truncated regardless of the value you select in the Field Text Wrapping dropdown list.
3. Select Save.
4. Repeat the procedure for each field that you would like to see from your parameter subline.

Create sublines and map them to the line parameters

In order to create a parameter subline and have the Line Parameters displayed on the UI, you must specify the following fields on the Subline record (in addition to other Subline fields):

1. The Is Tiered Pricing checkbox must be set to false.
2. The Is Active check must be set to true
3. Parameter Group Name—​Enter the name of the group you used in the Line Parameters.

This article details the process of configuring parameter sublines display to the user. Specifically, here you find information on what tables are shown and their order, and within those tables—which columns are shown, and their order.

Unlike tiered pricing sublines that are created by the user, parameter sublines must be created by a configurator using the following procedure: