Managing Custom Settings

Many areas of Revenue Management are controlled by custom settings. To manage these settings, navigate to Setup | Custom Code | Custom Settings. You must be signed in with administrator permissions to change these settings. See the Salesforce Help for more information.

Revenue Management has the following custom settings:

Revenue Management Settings

Key: OL - This setting is read from the organization level

Custom Setting   Description

Default Value
Actuals Recognition Template OL Indicates the API name of the actuals recognition template. ffrrtemplate__c
Actual vs Forecast Category   The category of forecast values that are included in Actual vs Forecast records. You can create forecast values in other categories (e.g. for reporting purposes) but those values will not be included in Actual vs Forecast records. Expected
Create Actual vs Forecast in real time  

When selected, Actual vs Forecast records are created automatically when an Actual or Forecast transaction is created and saved. If deselected, you must use the Manage Actual Vs Forecast page to maintain Actual vs Forecast records.

Note:

You can only work with Actual vs Forecast records if the setting Use Actual vs Forecast Feature is selected.

 False
Create Transaction Summaries on Commit   Enables the automatic generation of recognition transaction summary records on commit. False
Delete Recognition Schedule Async Logs  

Controls whether process logs more than seven days old are deleted next time the same asynchronous recognition schedule process runs. If there are process logs to delete, a Process Log Deletion Process is created to handle the deletion.

If this field is disabled, process logs created by asynchronous recognition schedule processes are not deleted.

 True
Delete Discard Transactions Async Logs   Controls whether process logs more than seven days old are deleted next time the same asynchronous discard transactions process runs. If this field is disabled, process logs created by asynchronous discard transactions processes are not deleted. True
Disable Extended Volumes in Rec. Summary  

Disables support for handling extended volumes in the Recognition Summary grid. By default this is False, meaning that extended volumes (up to 6MB of memory) are supported in the Recognition Summary grid.

Enabling this field will reinstate the grid behavior as it was in Revenue Management Spring 2023 (and earlier) where a volume constraint meant that the Recognition Summary grid supported up to 50,000 revenue schedule lines per period.

 False
Disable Generate Schedules for Contracts   Disables recognition schedules from being generated automatically when revenue contracts are created asynchronously. When deselected, recognition schedules are generated automatically when revenue contracts are created asynchronously. False
Disable Period Validation   Disables the validation and auto-complete associated with the Period field when saving or committing recognition transactions. When selected, the Period and Recognition Period fields are editable on "In Progress" and "Committed" recognition transactions. False
Disable populateFromSourceRecords calls   If your org has a customization calling the RevenueContractService.populateFromSourceRecords service, you can select this checkbox to temporarily disable the service. This might be useful if you need to debug your customization. Refer to the Revenue Management API Developer's Reference for more information about this service. False
Disable Synchronize Rec. Schedules OL

When selected, the bulk synchronize process generates recognition schedules but does not delete obsolete recognition schedules. A recognition schedule is obsolete when its source record is unavailable because it has been deleted, is no longer active for recognition, or it has had its recognition template removed. If obsolete recognition schedules are not removed, they can affect your data. You must therefore run the Delete Schedules Where Source Unavailable process manually to ensure that obsolete recognition schedules do not accumulate. For more information, see Deleting Obsolete Recognition Schedules.

Note:

By default this field is deselected, meaning that obsolete recognition schedules are deleted by the bulk synchronize process.

 False
Enable Opportunity Product Mirror  

Enables the synchronization between the Opportunity Product object and the Opportunity Product Mirror object. Deselect the checkbox to disable the related triggers.

Warning:

Do not select this field unless you are using the Opportunity Product Mirror object. From Spring 2021 you can use Salesforce's Opportunity Product directly as a source object without needing to use Opportunity Product Mirror. If you select this field even though you are not using Opportunity Product Mirror, there will be a performance impact.

 False
