Configuration (Sales Compensation)

This tutorial will guide you through the configuration steps. After you have completed the installation, you can start with the configuration of the Sales Compensation (SC) Accelerator. You can customize the default configuration, extend types or remove those that are not needed.

In this section:

1 Global Package Configuration
2 Apply Customer/Product Filter
3 Customize Plan Header Types
4 Add/Customize Condition Types
5 Define Seller Information in Compensation Header
6 Define Adjustment Wizard Transaction Field in Adjustment Form
7 Define Approval Workflows
8 Turn on/off Forecast Functionality
9 Turn on/off Holdback Functionality
10 Ensure Correct Seller Master Data Deployment

Global Package Configuration

The global configuration data for the package are stored in an element of Advanced Configuration Options. Many of those parameters can be overridden on the Condition Type.

From the Administration menu go to the System Configuration section.
Switch to Advanced Configuration Options.
Search for the SC_AdvancedConfiguration element where you can adjust the parameters listed below.
Adjust configuration keys according to your specifications.

A list of all parameters, their descriptions, possible values, and other notes are in Components (SC) | Advanced Configuration Options.

Sample of 'SC_AdvancedConfiguration':

{
  "sourceType": "DM",
  "sourceName": "SC_TransactionData",
  "pricingDateFieldName": "PricingDate",
  "customerIDFieldName": "CustomerId",
  "productIDFieldName": "ProductId",
  "productNameFieldName": "ProductName",
  "baselineFieldName": "InvoicePrice",
  "invoicePriceFieldName": "InvoicePrice",
  "quantityFieldName": "Quantity",
  "marginFieldName": "GrossMargin",
  "sellerIDFieldName": "SellerId",
  "currencyFieldName" : "Currency",
  "payoutDays": 2,
  "paymentPeriod": "Quarterly",
  "quotaFor": "Plan duration",
  "depositScheme": "Non-Cumulative"
}

Apply Customer/Product Filter

To be able to apply a Customer filter input and Product filter input in a compensation plan, you need to update the mapping fields between Product/Customer master and Datamart fields.

Based on the Datamart structure and Product/Customer master in your partition, you need to update or add more mapping in two Company Parameters:

SC_CustomerFieldMapping
SC_ProductFieldMapping

Example of SC_ProductFieldMapping table

Customize Plan Header Types

How to Customize Your Types

Go to Sales Compensations > Compensation Types.
Select the line you want to edit.
Click the Edit button to open the customization dialogue.
Adjust parameters according to your needs by replacing default values with custom logic.
Click Save Changes to save and confirm changes.

A list of all parameters, their descriptions, possible values, and other notes are in Libraries (Sales Compensation).

Sample of the 'Plan Header Type' which is deployed with the package:

Name (uniqueName): Individual Compensation
Header Logic (headerFormulaName): Sales Compensation Header
Compensation Plan Workflow (workflowFormulaName): Sales Compensation Plan
Compensation Record Workflow (scRecordWorkflowFormulaName): Compensation Record

Add/Customize Condition Types

This chapter describes procedures for manipulation with LineItem elements which are primary blocks of calculation for compensations inside the individual plan.

How to Customize Your Types

Go to Sales Compensations > Condition Types.
Look for items with the 'Sales Compensation' in the 'Pricing Logic (formulaName)' column.
Select the line you want to edit.
Click the Edit button to open the customization dialogue.
Adjust parameters according to your needs by replacing default values with custom ones.
Click Save Changes to confirm changes.

How to Add a New Type

Go to Sales Compensations > Condition Types.
Click 'Add Condition Type' and a configuration dialogue will open.
Fill in fields you want to have specifically defined in the condition type.
- Be aware, parameters can inherit default values from Advanced Configuration Options. Empty field means the parameter inherits a value.
- "Condition Type Name" shows a list of Sales Compensation. Options compatible with this package are listed in Type Overview (SC) | Condition Types.
Click Add to save your new type.

A list of all parameters, their descriptions, inheritance, possible values, and other notes are in section Components (SC) | Condition Type Attributes.

Define Seller Information in Compensation Header

