Access Config Settings > Installed Products Settings to see a bunch of following Renewal Field Settings.

FieldDescription
Renewal Business Object Type

Enter the Business object for which this renewal is taking place. Currently, Proposal and Agreement are supported.

Renewal Default Price BookEnter a Renewal Price Book name which you want to associate with renewals.
Renewal Execution ModeIndicates if the Renewal of Asset Line Items must happen automatically or based on your specified conditions.
  • Enter Auto to automatically create the Renewal Opportunity on Order activation.
    Make sure you check Auto Renew on the product PLI, from the Default tab. 
     
  • Enter OnDemand to create the renewal Opportunity before a certain lead time. You must enter a Renewal Lead Time for this mode to work successfully.
    To create a renewal Opportunity 90 days before the Asset Expiry, set the Execution Mode to OnDemand and Renewal Lead Time to 90.
Renewal Group Fields

Indicates how to group the Asset Line Items when a Renewal Opportunity is created. Specify the API names of the fields you want to use for grouping.

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 TimeIndicates when the Renewal Opportunity will be created after an Order is activated.
By default, the value is 0, which indicates that the Renewal Opportunity is created immediately after the Order is activated, with the same number of Line Items in the Order. If you specify 30, the Renewal Opportunity is created 30 days before the Asset End Date.
Default Renewal Price ListSpecify the Name of the Price List which is a mandatory field for Quote creation.
Create Renewal Opportunity

Indicates if you want to create renewal opportunities along with renewal quotes. By default, this checkbox 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 set to true, the Create Renewal Opportunity scheduled job runs and creates the renewal opportunities along with renewal quotes.

When set to false, the Create Renewal Opportunity scheduled job runs and does not create the renewal opportunities and creates only the renewal quote.

AutoSync Asset Changes to an Opportunity-Based Renewal Quote

When you select the Sync Assets to Quote flag on a proposal, whenever an asset is changed or updated, the asset line item in the Opportunity based renewal quote is also updated.

  • Asset-based Orders sync does not support Swap and Cancellation actions.
  • Blocking the Asset Based Order Synchronization should always be done in the renewal quote. 
  • Opting out of a renewal opportunity does not pull the line out from the auto-renewal quote.
  • For Assets having Auto Renewal Type = Evergreen, no renewal opportunities and quotes are created and the Renew button is greyed out.

Adding Picklist Values to the Proposal Object

  1. Go to the Proposal object
  2. Click to open Proposal from the Record Types.
  3. Edit the Picklist ABO Type from the list.
  4. Add New, Add-on, and Renewal to the list of Selected Values.

Renewal Email Templates

To set up the email templates:

  1. Navigate to Setup > Communication Templates > Email Templates.
  2. Create templates for Asset Renewal Notification.
  3. Select Apttus CPQ Email Templates from the Folder picklist to access existing templates or create a new one.

In the current version, you will not receive an Email notification on the generation of a Renewal Quote. 

To schedule a batch job for auto renewal

You must schedule the batch job AssetRenewalJobScheduler for the first time. This job runs every 5 minutes after you have scheduled it.

  1. Go to Setup > Develop > Apex Classes.
  2. Click Schedule Apex. The Schedule Apex page is displayed.
  3. In the Job Name field, enter a name for the job.
  4. In the Apex Class lookup, search and select AssetRenewalJobScheduler.
  5. Under Schedule Apex Execution, select the Frequency, Start date, End date, and Preferred Start Time for the job.
  6. Click Save.

To monitor the job, go to Setup > MonitoringApex Jobs. You can see AssetRenewalJobScheduler in the list of jobs. You will get an email notification after this job is successfully completed.

To schedule a batch job for creating renewal opportunity

You must schedule the batch job CreateRenewalOpportunityJobScheduler for the first time. This job runs every 5 minutes after you have scheduled it.

  1. Go to Setup > Develop > Apex Classes.
  2. Click Schedule Apex. The Schedule Apex page is displayed.
  3. In the Job Name field, enter a name for the job.
  4. In the Apex Class lookup, search and select CreateRenewalOpportunityJobScheduler.
  5. Under Schedule Apex Execution, select the Frequency, Start date, End date, and Preferred Start Time for the job.
  6. Click Save.

To monitor the job, go to Setup > MonitoringApex Jobs. You can see CreateRenewalOpportunityJobScheduler in the list of jobs. You will get an email notification after this job is successfully completed.

To synchronize renewal lines to renewal opportunities

  1. Create a picklist value Create Opportunity on the Status field of the Temp Renew Asset Group object.
  2. Set the Create Renewal Opportunity flag to True on Installed Products Settings.
  3. Set the following flags to True in Proposal System Properties and Comply System Properties:
    • Auto Sync With Opportunity
    • Sync Bundle Using Line Items
    • Sync Option Products
  4. Schedule a batch job CreateRenewalOpportunityJobScheduler in Apex classes for creating renewal opportunity.
  5. Configure renewal settings for the Proposal and Agreement objects.
  6. Assign a price book that is existing in the org to the renewal opportunity.
  7. After the assets are created and a renewal contract or quote is generated, a Temp record with status=Create Opportunity is created.
  8. After the CreateRenewalOpportunityJobScheduler is triggered, renewal line items are synchronized with the renewal opportunity.