Installation (Sales Compensation)

Owned by Jana Volencová (Deactivated)
Last updated: Jan 03, 2024
4 min read

This tutorial will guide you through the installation of the Sales Compensation Accelerator.

In this section:

Prerequisites

Before you start, ensure that you have:

  • Access to a partition on the Pricefx server (9.0 or newer). You will need:

    • Server URL

    • Partition name

    • Username and password for a partition user with sufficient rights for using the Accelerator

    • License on the partition must cover the Analytics and Sales Compensations modules

  • Access to Pricefx PlatformManager

    • Username and password for PlatformManager user

    • The user must have the following permissions for your partition (to which you plan to deploy the Accelerator):

      • Permission Marketplace Templates - deploy

  • Mandatory data, including Transaction data with a specific Datamart structure

 

The package contains several components and their technical description is provided on the Libraries (Sales Compensation) page.

Installation Steps

Select Partition for Deployment

  1. Access PlatformManager at https://platform.pricefx.com/ and log in with your account or using O365. If you do not have an account yet, contact Pricefx Support.

  2. Go to Marketplace and find the Sales Compensation accelerator.

  3. Click the accelerator tile, select the partition where you want to deploy the accelerator package and confirm the deployment dialog to start.
    For detailed description of all deployment options, see PlatformManager documentation.

  4. Set up Datamart mapping of required fields from Datamart and default values for a few parameters.

  5. Upload the Seller Master data and define the mapping.
    See also a note on Seller Master data behavior during deployment in Configuration (Sales Compensation).

  6. The deployment is complete. Go to your partition and continue with the manual steps required after deployment.

Post-installation Steps

After the package is deployed to your partition and all automatic installation steps are done, you need to do a few manual tasks before you start with configuration and package adjustments to your specific business needs.

Add Indexing

To avoid performance issues when running Calculation Tasks, indexing for COARs on the partition should be added, for these fields: accrualType, attribute1, attribute20.
Example command:
MariaDB [pricefx_templates_dev]> create index typeAttr1Attr20 on CompensationAccrualRecord(partition_id, accrualType, attribute1, attribute20) using BTREE;

Enable React UI

The package is designed to work with the latest UI engine in the Sales Compensations module. For proper functionality is necessary to enable it manually.

  1. From the Administration menu go to the Feature Flags section.

  2. Activate the following Feature Flags:
    dashboard.useReactDashboard
    useReactFor.advancedFilter

  3. Log out and log back in for the changes to take effect.

Schedule Plan Calculation Task

In this step, you will create a task for the plan calculation scheduler.

  1. Go to Sales Compensations > Calculations.

  2. Add a new calculation.

  3. Enter a label, e.g. 'SC_Calculation'.

  4. Select a set 'Sales Compensations' and click the Add button.

  5. Click the label of the newly added line.

  6. Go to the Calculation tab.

  7. As Logic/Formula choose '[SC] Sales Compensation'

  8. As Feeder Formula choose '[SC] Compensation Record Calculation Feeder'.

  9. Set the Calculation Type to Plan Calculation Task.

  10. Optionally, enter StartDate and EndDate.
    Leave empty unless you need to calculate some specific time frame.

  11. Click Save in the left upper corner.

  12. Enable Incremental calculation on the left side of your screen.

  13. Schedule the calculating task according to your data, e.g. daily.

  14. In the Overview, you can schedule this job to run at a suitable interval.

Schedule Record Calculation Task

The steps for creating the Record calculation plan are almost the same as for Plan calculation, the only difference is in step 9 where the Calculation Type should be set to Record Calculation Task.

Assign Access to Users

The package comes with three predefined business roles which speed up configuration. You can adjust their default configuration and assign them to the users who have access to the system.

A detailed description of role definitions and their meaning is described in Product Info (SC) | Business roles.

  1. From the Administration menu go to the Access Admin > Business Roles Admin section.

  2. Check if all roles with the '[SC] ' prefix correspond with your expectations for minimal access and adjust them to your use cases.

  3. Assign user accounts to their business roles from the Users tab of each role.

At this point, you completed the installation. Now, you should configure the package for specific business needs and get familiar with its use. The last thing to consider is the integration with a system that processes output compensations.

 

Now you can proceed with Configuration (Sales Compensation).

Â