Add a new read-only input which will show the detailed information about selected Seller input on the Compensation Plan Header.

How to Customize Your Seller Information Display

Go to Company Parameters.
Go to Pricefx Accelerators parent folder → Sales Compensation folder.
Select SC_HeaderSellerDetailsMapping Company Parameter name.
Add a new record or adjust the existing one to display which the seller information you want.

Sample of SC_HeaderSellerDetailsMapping which is deployed with the package:

Define Adjustment Wizard Transaction Field in Adjustment Form

You can display any transaction field in the Adjustment Form (Adjustments under the Sales Compensation module).

How to Customize Your Adjustment Wizard Transaction Field Display

Go to Company Parameters.
Go to Pricefx Accelerators parent folder → Sales Compensation folder.
Select SC_AdjustmentWizardTransactionFieldMapping Company Parameter name.
Add a new record or adjust the existing one to display which the Adjustment Field Name you want in the Adjustment Form.

Sample of SC_AdjustmentWizardTransactionFieldMapping which is deployed with the package:

Define Approval Workflows

Two types of approval workflows can be configured to support business conditions and flow inside an organization. The installation package already deployed and configured workflow types (SCA and SCR, Adjustment) in Administration > Logics > Workflow Logics > General Workflow Logics. You just need to convert your business rules to workflow parameters in Company Parameters.

Compensation Plan Approval Workflow

In this step, you should configure workflow conditions for the Compensation Plan. You will follow detailed steps from the manual for the Accelerate Approval Workflow Package which is part of this package.

Go to Company Parameters in the main menu.
Locate PFXTemplate > Approval Workflow.
Define workflow steps in the 'ApprovalWorkflowsSetup' parameter.
- 'Workflow Type' must be SCA.
Define conditions in the 'ApprovalConditions' parameter.
- The list of variables is on the Workflow Variables (SC) | Compensation Agreement approval workflows page.
Define approvals in the 'Approvers' parameter.
Test your workflow.
You don’t need to submit an plan to test it. Just recalculate and verify that the workflow is prepared to be triggered.

Example for a two-step workflow for Compensation Plan with conditions and approvals:

Compensation Record Approval Workflow

This workflow type configuration is identical to the one above. It uses SCR as the 'Workflow Type'.

An example from the previous step shows one step workflow configuration. The list of variables is on the Workflow Variables (SC) | Agreement Record approval workflows page.

To check the approvals for Compensation Records, you must approve the Compensation Plan first.

Adjustment Custom Form Workflow

This workflow type configuration is identical to the one above. It uses Adjustment as the ‘Workflow Type'.
An example from the previous step shows one step workflow configuration.

In the current development, you only need to define the approval condition as empty to display the approval step:

Turn on/off Forecast Functionality

Usage of forecasting on Sales Compensation Plans is allowed by default but if needed, you can switch it off just by updating the Company Parameters table.

Go to Company Parameters in the main menu.
Find the SC_FeatureConfig table.
For the FORECAST Feature Name change the Status value to OFF.
Inputs related to forecasts will no longer appear in the plan header or anywhere in the system.

Turn on/off Holdback Functionality

Holdbacks define how much of the compensation should be held back from the payee and paid only in the last period of the plan. Holdbacks are enabled by default but if needed, you can switch them off just by updating the Company Parameters table.

Go to Company Parameters in the main menu.
Find the SC_FeatureConfig table.
For the HOLDBACK Feature Name change the Status value to OFF.

Ensure Correct Seller Master Data Deployment

When this accelerator is deployed via PlatformManager, the data for PlatformManager is taken from data/SellerAttributes and the following specifics are of significance.

In the accelerator, the SellerAttribute folder is packaged within the definition folder. It means its content is deployed during the “deploy-logic“ step. This step overrides all changes made by the “setup-seller-master” step.

To make sure, all changes in Seller Master data stay in place, exclude the SellerAttribute folder from the definition folder (but leave it in the data folder). Then list the folder in the “excludes“ section in the pom.xml file. This way it will be added into the data folder, but it will be excluded from the definition folder.