DEPRECATED: Enable Revenue Schedules Recognition   This field is deprecated.  
Exclude Historic RSLs from Recognition   Controls whether recognizable values on recognition schedule lines (RSLs) in periods prior to the period being recognized in the Recognition Summary grid are excluded from recognition. When true, values in historic periodsClosed Refers to all periods prior to the period being recognized in the Recognition Summary grid. are excluded and remain unrecognized. When false, values in historic periods are included for recognition. When recognizing via the automation process, values in historic periods are always included. False
Forecast Recognition Template OL Indicates the API name of the forecast recognition template. ffrrtemplate__c
Global Opening Balance Cutoff Date OL The date used as the opening balance date for recognition schedules if an Opening Balance Cutoff Date is not specified on the source record. If no cutoff date is set on the source record and this global field is blank, the source record's start date is used. For more information, see Opening Balances for Recognition Schedules. If the Recognize against Revenue Schedules feature is enabled, one of the feature steps sets this field to the date the feature step was performed.
Group Transactions by Recognition Method  

Controls whether recognition transactions are grouped by recognition method in addition to grouping by company, currency, and recognition stream. When true, the Recognition Method field on a transaction will display % Complete, Deliverable, or Equal Split.

Note:

This field only applies to transactions created when recognizing against recognition schedules. It does not apply to transactions created when recognizing against source records.

 False
Process Schedule Volume Limit  

The maximum number of process schedules that can be picked up in a single run of the RM Process Schedule Service. The default value is the maximum allowed. You can decrease this limit. If you increase it to a value greater than 15, it will still be treated as 15.

 15
Revenue Contract Source Record Lookup OL

Indicates the API name of the field on the Revenue Contract object that looks up to the contract's source record.

This is used when creating a revenue contract from the API. For more information, see Creating Revenue Contracts Using the API.

Note:

If you create revenue contracts from engagements, you must not change the default value.

 ffrr__Engagement__c
Use Actual vs Forecast Feature   When selected, the Actual vs Forecast functionality is available for use. Actual vs Forecast records can be created automatically by selecting the setting Create Actual vs Forecast in real time, or manually using the Manage Actual Vs Forecast page. False

Revenue Management Transaction Settings

Custom Setting Description

Default Value
Source Record Limit per Transaction The maximum number of source records for which RT Lines will be created on a recognition transaction before a new transaction is created. The default of 5000 source records means a maximum of 10000 RT lines. 5000

Revenue Management Batch Settings

Note that the 'Batch Size' settings set the number of records per batch, but a batch job might handle multiple batches. For example, if there are 100 records to process and you set a 'Batch Size' of 50, the batch job will process two batches each with 50 records.

Key: S – Relates to the staging tables introduced in Revenue Management V3.3.

Custom Setting   Description

Default Value
Actuals Old Staging Batch Size   This setting applies to the staging tables used by Revenue Management prior to V3.3. The number of source/staging records to be processed/deleted per batch processed. 1000
Actuals Transaction Commit Batch Size   The number of recognition transactions committed per batch processed. The default of 1 means that each transaction is processed in a separate batch, so if a transaction fails it does not prevent other transactions from being committed. 1
Actuals Transaction Save Batch Size   The number of source records for which recognition transaction lines are created per batch processed. 500
Actuals Transaction Summary Batch Size  

The number of recognition transactions summarized per batch processed. The default of 1 means that each transaction is processed in a separate batch, so if a transaction fails it does not prevent other transactions from being summarized.

Note:

The asynchronous process that summarizes recognition transactions created by the Recognize Schedules process does not use this field. Instead it uses Schedules Transaction Summary Batch Size.

 1
