Knowledge Center

Knowledge Center > RevPro > Set Up Data Augmentation

Set Up Data Augmentation

The purpose of this article is to review the important setups and configurations to be performed to create data augmentation rules. The creation of data augmentation rules may or may not apply to your business case.

Data Augmentation

Data Augmentation is the modification or manipulation of source data. For example, data augmentation may occur by adding, modifying, and deleting source data before the RC collection process is performed in RevPro. There are five types of data augmentation rules.

Rule Type Description
Advanced Rule           A type of data augmentation rule designed to perform advanced filtering, conditions, and source data manipulation.
Clear Value   A type of data augmentation rule that clears an attribute’s value.
Constant  A type of data augmentation rule that sets an attribute’s value to a specified constant value.
Formulae A type of data augmentation rule that sets an attribute’s value to a formula-based derived value.
Lookup  A type of data augmentation rule that sets an attribute’s value to a value based on a lookup.

Add Pre/Post Processor

The RPRO_RC_TRNSLTR_RULE_PKG.trnsltr_rule_wrapper must be added as a processor to use Data Augmentation.

  1. From the RevPro Menu, select Setups > Application > Application Setups > Pre/Post Processor.
  2. Click the New Processor button.
  3. Add Procedure Name, Object Type (must be RC_COLLECT) and select Enabled.
  4. Click the Save button.
  5. Click the Processor Mapping tab and enter the following information:
    • Processor Type: Procedure
    • Processor Object: RPRO_RC_TRNSLTR_RULE_PKG.trnsltr_rule_wrapper
    • Stage Name: Before Validate
    • Enabled: Selected
  6. Click the Save button. 

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Enable Profile CUSTOM_CODE_ALLOWED

For RevPro to run data augmentation rules, the System Level Value for the Profile CUSTOM_CODE_ALLOWED must be enabled.

  1. From the RevPro Menu, select Setups > Application > Profiles.
  2. Right-click CUSTOM_CODE_ALLOWED and select Edit.
  3. Select the System Level Value check box to enable.
  4. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the window.

Create Data Augmentation Rule

There is a two-part process to create a data augmentation rule. The first part of the process is to create a data augmentation rule. The second part of the process is to add conditions and filters to the data augmentation rule.

Follow the steps below to create a data augmentation rule:

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Click the New Rule button.
  3. Enter the values in the fields as described below:
    Field Name Description
    Book Name     Select the name of the primary revenue book. The augmented data for the primary book will be copied to any other additional (non-primary) revenue books.
    Sequence     Sequence to apply data augmentation rules.
    Rule Name Enter name of the data augmentation rule.
    Start Date Enter a start date for the data augmentation rule. It is important to note that the data augmentation rule becomes effective at the beginning of the next accounting period following the start date. For example, a start date of January 15, 2016 means that the rule will be effective starting February 1, 2016. To make the data augmentation rule effective immediately, choose a start date in the prior accounting period.
    Description Enter a description for the data augmentation rule.
    End Date Enter an end date.
    Rule Type Select the type of the rule for Data Augmentation.
    Enabled Select to enable the data augmentation rule.
    Processor Type

    RC_COLLECT is the only processor type that is enabled at this time. Please select RC_COLLECT when defining a data augmentation rule:

    • CUSTOM_UI_UPLOAD
    • FV_BATCH
    • RC_COLLECT (select this option)
    Stage Name

    Only these Stage Names are applicable when defining a data augmentation rule:

    • Before Validate
    • After Validate
    • After Bundle Explode
  4. Click the Create (+) button.

Upon successful creation of the record, a message is displayed on the top right side of the window. Next, the second part of the process to create a data augmentation rule is to choose a rule type and define conditions and filters.

Choose Advanced Rule Rule Type and Define Conditions and Filters

