Managing Custom Settings

Many areas of FinancialForce Revenue Management are controlled by custom settings. You must be signed in with administrator permissions to manage these custom settings.

To manage the Revenue Management custom setting fields:

  1. Click Your Name | Setup | Develop | Custom Settings. Using Lightning ExperienceClosedNavigate to Setup | Custom Code | Custom Settings.
  2. Click Manage next to the group of custom settings you want to modify.
  3. Click New.
  4. Add or change data as required.
  5. Click Save.

See the Salesforce Help for more information.

Revenue Management Settings

Key: E – Installed by the Expansion Pack

Custom Setting   Description
Actuals Template   Indicates the API name of the actuals revenue template. The default is ffrrtemplate__c.
Actual vs Forecast Category   The category of forecast values that are included in Actual vs Forecast records. Defaults to Expected. You can create forecast values in other categories such as Worst (e.g. for reporting purposes) but those values will not be included in Actual vs Forecast records.
Create Actual vs Forecast in real time   When enabled, Actual vs Forecast records are created automatically when an Actual or Forecast transaction is created and saved. If not enabled, you must use the Manage Actual Vs Forecast page to maintain Actual vs Forecast records. Note that you can only work with Actual vs Forecast records if the setting 'Use Actual vs Forecast Feature' is enabled. By default this is OFF.
Create Transaction Summaries on Commit   Enables the automatic generation of revenue transaction summary records on commit. By default this is OFF.
Delete Old Revenue Schedule Async Logs  

Controls whether process logs generated by previous asynchronous revenue schedule generation processes are deleted when the latest process completes. By default this is ON.
Disable Period Validation   Disables the validation and auto-complete associated with the Period field when saving or committing revenue recognition transactions. By default this is OFF. When ON, the Period and Recognition Period fields are editable on "In Progress" and "Committed" revenue recognition transactions.
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. By default this is OFF.
Disable Template Mapping Expenses E Disables template mapping on the Expenses object.
Disable Template Mapping Timecard Splits E Disables template mapping on the Timecard Split object.
Enable Opportunity Product Mirror  

Enables the synchronization between the Opportunity Product object and the Opportunity Product Mirror object. Clear the checkbox to disable the related triggers. By default this is OFF.

Warning:

Do not enable 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 enable this field even though you are not using Opportunity Product Mirror, there will be a performance impact.
Forecast Template   Indicates the API name of the forecast revenue template. The default is ffrrtemplate__c.
Use Actual vs Forecast Feature   When enabled, the Actual vs Forecast functionality is available for use. Actual vs Forecast records can be created automatically by enabling the setting 'Create Actual vs Forecast in real time', or manually using the Manage Actual Vs Forecast page. By default this is OFF.

Revenue Management Transaction Settings

Custom Setting Description
Source Record Limit per Transaction The maximum number of source records for which RRT Lines will be created on a revenue recognition transaction before a new transaction is created. The default is 5000 source records (10000 RRT lines).

Revenue Management Batch Settings

Note that the 'Batch Size' settings set the number of records per batch, but a batch job may 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 new staging tables introduced in Revenue Management V3.3.

Custom Setting   Description
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. The default is 1000.
Actuals Transaction Commit Batch Size   The number of revenue recognition transactions committed per batch processed. The default is 1. This means that each transaction is processed in a separate batch, so if a transaction fails it does not prevent other transactions from being committed.
Actuals Transaction Save Batch Size   The number of source records for which revenue recognition transaction lines are created per batch processed. The default is 500.
Actuals Transaction Summary Batch Size   The number of revenue recognition transactions summarized per batch processed. The default is 1. This means that each transaction is processed in a separate batch, so if a transaction fails it does not prevent other transactions from being summarized.
Actual vs Forecast Actuals Batch Size   The number of committed revenue recognition transaction lines per batch processed for which Actual vs. Forecast Lines will be created. The default is 200.
Actual vs Forecast Delete Batch Size   The number of Actual vs. Forecast Lines deleted per batch processed. The default is 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. The default is 200.
RRTs for Journal Creation Batch Size   The number of Revenue Recognition Transactions per batch processed when creating FinancialForce Accounting journals. The default is 1.
Forecast Draft Transaction Delete Batch   Adjusts the batch size used when deleting draft forecasts. The default is 50.
Forecast Transaction Save Batch Size   Adjusts the batch size used in the forecast revenue transaction save process. The default is 200.
Generate Forecasts Batch Size   Adjusts the batch size used when generating forecast values. The default is 200.
Grouping BTC Delete Batch Size S The number of batch tracking control records with Action 'Create Grouping' that will be deleted per batch. The default is 1000.
Grouping Create Batch Size S The number of staging records that will be processed per batch to create grouping summaries. The default is 1000.
Grouping Create Synchronous Limit S The maximum number of staging records that will be processed synchronously to create grouping summaries. The default is 3000.
Grouping Delete Synchronous Limit S The maximum number of grouping records that can be deleted synchronously. The default is 2000.
Grouping Summary Delete Batch Size S The number of grouping summary records that will be deleted per batch. The default is 1000.
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). The default is 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). The default is 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. The default is 1000.

Note:

This field is only relevant if you are using the Opportunity Product Mirror object.
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. The default is 2000.

Note:

This field is only relevant if you are using the Opportunity Product Mirror object.
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. The default is 2000.

Staging BTC Delete Batch Size S The number of batch tracking control records with Action 'Create Staging' that will be deleted per batch. The default is 1000.
Staging Create Batch Size S The number of records that will be processed per batch to create the staging data. The default is 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). The default is 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). The default is 1000.
Staging Detail Delete Batch Size S The number of staging detail records that will be deleted per batch. The default is 1000.
Staging Save Batch Size S The number of staging records that will be processed per batch to create revenue recognition transactions. The default is 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). The default is 500.
Staging Summary Delete Batch Size S The number of staging summary records that will be deleted per batch. The default is 600.
Staging Version Delete Batch Size S The number of staging version records that will be deleted per batch. The default is 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. The default is 1000.

Revenue Management Staging Settings

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

Custom Setting   Description
Disable Automatic Delete S

Controls whether previous versions of data in the staging tables are deleted when a new version is created. By default this is OFF so that 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.
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.