Actual vs Forecast Actuals Batch Size   The number of committed recognition transaction lines per batch processed for which Actual vs. Forecast Lines will be created. 200
Actual vs Forecast Delete Batch Size   The number of Actual vs. Forecast Lines deleted per batch processed. 1000
Actuals vs Forecast Forecast Batch Size   The number of revenue forecast transaction lines per batch processed for which Actual vs. Forecast Lines will be created. 200
Allocate Revenue Contract Batch Size   The number of revenue contracts to be processed per allocate batch. This is used when creating revenue contracts from engagements asynchronously. 50
Create Revenue Contract Batch Size   The number of revenue contracts to be processed per create batch. This is used when creating revenue contracts from engagements asynchronously. 2000
Discard Transaction Batch Size   The number of recognition transactions discarded per batch processed. Because this defaults to 1, when discarding multiple transactions if one of them fails to be discarded the process continues discarding the others. If this batch size is >1 and one transaction fails to be discarded, that whole batch fails and all the transactions in that batch are rolled back to "Committed". For example, if this batch size is 5, transactions will be discarded in batches of 5, so if one transaction fails to be discarded the other 4 transactions in the same batch also fail. 1
Forecast Draft Transaction Delete Batch   Adjusts the batch size used when deleting draft forecasts. 50
Forecast Transaction Save Batch Size   Adjusts the batch size used in the forecast revenue transaction save process. 200
Generate Forecasts Batch Size   Adjusts the batch size used when generating forecast values. 200
Grouping BTC Delete Batch Size S The number of batch tracking control records with Action 'Create Grouping' that will be deleted per batch. 1000
Grouping Create Batch Size S The number of staging records that will be processed per batch to create grouping summaries. 1000
Grouping Create Synchronous Limit S The maximum number of staging records that will be processed synchronously to create grouping summaries. 3000
Grouping Delete Synchronous Limit S The maximum number of grouping records that can be deleted synchronously. 2000
Grouping Summary Delete Batch Size S The number of grouping summary records that will be deleted per batch. 1000
Manage RC - Send Email Notification   Controls whether email and Salesforce notifications are sent after creating or updating revenue contracts asynchronously (in the background). True
Manage RC Batch Size  

The maximum number of source records processed in a single batch when creating or updating a revenue contract asynchronously (in the background).

Warning:

When creating revenue contracts from engagements asynchronously, the following fields determine scope size: Allocate Revenue Contract Batch Size, Create Revenue Contract Batch Size, Populate Revenue Contract Batch Size.

 500
Manage RC Synchronous Limit  

The maximum number of source records that can be processed synchronously when creating or updating a revenue contract. If the number of source records is equal to or greater than the value in this field, the process runs asynchronously (in the background).

100
Opportunity Product Mirror Batch Size  

The number of opportunity product records for which opportunity product mirror records will be created or updated per batch processed.

Note:

This field is only relevant if you are using the Opportunity Product Mirror object.

 1000
Opportunity Product Scheduler Date  

The date-time the create/update schedule begins to pick up records. The delete schedule picks up records before this date-time. This date-time is automatically set to the date-time the previous Opportunity Product Mirror batch process started, but you can adjust it.

Note:

This field is only relevant if you are using the Opportunity Product Mirror object.

  
Opp Product Mirror Delete Batch Size  

The number of opportunity product mirror records to be deleted per batch processed.

Note:

This field is only relevant if you are using the Opportunity Product Mirror object.

 2000
Orphaned Schedules Delete Batch Size  

The number of recognition schedules processed per batch when running the Delete Schedules Where Source Unavailable process.

Note:

If an unmanaged field named ffrrSchedulesOrphanedDeleteBatchSize__c exists, its value takes precedence over this packaged field.

 395
Populate Revenue Contract Batch Size   The number of performance obligation line items to be processed per populate batch. This is used when creating revenue contracts from engagements asynchronously. 2000
Process Control Delete Batch Size S

The number of process control records that will be deleted per batch processed when running the Staging Delete batch process.

2000
RTs for Journal Creation Batch Size  

The number of recognition transactions per batch processed when creating Accounting journals.

Note:

The asynchronous process that creates Accounting journals from recognition transactions created by the Recognize Schedules process does not use this field. Instead it uses Schedules Create Journals Batch Size.

 1