The Advanced Rule rule type is used to augment data based on additional conditions. The Conditions tab is used to describe the field to be updated. The Filters tab is used to define criteria that identify the lines upon which to apply conditions.

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Select the Conditions tab.
  4. Click + button to create a new row.
  5. Enter the values in the fields as described below:
    Conditions Description
    Seq Sequence of the conditions.
    Rule Type The rule type.
    Field to be Updated The field to be updated.
    Target Value Not applicable for Rule Type Advanced Rule.
    Lookup Type Not applicable for Rule Type Advanced Rule.
    Expression Not applicable for Rule Type Advanced Rule.
    Start Date Enter start date for rule condition.
    End Date Enter end date for rule condition.
    Enabled Select to enable condition.
    Actions After clicking the Save button, click the Actions button to further define the Advance rule.
  6. Click the Save button. 
  7. Click Actions Button.
  8. Based on the value of the Field to be Updated field, choose the target value in the Advance Rule Set window. For example, Distributor. This advance rule filters on the RC Line Customer Name based on a list of defined values, when the filter is satisfied, then the Field to be Updated is set as Distributor.
  9. The Advance Rule filter below is used to create a rule to identify all the lines that require the target value to be updated.
  10. Click the New Row button.
  11. Add details to the new row. The Field Name set is used to identify the filter criteria and select operator.
  12. Click the Save button.
  13. Create a list of Operand Values.
  14. Click the Save button.
    Fileters Description
    Seq Sequence of the filter values.
    Field Choose a field to filter upon.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Choose Clear Value Rule Type and Define Conditions and Filters

The Clear Value rule type is used to clear the values of attributes. The Conditions tab is used to describe which attributes to ‘clear’. The Filters tab is used to define criteria that identify the lines upon which to apply conditions.

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Select the Conditions tab.
  4. Click New Row (+) button.
  5. Enter the values in the fields as described below:
    Conditions Description
    Seq Sequence of the conditions.
    Rule Type The rule type.
    Field to be Updated The field to ‘clear value’.
    Target Value Not applicable for Rule Type Clear Value.
    Lookup Type Not applicable for Rule Type Clear Value.
    Expression Not applicable for Rule Type Clear Value.
    Start Date Enter start date for rule condition.
    End Date Enter end date for rule condition.
    Enabled

    Select to enable condition.

    Actions Not applicable for Rule Type Clear Value.
  6. Click Save button.
  7. Upon successful creation of the record, a message is displayed on the top right side of the screen.
  8. Select the Filters tab.
  9. Click New Row (+) button.
  10. Enter the values in the fields as described below:
    Filters Description
    Seq Sequence of the filter fields.
    Field Choose a field to filter upon.
    Operator Choose an operator.
    Operand Enter filter criteria.
    Enabled Select to make the filter criteria active.
  11. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Choose Constant Rule Type and Define Conditions and Filters

The Constant rule type is used to update the values of attributes to defined constant values. The Conditions tab is used to describe which attributes to update to the defined constant values. The Filters tab is used to define criteria that identify the lines upon which to apply conditions.

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Select the Conditions tab.
  4. Click + button to add a new row.
  5. Enter the values in the fields as described below:
    Conditions Description
    Seq Sequence of the conditions.
    Rule Type The rule type.
    Field to be Updated The field to be updated.
    Target Value Add the ‘constant’ to target value which will replace the value in the field to be updated.
    Lookup Type Not applicable for Rule Type Constant.
    Expression Not applicable for Rule Type Constant.
    Start Date Enter start date for rule condition.
    End Date Enter end date for rule condition.
    Enabled Select to enable condition.
    Actions Not applicable for Rule Type Constant.
  6. Click the Save button.
  7. Upon successful creation of the record, a message is displayed on the top right side of the screen. Select the Filters tab.
  8. Click New Row (+) button to add a new row.
  9. Enter the values in the fields as described below:
    Filters Description
    Seq Sequence of the filter fields.
    Field Choose a field to filter the fields.
    Operator Choose an operator.
    Operand Enter filter criteria.
    Enabled Select to make the filter criteria active.
  10. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Choose Formulae Rule Type and Define Conditions and Filters

