Here is a description of the fields that make up the Settings object. You must be signed in as an administrator to create or edit these settings.
Key: * – Mandatory field; The number indicates the number of characters that are allowed in this text field, where appropriate.
| Field | Description | ||
|---|---|---|---|
| Settings Name | * | 80 | Name of this settings record. |
Key: * – Mandatory field; X – Not relevant at primary level, mandatory at other levels; The number indicates the number of characters that are allowed in this text field, where appropriate.
| Field | Description | ||
|---|---|---|---|
| Object | * | 255 | API name of the object that acts as a data source (source object A self-contained source entity that consists of both data and rules for transforming the data.) at this level. You cannot change this once this setting is used on a template Defines how you want Revenue Management to calculate revenue for a specific settings record.. For non-primary settings, the object must be in a master-detail or lookup relationship with the object on its parent setting. |
| Parent Lookup | X | API name of the lookup field to the source object of the parent setting. | |
| Parent Settings | X | The settings record for the source object one level above this one in the hierarchy. | |
| Settings Level | * | The level of this settings record within the source object hierarchy. The source objects within the hierarchy must be in a master-detail or lookup relationship with each other. | |
| Settings Type | * | The type of process this settings record will be used for: Actual, Forecast, or both. | |
| Value Type | The type of value processed by this settings record: revenue, cost, or both. |
The Group and Group Name fields are for internal use only.
Revenue Contract
These fields are relevant if the settings record will be used in revenue contracts.
Key: * – Mandatory field; RC - Mandatory when the Use in Revenue Contract checkbox is selected;
| Field | Description | |
|---|---|---|
| Default Field Mapping Definition | The field mapping definition that will be used by default for performance obligation line items created for source records using this settings record. This field is populated automatically if you click the Create Mapping button, but you can change it to a different field mapping definition if necessary. | |
| POLI Source Lookup | RC |
API name of the lookup field (to the source object of this setting) that your administrator has added to the Performance Obligation Line Item object. |
| Use in Revenue Contract | Indicates whether this settings record will be used in revenue contracts. When selected, by default any source object records linked to this settings record will be excluded from forecasting and recognizing revenue calculations. See About Parallel Reporting for more information. |
Lookups to Source Object
These fields identify lookups that link Revenue Management transactions to their source object record. You must add the lookups to the specified Revenue Management transaction objects before these fields can be populated.
Key: A/F – Mandatory depending on settings type
| Field | Description | |
|---|---|---|
| Revenue Recognition Txn Line Lookup | A | API name of the lookup field (to the source object described by this settings record) that your administrator has added to the Revenue Recognition Transaction Line object. This must be populated if the Settings Type is Actual. |
| Actual vs Forecast Line Lookup | API name of the lookup field (to the source object described by this settings record) that your administrator has added to the Actuals vs Forecast Line object. You must complete this field regardless of settings type when Use Actual vs Forecast Feature in the custom setting Revenue Management Settings is enabled. | |
| Revenue Forecast Transaction Lookup | F | API name of the lookup field (to the source object described by this settings record) that your administrator has added to the Revenue Forecast Transaction object. This must be populated if the settings type is Forecast and the settings level is Primary. |
| Revenue Forecast Transaction Line Lookup | F | API name of the lookup field (to the source object described by this settings record) that your administrator has added to the Revenue Forecast Transaction Line object. This must be populated if the settings type is Forecast. |
| Revenue Schedule Lookup | API name of the lookup field (to the source object described by this settings record) that your administrator has added to the Revenue Schedule object. | |
| Revenue Schedule Line Lookups | API names of lookup fields that your administrator has added to the Revenue Schedule Line object. These can be lookup fields to the source object described by this settings record, or linked to the source object by a relationship path of up to 5 lookups, such as the primary object. These fields are populated from the lookups identified in the Parent Relationship Paths. When specifying multiple fields they must be comma separated and in the same order relative to the fields in the Parent Relationship Paths. | |
| Parent Relationship Paths | API names of lookup fields on the source object described by this settings record, or linked to the source object by a relationship path of up to 5 lookups, whose values will populate the Revenue Schedule Line Lookups. When specifying multiple fields they must be comma separated and in the same order relative to the fields in the Revenue Schedule Line Lookups. |
Source Object Field Mappings
Key: * – Mandatory field; D – Mandatory when template is Deliverable; % – Mandatory when template is % Complete; E – Mandatory when template is Equal Split.
| Field | Description | ||
|---|---|---|---|
| % Complete | 255 | API name of the number or percentage field on the source object that represents how complete the source record is in percentage terms. This field is only relevant to templates of type "% Complete". | |
| Description | * | 255 | API name of the text or long text area field on the source object that contains a description. |
|
Display Information |
255 | API name of the field on the source object that represents further information about the source record. Often this will be the account name but it can be any text, picklist, lookup, number, auto number or formula field. This field is displayed in the Information column on the Recognize Revenue and Forecast Revenue screens. | |
| End Date /Deliverable Date | D,E | 255 | API name of the date or date/time field on the source object that represents its end date. |
| Engagement Lookup | 255 | API name of the lookup field on the source object that looks up to the Engagement object. For more information, see Defining the Engagement Lookup Field on Settings Records. | |
| Fully Recognized and Amortized | 255 | API name of the checkbox field on the source object that indicates all revenue has been recognized and all cost has been amortized. If this field is populated, the checkbox on the source record is automatically selected when revenue is fully recognized and cost is fully amortized. Once this checkbox is selected, the source record is ignored by the Recognize Revenue process. | |
| Grouped By |
API name of the lookup, picklist, or text field on the source object that source records are grouped by (in addition to currency and recognition stream) when using Recognize All. The Recognize All process creates separate recognition transactions for each combination of currency, recognition stream, and this Grouped By field. |
||
| On Hold |
API name of the boolean or formula field on the source object that indicates whether a source record is on hold. If mapped to a formula field, the formula's return type must be Checkbox. When this field resolves to true for a source record, the source record's revenue schedules are generated with the status "On Hold". Revenue schedules with the status "On Hold" are excluded from revenue recognition. If the source record ceases to be on hold and this field resolves to false, when revenue schedules are next generated for the source record the "On Hold" status is removed. This field mapping is not used when recognizing revenue against source records. |
||
| Opening Balance Cutoff Date |
API name of the date or date/time field on the source object that represents its opening balance cutoff date. The recognition period that this date falls in is used when generating a revenue schedule line for an opening balance value. If this field is not mapped, the date set in the Global Opening Balance Cutoff Date field in the Revenue Management Settings custom setting is used. If neither of these fields are set, the source record's start date is used (or end date for source records using a Deliverable template). For more information, see Opening Balances for Revenue Schedules. This field mapping is not used when recognizing revenue against source records. |
||
| Owner | API Name of the text field, lookup or picklist that represents the source record owner. This can either be a field on the source object, or using lookup relationships you can reference a field on an object linked by a path of up to five lookups. To build a relationship to a parent object, enter the API names of the lookup fields that chain together to reach the information you want. Use a period to separate API names in the chain. When revenue schedules are generated for a source record, the owner identified by this field is set as the owner of the resulting revenue schedule. For more information, see Permissions and Sharing when Working with Revenue Schedules. | ||
| Start Date | %,E | 255 | API name of the date or date/time field on the source object that represents its start date. |
The following fields enable you to include or exclude source records based on the values held in a field on the source object. To include records in Revenue Management when a field has a specific value, set the field name in Active Field, the value in Active Value and set Include Active Value to True.
| Field | Description | ||
|---|---|---|---|
| Active Field | * | 255 | API name of the field on the source object that indicates whether it is active. |
| Active Value | * | Value on the active field that indicates whether the source record is active. | |
| Include Active Value | * | Include or exclude source records with the value defined in the Active Value field. |
The following fields enable you to include or exclude source records based on the values held in a field on the source object. They relate to templates of type "Deliverables" only so if completed records are included, revenue will be recognized when the source record is complete.
| Field | Description | |
|---|---|---|
| Completed Field | 255 | API name of the field on the source object that indicates whether it is completed. |
| Completed Value | 255 | Value on the completed field that indicates whether the source record is complete. |
| Include Completed Value | Include or exclude source records with value defined in Completed Value field. |
Currencies
These fields are relevant if you want recognized and amortized amounts to be calculated using the exchange rate in effect when the revenue or cost was first deferred.
Key: The number indicates the number of characters that are allowed in this text field, where appropriate.
| Field |
|
Description |
|---|---|---|
| Document Currency | 255 | API name of the text, lookup, or picklist field on the source object that represents the currency of the source record. |
| Document Rate | 255 | API name of the number field on the source object that represents the document to home currency exchange rate. An exchange rate can have up to 9 decimal places but Revenue Management will display it to 2 decimal places. |
| Dual Currency | 255 | API name of the text, lookup, or picklist field on the source object that represents the accounting company's dual currency. Dual currency is typically a corporate currency used for reporting purposes. |
| Dual Rate | 255 | API name of the number field on the source object that represents the accounting company's home to dual currency exchange rate. If Dual Rate is set, you must also set Document Rate. An exchange rate can have up to 9 decimal places but Revenue Management will display it to 2 decimal places. |
| Home Currency | 255 | API name of the text, lookup, or picklist field on the source object that represents the accounting company's home currency. Home currency is the company's main working, and reporting, currency. |
Analysis Details
For each of these fields you can either enter the API name of a field on the source object, or using lookup relationships you can reference a field on an object linked by a path of up to five lookups. To build a relationship to a parent object, enter the API names of the lookup fields that chain together to reach the information you want. Use a period to separate API names in the chain.
For example, your object hierarchy might be Level 1=Project, Level 2=Milestone, Level 3=Timecard. When creating the settings record for your Timecard object, if you want to derive the Salesforce Account from the related project, the syntax would be: pse__Milestone__r.pse__Project__r.pse__Account__c
| Field | Description |
|---|---|
| Account | API name of the lookup that represents the Salesforce account (typically this will be the customer account). |
| Analysis Item 1-4 | API name of the text field, lookup, or picklist that represents the reporting value 1-4. |
| Company | API name of the text field, lookup, or picklist that represents the company. When recognizing revenue and cost against recognition schedules, transactions are grouped by this field. The Recognize Schedules process creates separate recognition transactions for each combination of company, currency, and recognition stream. |
| Product | API name of the lookup that represents the product. |
Revenue
Key: * - Mandatory if Value Type includes Revenue; RC - Mandatory when both the Use in Revenue Contract checkbox is selected and Value Type includes Revenue.
| Field | Description | ||
|---|---|---|---|
| Rate | 255 | API name of the number or currency field on the source object that represents the rate at which units are charged. See also Total Units. | |
| Recognized to Date Value | 255 | API name of the number or currency field on the source object that stores the amount of revenue recognized to date. If this field is populated, the value on the source record is automatically updated each time a revenue recognition transaction line is committed. This field is useful for some reports, and is required if you intend calculating deferred revenue true-up values. | |
| Recognized to Date Value (Home) | 255 | API name of the number field on the source object that stores the Recognized to Date Value in home currency. If this field is populated, the value on the source record is automatically updated each time a revenue recognition transaction line with an amount in home currency is committed. This field is required if you intend calculating deferred revenue true-up values in home currency. | |
| Recognized to Date Value (Dual) | 255 | API name of the number field on the source object that stores the Recognized to Date Value in dual currency. If this field is populated, the value on the source record is automatically updated each time a revenue recognition transaction line with an amount in dual currency is committed. This field is required if you intend calculating deferred revenue true-up values in dual currency. | |
| SSP | RC | API name of the number or currency field on the source object that stores the standalone selling price for a performance obligation line item. You do not need to populate this field if the Value Type is Cost only. | |
| Total Recognized to Date Value | 255 |
API name of the number or currency field on the primary source object that stores the total amount of revenue recognized to date. This field is currently only used in Business Analytics for projects. Revenue Management does not populate the specified field on the primary object. For more information, see |
|
| Total Revenue | * | 255 | API name of the number or currency field on the source object that represents the total revenue. |
| Total Units | 255 | API name of the number field on the source object that represents the total number of units charged. The total units' value could be the number of hours or days worked on a project for example. | |
| VSOE % | 255 | API name of the number or percentage field on the source object that represents the Vendor Specific Objective Evidence percentage. | |
| VSOE Rate | 255 | API name of the number or currency field on the source object that represents the Vendor Specific Objective Evidence rate. |
You can define the GLAs to use for revenue analysis in one of two ways:
- By mapping a field on the source object in a similar way to those in the Source Object Field Mappings section.
- By entering a specific GLA code then selecting the corresponding Fixed checkbox to indicate that the value is not an API name. The Fixed checkboxes can be set independently of each other. If you are unsure of your organization's financial chart of accounts, for now you can enter a suspense GLA code such as 9999 and select the corresponding Fixed checkbox.
Key: A/F – Mandatory depending on settings type
| Field | Description | ||
|---|---|---|---|
| Balance Sheet GLA | A | 255 | API name of the text field, lookup, or picklist on the source object that represents the balance sheet GLA to which the revenue journals are posted. |
| Income Statement GLA | A | 255 | API name of the text field, lookup, or picklist on the source object that represents the income statement GLA to which the revenue journals are posted. |
| Cost Center | 255 | API name of the text field, lookup, or picklist on the source object that represents the specific component of your chart of accounts by which your management accounts are sub-analyzed. If your financial application is FinancialForce Accounting, this might be an analysis dimension such as Dimension 1. |
Costs
Key: * - Mandatory if Value Type includes Cost
| Field | Description | ||
|---|---|---|---|
| Amortized to Date Value | 255 | API name of the number or currency field on the source object that stores the amount of cost amortized to date. If this field is populated, the value on the source record is automatically updated each time a revenue recognition transaction is committed. Useful for some reports. | |
| Total Amortized to Date Value | 255 |
API name of the number or currency field on the primary source object that stores the total amount of cost amortized to date. This field is currently only used in Business Analytics for projects. Revenue Management does not populate the specified field on the primary object. For more information, see |
|
| Total Cost Units | 255 | API name of the number field on the source object that represents the total number of cost units charged. The cost units' value could be the number of hours or days worked on a project for example. | |
| Cost Rate | 255 | API name of the number or currency field on the source object that represents the rate at which cost units are charged. See also Total Cost Units. | |
| Total Cost | * | 255 | API name of the number or currency field on the source object that represents the total cost. |
Cost Analysis
You can define the GLAs to use for cost analysis in one of two ways:
- By mapping a field on the source object in a similar way to those in the Source Object Field Mappings section.
- By entering a specific GLA code then selecting the corresponding Fixed checkbox to indicate that the value is not an API name. The Fixed checkboxes can be set independently of each other. If you are unsure of your organization's financial chart of accounts, for now you can enter a suspense GLA code such as 9999 and select the corresponding Fixed checkbox.
Key: A/F – Mandatory depending on settings type
| Field | Description | ||
|---|---|---|---|
| Balance Sheet GLA (Cost) | A | 255 | API name of the text field, lookup, or picklist on the source object that represents the balance sheet GLA to which the cost journals are posted. |
| Income Statement GLA (Cost) | A | 255 | API name of the text field, lookup, or picklist on the source object that represents the income statement GLA to which the cost journals are posted. |
| Cost Center (Cost) | 255 | API name of the text field, lookup, or picklist on the source object that represents the specific component of your chart of accounts by which your management accounts are sub-analyzed. If your financial application is FinancialForce Accounting, this might be an analysis dimension such as Dimension 1. |
Deferred Revenue True-Up
These fields are relevant if you intend calculating deferred revenue true-up values in home or dual currency.
| Field | Description | |
|---|---|---|
| Deferred Revenue To Date | 255 | API name of the number field on the source object that stores the amount of revenue deferred to date, in document currency. |
| Deferred Revenue To Date (Home) | 255 | API name of the number field on the source object that stores the amount of revenue deferred to date, in home currency. This field is required if you intend calculating deferred revenue true-up values in home currency. |
| Deferred Revenue To Date (Dual) | 255 | API name of the number field on the source object that stores the amount of revenue deferred to date, in dual currency. This field is required if you intend calculating deferred revenue true-up values in dual currency. |
| Include in True-Up | 255 | API name of the checkbox field on the source object that indicates if source records are eligible to be included in deferred revenue true-up calculations. |
| True-Up GLA | 255 |
The balance sheet GLA to which true-up values are posted. The opposite income statement posting goes to the account specified in the Income Statement GLA field for revenue. You can define the True-Up GLA by entering either:
|
Lightning Actions
Key: L - Only available on the Lightning version of the page.
| Lightning Action | Description | |
|---|---|---|
| Delete Hierarchy | L | Deletes the current settings record and all of its children. |
| Create Mapping | L | Generates Field Mapping Definitions for the selected setting(s). |
Buttons
| Button | Description |
|---|---|
| Create Mapping | This button is only relevant when the Use in Revenue Contract checkbox is selected. Generates a field mapping definition so that details from the source record can be mapped to performance obligation line items. If a field mapping definition already exists for this settings record, you can choose whether to update it or create a new one. If you update the existing field mapping definition any custom mappings will be preserved. If you create a new field mapping definition you will need to reapply any custom mappings to the new definition. The Default Field Mapping Definition field is populated with the name of the field mapping definition that is generated. |