Run True-Up All on Included Records Only   Controls whether Deferred Revenue True-Up All only processes source records if their Include in True-Up flag is true. When deselected, Deferred Revenue True-Up All processes all source records linked to valid settings regardless of their Include in True-Up flag, and creates a log line for each source record. False
Scheduled True-Up Creates Committed RTs   Controls whether scheduled True-Up jobs create recognition transactions with the status "Committed" or "In Progress". When deselected, they are created as "In Progress". Other true-up processes use this flag to set their default behavior but it can be changed at runtime. False
Schedule Lines Recognition Batch Size   The number of source Recognition Schedule Lines per batch processed for recognition. However if a lower value is set for Source Record Limit per Transaction, that value applies. 2000
Schedules Create Journals Batch Size   This field is used by the asynchronous process that creates Accounting journals from recognition transactions created by the Recognize Schedules process and summaries created from those transactions. It controls the number of transactions/summaries processed per batch. 1
Schedules Transaction Summary Batch Size   This field is used by the asynchronous process that summarizes recognition transactions created by the Recognize Schedules process. It controls the number of transactions summarized per batch processed. 4
Staging BTC Delete Batch Size S The number of batch tracking control records with Action 'Create Staging' that will be deleted per batch. 1000
Staging Create Batch Size S The number of records that will be processed per batch to create the staging data. 1000
Staging Create Synchronous Limit S The maximum number of source records that can be processed synchronously. If the number of records is equal to or greater than this setting, they are processed asynchronously (via Batch Apex). 1000
Staging Delete Synchronous Limit S The maximum number of staging records and grouping records that can be deleted synchronously. If the number of records to delete is equal to or greater than this setting, they are deleted asynchronously (via Batch Apex). 1000
Staging Detail Delete Batch Size S The number of staging detail records that will be deleted per batch. 1000
Staging Save Batch Size S The number of staging records that will be processed per batch to create recognition transactions. 1000
Staging Save Synchronous Limit S The maximum number of staging records that can be saved synchronously. If the number of records is equal to or greater than this setting, they are saved asynchronously (via Batch Apex). 500
Staging Summary Delete Batch Size S The number of staging summary records that will be deleted per batch. 600
Staging Version Delete Batch Size S The number of staging version records that will be deleted per batch. 1000
Transfer Prev. Recognized Batch Size   The number of performance obligation line items that will be processed per batch when the Transfer Previously Recognized process runs. This process transfers previously recognized amounts from source records to their corresponding performance obligations. 1000

Revenue Management Staging Settings

Key: S – Relates to the new staging tables introduced in Revenue Management V3.3.

Custom Setting   Description

Default Value
Disable Delete S

Controls whether previous versions of data in the staging tables are deleted when a new version is created. When deselected, old data is deleted automatically when you generate new data. A version of staging data is not deleted if any processes that use it are still running.

Note that when using the Recognize All process, staging data is deleted as soon as the process completes, not the next time you run the process.

 False
Last Delete Date S The last time the Staging Delete process ran for the current user. The next time the Staging Delete process runs for this user, only records after this date will be deleted. You can adjust this date or clear it altogether to have the next Staging Delete process delete all data for the current user regardless of date.  

Revenue Management Notification Settings

You can define notification settings at user, profile, or org level.

Custom Setting Description

Default Value
Disable Email Notifications

Controls whether Revenue Management asynchronous processes send notification messages to users by email. When selected, notification messages relating to asynchronous processes (such as Generate Schedules and Recognize Schedules) are not sent by email.

 False
Disable Salesforce Notifications Controls whether Revenue Management asynchronous processes send notification messages to users by Salesforce notifications. When selected, notification messages relating to asynchronous processes (such as Generate Schedules and Recognize Schedules) are not sent by Salesforce notifications. False
Note:

Notifications sent when creating revenue contracts asynchronously are controlled using the Manage RC - Send Email Notification field in the Revenue Management Batch Settings custom setting.