Set up data augmentation rules

Knowledge Center > Zuora RevPro > Set up data augmentation rules

Set up data augmentation rules

Setting up stage validation rules is an optional configuration in RevPro. The customized validation rules can be considered as a complement to the predefined validation rules, which can help validate the source data according to your own business logic.

Overview

The following types of stage validation rules can be created in RevPro:

Rule type Purpose
Advanced Rule

Validate certain fields against specific values and display the selected error message if data validation fails.

For example, you can create an advanced rule to check whether the SO Line ID is null for the line of INV type. 

Expression

Validate the source data based on an expression and display the selected error message if validation fails.

For example, you can create an expression rule to check the source data contains invalid field values.

Lookup

Validate the source data based on a combination of reference fields and target fields.

For example, you can specify one reference field and its reference value, and one target field and its target value. If the reference field of a transaction line is found to be specified reference value, validate the value of the target field. If the value of the target field is found to be the specified target value, the selected error message will be displayed.

Before you begin

As part of the validation rule configuration, you need to specify the error codes and message to be displayed for each validation rule. To define your own error codes and error messages, complete the following steps:

  1. Navigate to Setups > Application.
  2. Click side-menu-open.png to open the side menu and then click Error Setup.
  3. In the Type field, select Custom and then click icon-add-green.png. A new row is added.
  4. Select Stage Validation or Generic as the error type in the Error Type column. The error code is automatically assigned by the system with a prefix of CUST.
  5. In the Error Message column, type the error message that you want to display and then click icon-save-green.png.

Procedure

Complete the following steps to set up stage validation rules:

  1. Navigate to Setups > Stage Validation.
  2. To create a stage validation rule, click the New Rule icon icon-add.png. The New Stage Validation Rule window is displayed.
  3. Provide the following required information of the rule:
    • Book Name: Select the accounting book to which this rule is applied. 
    • Rule Name: Specify a unique name for the rule.
    • Sequence: Specify the sequence in which all the defined rules are to be applied when source data is uploaded.
    • Start Date: Specify the effective start date of the rule.
  4. Click icon-save.png. The stage validation rule is added. 
  5. In the Conditions tab, to add a validation condition, click icon-add-green.png to add a row, and then complete the following steps depending on your selection in the Rule Type column:
    Rule Type Substeps
    Advanced Rule
    1. In the Rule Type column, select Advanced Rule.
    2. Click icon-in-operator.png in the Actions column. The Advanced Rule window is displayed.
    3. In the Advance Rule Set section, click icon-add-green.png to add a row.
    4. Specify a meaningful name that can help you identify the error in the Set Name column and then click icon-in-operator.png in the Actions column. The Error Message window is displayed.
    5. Use the Type field to switch between predefined error messages and customized messages, click one error message, and then close the window.
    6. Click icon-save-green.png to save this rule set.
    7. In the Advance Rule Filters section, click icon-add-green.png to add a row.
    8. Specify the criteria for the error message to be displayed.
      For example, the following filter criteria check the Sales Order Line ID for the invoice lines. If the Sales Order Line ID is not provided, the selected error message in the Advance Rule Set section will be displayed.
      Seq Field Name Operator Operand
      1 Sales Order Line ID IS NULL  
      2 Line Type = 'INV'
    9. Click icon-save-green.png to save the criteria.
    10. Repeat Step c ~ i to as many rule sets as you need and then close the Advanced Rule window.
    11. In the New Stage Validation Rule window, specify the effective start date of this rule type in the Start Date column.
    12. (Optional): Specify the effective end date in the End Date column.
    13. Ensure this rule is enabled in the Enabled column.

    When a line satisfies the criteria, the selected error message will be displayed.

    Expression
    1. Select Expression for the Rule Type column.
    2. Click icon-in-operator.png in the Actions column. The Expression window is displayed.
    3. In the Expression Set section, click icon-add-green.png to add a row.
    4. Specify a meaningful name that can help you identify the error in the Set Name column and then click icon-in-operator.png in the Actions column. The Error Message window is displayed.
    5. Use the Type field to switch between predefined error messages and customized messages, click one error message, and then close the window.
    6. Click icon-save-green.png to save this rule set.
    7. In the Filters section, click icon-add-green.png to add a row.
    8. To add an expression, click icon-in-operator.png in the Formula column, specify the expression in the Formulae window, and then close the window. The formula is displayed in the Expression column.
    9. Specify the appropriate operator and operand for the criteria. To specify multiple operand values, select IN as the operator and then click icon-in-operator.png in the Actions column to add the operand values.
      For example, the following filter criteria check the Impairment Type value for RORD lines. If the Impairment Type filed contains invalid values, the selected error message will be displayed.
      Seq Expression Operator Operand
      1 NVL(Impairment Type,'N ew POB') NOT IN ('Contract Impairment','New POB')
      2 Line Type = 'RORD'
    10. Click icon-save-green.png to save the criteria.
    11. Repeat Step c ~ j to create as many expression rule sets as you need, and then close the Expression window.
    12. In the New Stage Validation Rule window, specify the effective start date of this rule type in the Start Date column.
    13. (Optional): Specify the effective end date in the End Date column.
    14. Ensure this rule is enabled in the Enabled column.

    When source data is calculated based on the expression and satisfies the criteria, the selected error message will be displayed. 

    Lookup
    1. Select Lookup for the Rule Type column.
    2. Select the lookup type in the Lookup Type column. To create a new lookup definition, select New_Look.
    3. Click icon-in-operator.png in the Actions column to specify the lookup. The Lookup window is displayed.
    4. If you are creating a new lookup, specify the lookup name in the Lookup Type Name field.
    5. In the upper half of the window, click icon-add-green.png to add a row.
    6. Provide a unique name in the Name column.
    7. Specify at least one lookup field name in the Reference Field column and one filed name in the Target Field column. You can specify up to 5 reference fields and 5 target fields.
    8. Click icon-save-green.png in the upper half of the window. 
    9. In the Lookup Values section, specify the values for the lookup fields in the Reference Value and Target Value columns respectively. If the reference field of a line is found to be the specified reference value, check the value of the target field. If the value of the target field is the same as the specified target value, the criteria are satisfied.
    10. Click icon-save-green.png to save your settings.
    11. Repeat Step c ~ j to create as many lookup rule sets as you need, and then close the Expression window.
    12. In the New Stage Validation window, specify the effective start date of this rule type in the Start Date column.
    13. (Optional): Specify the effective end date in the End Date column.
    14. Ensure this rule is enabled in the Enabled column.
  6. Add as many conditions as you need in the Conditions tab and click icon-save-green.png to save them.
  7. (Optional): To define simple filters that are to be applied for all the defined conditions, click the Filters tab and specify the field name, operator, and operands. The validation rules are applied to the filtered transactions only.
  8. After you are finished, click icon-save.png and close the window.

Result

When the source data is uploaded to RevPro, it is validated against all the enabled validation rules in the staging tables. If all the validations succeed, the source data will be picked up by the subsequent data collection process. Otherwise, the problematic transaction data remain in the staging tables and cannot be picked up by the data collection process. Use the displayed error codes and messages to fix the source data and then upload them again.

Last modified

Tags

Classifications

(not set)