The Formulae rule type is used to update the values of attributes to formula-based derived values. The Conditions tab is used to describe which attributes to update to the defined constant values. The Filters tab is used to define criteria that identify the lines upon which to apply conditions.

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Select the Conditions tab.
  4. Click + button to add a new row.
  5. Enter the values in the fields as described below:
    Conditions Description
    Seq Sequence of the conditions.
    Rule Type The rule type.
    Field to be Updated The field to be updated.
    Target Value Not applicable for Rule Type Formulae.
    Lookup Type Not applicable for Rule Type Formulae.
    Expression Not applicable for Rule Type Constant.To add formula expression, click the Action button (scroll to the right to locate button).
    Start Date Enter start date for rule condition.
    End Date Enter end date for rule condition.
    Enabled Select to enable condition.
    Actions To add formula expression, click the Action button (scroll to the right to locate button).
  6. Click the scrollbar and to the right, then click the Actions button to add formula.
  7. Enter a formula using the keypad.
  8. Close the screen to save the formula.
  9. Click the Save button.
  10. Upon successful creation of the record, a message is displayed on the top right side of the screen. Select the Filters tab.
  11. Click New Row (+) button to add a new row.
  12. Enter the values in the fields as described below:
    Filters Description
    Seq Sequence of the filter fields.
    Field Choose a field to filter the fields.
    Operator Choose an operator.
    Operand Enter filter criteria.
    Enabled Select to make the filter criteria active.
  13. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Choose Lookup Rule Type and Define Conditions and Filters

The Lookup rule type is used to update the values of attributes based on lookup values. The Conditions tab is used to describe which attributes to update to the defined constant values. The Filters tab is used to define criteria that identify the lines upon which to apply conditions.

  1. From the RevPro Menu, click on Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Select the Conditions tab.
  4. Click + button to add a new row.
  5. Enter the values in the fields as described below:
    Conditions Description
    Seq Sequence of the conditions.
    Rule Type The rule type.
    Field to be Updated The field to be updated.
    Target Value Not applicable for Rule Type Lookup.
    Lookup Type Choose New Lookup to create a new lookup or you may choose from a previously created lookup.
    Expression Not applicable for Rule Type Lookup.
    Start Date Enter start date for rule condition.
    End Date Enter end date for rule condition.
    Enabled Select to enable condition.
    Actions To add a new lookup or edit an existing lookup filed, depends on the value selected for Lookup Type.
  6. Click the scrollbar and to the right, then click the Actions button to add lookup.
  7. In the example below, the Reference Field1 is set to Business Unit and the Target Field1 is set to Revenue Segments. Click Save.
  8. In the Details section, add two new rows. For example, in the first row the Reference Value1 is set to 0 and the Target Value1 is set to 100000. In the second row the Reference Value2 is set to 1 and the Target Value2 is set to 200000. When this run is enabled, based on the business unit value (either 0 or 1) the Revenue Segments will be updated with Target Value1.
  9. Click Save.
  10. Close the Data Augmentation Lookup screen.
  11. Ensure the Lookup Type display the newly created lookup value.
  12. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Edit Data Augmentation Rule

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Make the necessary changes.
  4. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Add SQL to a Data Augmentation Rule

  1. From the RevPro Menu, click on Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Add SQL statements.
  4. Click the Validate Sql Statements button. Upon successful validation of the Sql statement, a message is displayed on the top right side of the screen.
  5. Click the Save button.

Upon successful creation of the record, a message is displayed on the top right side of the screen.

Delete Data Augmentation Rule

  1. From the RevPro Menu, select Setups > Data Augmentation.
  2. Select a data augmentation rule, right-click and choose Edit.
  3. Click the Delete button.
  4. Click the Yes button to confirm.

Upon successful deletion of the record, a message is displayed on the top right side of the screen.

Last modified
01:40, 13 Sep 2017

Tags

Classifications

(not set)