Rebate Manager Deployment

This section will guide you throw the whole process of Accelerator deployment.

Deployment from PlatformManager

The easiest way to deploy the Rebate Manager Accelerator to a partition is via PlatformManager.

  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 Rebate Management package.

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

  4. Set up data source mapping. 

     

  5. Select a Rebate Type to be deployed (from a list of rebate types provided in the package). 

     

  6. The deployment is complete. 

 

Currently, PlatformManager supports the following components for deployment:

  • Calculation Logic

    • Groovy Libraries

      • ApprovalWorkflow

      • RebateManager

      • SharedLib

    • Rebate Header Logic

      • RebateHeaderLogic

    • Rebate Logics

      • RebateLogic

    • Generic Logics

      • RebateRecordCalculationFeeder

      • RebateAllocationFeeder

      • CustomerFilter_Logic (logic with Nature = "Customer Input Filter")

      • ProductFilter_Logic (logic with Nature = "Product Input Filter")

      • RebateAgreementReport

      • MonthlyRebateReport

      • MonthToDateRebateReport

      • YearToDateRebateReport

      • Dashboard_RebateTypes

      • Dashboard_CustomerRebates

      • Dashboard_Rebates

    • Analytics Logic

      • RebateAllocation (to allocate rebates into transaction Datamart)

    • Workflow Formulas

      • rebateagreement (Rebate agreement approval logic)

      • rebaterecord (Rebate record approval logic)

    • Company Parameters

      • Approvers (used in approval workflow)

      • ApprovalWorkflowSetup (used in approval workflow)

      • ApprovalCondition (used in approval workflow)

      • RM_SC_ConditionTypes (defines a list of rebate types)

      • RM_ProductFieldMapping (mapping between Product / Product Extension attributes and Datamart fields, supports a filter on Product Extensions)

      • RM_CustomerFieldMapping (mapping between Customer / Customer Extension attributes and Datamart fields, supports a filter on Customer Extensions)

    • Dashboards

      • RebateAgreement (Rebate Agreement Dashboard)

      • CustomerRebate (Customer Dashboard)

      • YTDRebateTypes (YTD by Rebate Type Dashboard)

      • Dashboard_RebatePerformance

 

Manual Steps

 The current version of PlatformManager does not support deployment of the following components, so you must deploy them manually.

Synchronize Product and Customer (Optional)

If data and metadata of customers (C) and products (P) in your partition are synced, you can skip this step.

Synchronize Metadata

  1. Go to Analytics > Data Manager > Data Sources. 

  2. Select Customer > click the Sync Meta icon and click the Deploy icon.

Repeat the same steps for Product.

Synchronize Data

  1. Go to Analytics > Data Manager > Data Loads. 

  2. Find Type = Customers and click the Run icon to sync data.

     

  3. Find Type = Products and click the Run icon to sync data. 

Check Mapping Field in Company Parameters

To be able to apply a Customer filter input and Product filter input in a rebate agreement, 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:

  • RM_ProductFieldMapping

  • RM_CustomerFieldMapping

Example: This is mapping in the "RM_CustomerFieldMapping" table: 

  • Column "Customer Master Field Name" = "Source field" in the customer Data Source.

  • Column "Datamart Field Name" = Datamart field name.

Rebate Calculation

  1. Go to Rebates > Rebates Calculations and add a rebate calculation.

     

  2. Enter a label "RR_Calculation".

     

  3. Select this Rebate Calculation and click the Calculation button.

  4. As Feeder Formula choose RebateRecordCalculationFeeder and enter StartDate and EndDate.

     

  5. Save the settings.

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

Rebate Allocation

  1. Go to Analytics > Data Manager > Data Loads. 

  2. Add new a Data Load and enter the Data Load label and type. The type must be "Calculation".

     

  3. In the right window select the Target section. 

  4. As Target, select the Datamart name. 

     

  5. Go to the Calculation section. 

  6. As Feeder Formula select RebateAllocationFeeder and enter StartDate and EndDate.

     

  7. In the Logic section, select RebateAllocation as Logic and check the Rebates checkbox in the Formula Outputs → Target Fields column.

     

  8. Save the settings.


    You can also schedule to run the Data Load every day.

Publishing Templates (Optional)

You may need to deploy templates if there is the Sales Compensation Accelerator installed or was recently updated on the partition. The following templates are affected:

  • Rebate Agreement Report (RBA Report)

  • Last Month Rebate Report

  • Month To Date Rebate Report (MTD Rebate Report)

  • Year To Date Rebate Report (YTD Rebate Report)

 

Template files are stored at: https://gitlab.pricefx.eu/accelerators/rebate-manager-accelerator/-/tree/master/PublishingTemplates

 

To deploy a template:

  1. Go to Administration > Configuration > All Modules > Publishing Templates. 

  2. In the first section select "Rebate Agreements" and click New to add a new template.

     

  3. Enter the following information:

    • Name – RBA Report

    • Convertible to PDF – checked

    • Preprocessing Logic – RebateAgreementReport

  4. Click the Upload Template button to upload the template file. 

     

  5. Choose the template file "publishingTemplates_RBA_RBA Report.docx" in the Rebate Manager Accelerator. 

  6. Select Upload to import the file. 

     

  7. After completing, the following information will be shown:

 

Repeat the same steps for other templates:

Name

Convertible to PDF

Preprocessing Logic

Template File Name

Name

Convertible to PDF

Preprocessing Logic

Template File Name

Last Month Rebate Report

MonthlyRebateReport

publishingTemplates_RBA_Last Month Rebate Report.docx

MTD Rebate Report

MonthToDateRebateReport

publishingTemplates_RBA_MTD Rebate Report.docx

YTD Rebate Report

YearToDateRebateReport

publishingTemplates_RBA_YTD Rebate Report.docx

Â