Download PDF
Download page Installed Products Settings.
Installed Products Settings
Custom settings for the Installed Products page in CPQ.
Setting | Description |
---|---|
Account Hierarchy Batch Size | Enter the number of Account Hierarchy records processed for each batch execution. Recommended value is 500. Valid values range from 1 to 2000. |
Alert Asset Related To Renewal Cart | Select this setting to display a warning on the Installed Products page when the user tries to manually renew an asset associated with a system-generated renewal quote or renewal agreement. The setting is not selected by default. |
Allow Backdated Termination | This setting is disabled by default, that means, user cannot terminate an asset by specifying an end date to any date prior to the current date. End date should be greater than the start date. |
Allow Mass Change | Select this setting to enable user to perform mass changes for must configure assets. |
Amend Change Fields | Enter comma separated line item field names whose values can turn an existing asset line into an amended asset line. This setting is no longer used. All the editable fields honor the flow settings configured for the Cart. |
Apply Adj To Current Contract Term | Select this setting to keep the discounting limited to the current contract term. When you enable this setting, CPQ applies adjustments and calculates the net price and net unit price of the assets based on the current contract term only. When you disable this setting, CPQ applies adjustments and calculates the net price and net unit price of the assets based on the original start date of the asset. |
Asset Currency Field Precision | Enter the number of decimal places for the asset currency fields. |
Asset Restore Fields | Enter comma-separated API names of the asset fields that CPQ must restore from the original asset on reselection of option line items on the Configuration page during ABO operations. When the sales representative deselects an option and reselects it on the Configuration page during any ABO operation, CPQ restores asset values for the fields added in the Asset Restore Fields setting, for the option line item on the Cart page. However, there is an exception to restoring start and end dates during the Renew operation. CPQ restores the renewal start date and end date on reselection of an option (not the asset start and end dates) during the Renew operation. However, for this feature to work:
Due to high volume of attributes, CPQ does not restore attribute and extension attribute asset fields from the original asset on reselection of option line items during ABO operations. |
Asset Source | Enter the account source which the asset line items will be retrieved from. This setting allows you to filter the assets to be displayed on the Installed Products page based on the Ship To or Sold To or Bill To fields of an account. By default, all the assets filtered with the Sold To field are displayed. Specify the API name of the Account field that you want to use as a source for displaying assets. For example, to filter the assets based on Ship To field, enter Apttus_Config2__ShipToAccountId__c. You can specify all the three account fields and the system considers an OR condition between these fields while filtering. This is useful when an account has different locations for shipping and billing and you want to display only those assets that have been shipped to a certain location. |
Asset Termination Fields | Do not use this setting. Instead use the Asset Termination option from the Display Type picklist. For more information, see Configuring Display Columns Settings. |
Base Price Defaulting Method For Renewal | Enter a value to define how CPQ must default the base price when an asset is renewed. Valid Values are:
Other asset operations still use the net unit price for loading the asset line items. CPQ applies this setting to bundle and its options similarly (that means, a bundle cannot have a higher price while its options have a lower price). You can define this setting at a flow level; however, the flow-level setting overrides the setting defined at Primary Settings. |
Cotermination Preferences During Renewal | Enter one or more of the following values (comma separated values, without space) to allow the user to determine renewal end dates.
You must enter at least one value in this setting. If you have more than one value, you must also select a default value in the Default Renewal Cotermination Option setting. If you do not select any default value, the first of the selected values is considered as the default value. Depending on the selected setting, users can now bypass the Confirm Renewal intermediate page altogether.
|
Create Renewal Opportunity | Select this setting to enable CPQ to create a renewal opportunity for system generated asset renewal quotes. This setting indicates if you want to create renewal opportunities along with renewal quotes. By default, this check box is not selected. This is to prevent the system from running into locking issues when an account has a large number of assets and the batch process creates the renewal opportunities for all these assets. When this setting is true, the Create Renewal Opportunity scheduled job runs and creates the renewal opportunities along with renewal quotes. When this setting is false, the Create Renewal Opportunity scheduled job runs and does not create the renewal opportunities and creates only the renewal quote. |
Default Cotermination Option | Enter the default end date preference for cotermination. |
Default Renewal Cotermination Option | Enter the default end date preference for renewal cotermination. If there is only one value in the Cotermination Preferences During Renewal setting, that option is selected by default. If there are more than one options, you can select a value as a default renewal cotermination option. Based on the default option, CPQ loads the selected renewal transactions on the Installed Products page, Confirm Renewal popup, or Confirm Renewal intermediate page. |
Default Renewal Price List | Enter the name of the Price List which is a mandatory field for Quote creation. |
Default Renewal Term | Enter a value for a renewal term. When the value is provided use this value as the renewal term for Renewing products. The value here denotes months to renew as the end date. Ideally, your Selling Term is equal to your Default Renewal Term. |
Editable Fields for Cancelled Lines | Enter comma-separated API names of the fields that you want to make editable for cancelled lines on the cart (during asset termination). You can enter a custom currency field that is not based on a formula. You cannot enter out-of-the-box currency fields such as base price and base extended price as editable fields. |
Enable One Time Change | Select this setting to enable modifications or amendment to one-time assets. This is a global setting and cannot be restricted to apply for specific products. You can perform only amendments on one-time assets and not renewals. If you deselect this and modify the asset, the renewal quote is updated for the modified asset. If you set it to false, Renewal Opportunity and Renewal Quote are not created for the one-time only products, but if you modify the asset, the change is reflected in the Renewal Quote. It is recommended that you treat one-time assets purely as one-time sales. Any modifications or renewals should not be encouraged for one-time assets. |
End Date preferences for Cotermination | Enter comma separated values (without space) to enable the user to select one of the following end dates while coterminating incremental licenses.
|
Filter Fields | Enter the API name of Asset Line Fields to be displayed on the Filter By panel. Works with text fields, Picklist, Multi-picklist, Date, DateTime and Boolean. Commonly used fields are Start Date, End Date, Lead Time Expiration, and Asset Status. Usually, all fields under Asset Line Item object are supported but you must enter ExpirationLeadTimeInDays value in order to display Lead Time Expiration field in the Search pane. |
GroupByFields | Specify the API names of the asset line item fields that must be displayed under the Group By drop-down on the Create New View pop-up while Sales Representatives are creating views on the Installed Products page. The same GroupBy API field values will reflect on the GroupBy Fields field on the GENERAL SETTINGS tab of the Installed Products settings from the CPQ Admin UI. For more information, see Configuring Installed Products Settings. |
Hide Co-Term | Select this setting to hide the co-term end date on renew. This setting hides the Coterminate with Increment panel on the Change Quantity (Increment Asset) page. The Coterminate with Increment panel is displayed by default. |
Max Renewal Group Per Job | Enter the number of renewal groups to be processed by one batch job. This setting limits the number of renewal quotes to be processed in each batch job to avoid too many running batch jobs. |
Max Renewal Line Item Per Cart | Enter the number of renewal line items to be processed in one cart. This setting limits the size of product configuration to avoid exceeding CPU and SOQL limits. This setting determines the number of line items that renewal quotes can have in the cart. You can enter a maximum value of 1000. For example, if a cart has 5000 line items and you set Max Renewal Line Item Per Cart as 500, there will be 10 renewal quotes. |
Max Renews Per Trip | Enter the maximum number of renewal batch jobs per trip. Use a smaller number to prevent CPU timeout. The default is 20. |
Merge Action Criteria Fields | Enter comma-separated asset line item fields that must be common among the asset line items to be merged. The default fields are product, selling term, charge type, and end date. |
Purchase Identification Criteria | Enter comma separated asset line item fields that determine the eligibility for cotermination and quantity cumulation. This setting allows user to define a criteria to get coterminate related asset lines in the Coternimate with Increment section on the Change Quantity page during asset increment. The default purchase identification criteria are: Product, Charge Type, Option, and Account. CPQ currently supports only Purchase Identifier and alphanumeric custom fields. For example, if you select Purchase Identifier, during increment of a selected asset, all other assets with the same Purchase Identifier are displayed on the Coternimate with Increment section. Based on the selected purchase identification criteria, the total quantity of an asset spans multiple streams during the increment scenarios, on the Installed Products page (of a renewal quote). |
Relate Action Criteria Fields | Enter comma separated asset line item fields to enable relate asset action. This custom setting shows all fields of Asset Line Item and Price Dimensions defined on asset line item. When the user selects two or more assets and clicks Relate, CPQ validates the selected asset line items against the Relate Action Criteria Fields. In case of any discrepancies, CPQ displays a validation error message to the user. |
Renewal Business Object Type | Enter the Business object for which this renewal is taking place. Valid values are: Proposal and Agreement |
Renewal Default Price Book | Enter a Renewal Price Book name which you want to associate with renewals. |
Renewal Execution Mode | This setting indicates if the Renewal of Asset Line Items must happen automatically or based on your specified conditions.
|
Renewal Group Fields | Enter the API names of the fields you want to use for grouping. This setting indicates how to group the Asset Line Items when a Renewal Opportunity is created. For Execution mode set to Auto, the system will group the renewal Opportunity by default by the Auto Renew flag - One for the Asset Lines with Auto Renew as True and the other for Asset Lines with Auto Renew as False. For Execution mode set to OnDemand, the system can group the renewal Opportunity by Account and the Price List. However, if the implementation teams want to group the renewal opportunities by other parameters on the Asset Line Item, they can do so by specifying a comma-separated list of API names of the fields in this section. It is recommended to limit the grouping to a maximum of 4 fields. |
Renewal Lead Time | Enter a value when the renewal quote must be created after an order is activated. By default, the value is 0, which indicates that the renewal quote is created immediately after the order is activated, with the same number of Line Items in the order. If you specify 30, the renewal quote is created 30 days before the Asset End Date. |
Renew One Ramp | Select this setting to renew only one ramp line item based on the new term in order of renewal term in the asset line item, default renewal term specified in the Installed Product Setting and Selling Term defined in the asset line item. Consider a scenario where multiple ramped assets exist for a quote. In the previous releases, renewing any one of the ramped assets results in the creation of a renewal cart with the same number of ramps as the original proposal. Each ramp line is created from the original deal which implies that the uplift has to be defined from Ramp 1 for accurate prices in the subsequent ramps. Redefining and specifying details for each ramp can be cumbersome and as a user, you would expect that for a three-year ramped deal, the uplift specified on year 3 is applied on renewal to year 4. |
Show Accounts Filter | Select this setting to display accounts filter in the Installed Products page. This is currently not supported. |
Show Assets | This setting determines whether current, parent, or child assets of the current asset's account are displayed. Enter comma separated values of Parents and/or Children. If empty, only context account assets are shown. Examples:
|
Show Service Coverage | Select this setting to display service coverage for a primary service. |
Split Asset Actions | Enter the actions that can be performed on a split asset. This setting enables the user to perform split asset actions on the Define Split <asset name> page. Valid values are:
|
Submenu Actions | Enter comma-separated submenu actions that you want to display when the user clicks an action button on the Installed Products page. You can configure submenu actions only on the Change and Relate actions. The supported values are:
|