Running Maintenance Jobs

As an administrator, you can run the following maintenance jobs.

You must execute an appropriate maintenance job after applying structural changes to the definition of categories, products, or criteria to ensure that the Sales rep does not see stale definition in CPQ application. A stale definition may cause errors in the console or application.

Prerequisites

• Go to Setup > Administration Setup > Email Administration > Deliverability. In the Access to Send Email section, ensure that the Access Level is set to All Email.
• Define Update View Product Batch Size and Update View Category Batch Size in Config System Properties.

To run a Custom Settings Maintenance job

CPQ uses custom settings to process computation on various CPQ pages. The Custom Settings Maintenance job generates static resources of the custom settings to reduce the time to fetch the values. Because the values are static, you must run the Custom Settings Maintenance Job every time you make any modification in the custom settings. Otherwise, the changes may not reflect in CPQ and the computations may get processed with stale values, resulting in incorrect configuration and pricing.

1. Go to All Tabs () > Custom Settings Maintenance.
2. Select the flow you want to run the maintenance for or select All to run maintenance for all the flows.
3. Click Update.

To run a Category Maintenance job

1. On App Menu, click Conga CPQ Admin and then click the CPQ Admin tab. The new admin console is launched.
2. Click the more icon () on the top-right corner and select Category Maintenance. The Category Maintenance window is displayed.
3. From the Hierarchy drop-down, select a particular hierarchy or All and click Update View. After the maintenance job is 100% complete, the Status column under Batch Jobs changes to Completed. 
4. Close the Category Maintenance window.

This executes an asynchronous batch job that maintains the hierarchy. After you click Update View, the administration task is complete and an updated history for all the batch jobs is displayed.

To use manual incremental update for category views

After making changes to the existing category definition you can run the Category Maintenance batch job only for changes rather than running for the entire definition. For example, if your category has 10 products and you added 5 more, you can run the Category Maintenance batch job only for the 5 additional products. To execute the Category Maintenance batch job for the changes, you must define an Admin Property that is used by CPQ to isolate the changes in the category.

Perform the following steps to add an admin entry:

1. Click the All tabs icon () and click Admin.
2. Click New to create a new Admin entry.
3. In the Name field, enter APTS_UpdateViewProductClasses. Leave the fields Value and Code blank.
4. Click Save.

Now, if you change the category definition, the Code field in the Admin property is populated with the Product Classification records of the newly added products. These records are created after you associate products to the category. When you execute the Category Maintenance batch job, the maintenance batch job is only executed for the changes and not the entire definition. In case, you want to execute a maintenance batch job for the entire definition, clear the Code field in the Admin Entry and then execute the Category Maintenance batch Job.

You must run the Category Maintenance batch job after every CPQ version upgrade.

To specify the batch size for the Category Maintenance batch job

You can use the APTS_UpdateViewApiBatchSize admin entry to specify the batch size for the Category Maintenance batch job when the job is executed using the exposed global Apex method CPQWebService.updateHierarchyViews(). The default batch size for the Category Maintenance batch job set in this global method is 2000, which is used when you have not defined the APTS_UpdateViewApiBatchSize admin entry. The behavior of the Category Maintenance batch job is same when the job is executed from the UI.

You must specify a batch size value only when you notice limit exceptions in batch jobs because of complex categories with a lot of hierarchy levels. In such cases, you must decrease the batch size to execute the batch jobs successfully. 

The maximum batch size for the Category Maintenance batch job set in the CPQWebService.updateHierarchyViews() global method is 2000. You can specify any number between 1 to 2000 in the APTS_UpdateViewApiBatchSize admin entry depending on the number of categories in the org. If you specify a value greater than 2000, CPQ will use 2000 as default. The actual batch size value to be used depends on the complexity of the categories and hence is specific to your requirements. You must arrive at the exact number through the trial and error method.

Perform the following steps to add an admin entry:

1. Click the All tabs icon () and click Admin.
2. Click New to create an admin entry.
3. In the Name field, enter APTS_UpdateViewApiBatchSize.
4. In the Value field, enter a value between 1 and 2000.
5. Leave the Code field blank.
6. Click Save.

To run a Criteria Maintenance job

1. On App Menu, click Conga CPQ Admin and then click the CPQ Admin tab. The new admin console is launched.
2. Click the more icon () on the top-right corner and select Criteria Maintenance. The Criteria Maintenance window is displayed.
3. Click one of the following buttons.
   • Update Pricing Fields: Use this command to update all Pricing Criteria fields.
   • Update Expression Fields: Use this command to update all Expression Criteria fields.
   • Update Constraint Fields: Use this command to update all Constraint Criteria fields.
   After the maintenance job is 100% complete, the Status column under Batch Jobs changes to Completed.
4. Close the Criteria Maintenance window.

To run a Bundle Maintenance Job

1. Click All Tabs icon() and click Bundle Maintenance.
2. From Product Name, select the name of the parent bundle, whose sub-bundles have been changed.
   
3. Do one or more of the following:
   • To update the selected bundle, click Update In Batch Mode.
   • To update all the bundles in the list, click Update All.

   • To update basic bundles with a limited number of options, click Update in Fast Mode.

     

     Run Bundle Maintenance in Batch Mode instead of Fast Mode if the bundle has a large number of options and sub-bundles. Bundle Maintenance in Fast mode can only be used for a limited number of options and sub-bundles. If that limit is exceeded an error is displayed.

   The system displays a confirmation message indicating that the process completed successfully.

The asynchronous task that maintains the product bundle structure is executed.

To run maintenance of view record for individual bundles

1. Navigate to the CPQ Console tab and click Manage Products.
2. Select an existing bundle to which you want to add or remove a bundle or an option.
3. Click Product Console.
4. From the Catalog section, click Manage Bundles/Options.
5. After making changes to the product association, click Update View.

The view record of the selected bundle is updated.

To run Attribute Maintenance Job

In the Classic UI, you must run the Attribute Maintenance job after you update attributes. You must execute this job after you associate attribute groups to a category or define a Product Attribute Rule (PAR) or Attribute Value Matrix (AVM) with criteria. It is not required to execute the job if you use CPQ Admin UI; CPQ executes the batch job automatically.

Follow the steps below in Classic UI:

1. Click All Tabs icon () and click Attribute Maintenance.
2. Click one of the following buttons:
   • Update Attributes: Use this command to update the attribute groups.
   • Update Attribute Rule Views: Use this command to update PAR and AVM.