Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Batch Class Management
  6. Table Extraction
  7. Table Validation Rules

Table Validation Rules

This document provides an overview of table validation rules in Ephesoft Transact. This information is intended for Transact administrators.

For information about validation rules for index fields, refer to Validation Rules.

Prerequisites

To create and configure table validation rules, the following prerequisites must be in place:

  • You will need a batch class with a document type configured. For detailed steps, refer to Add New Document Type.
  • The TABLE_EXTRACTION plugin must be added to the Extraction module and turned on.
  • You will need a table with table columns configured. For help, refer to Table Extraction.

Overview

Table validation rules use regular expressions to determine if extracted table data is correct, or as a way to force operator review under certain conditions.

When table data is extracted from a document, Transact will run the extracted value against the rules for that column. If the extracted value satisfies the conditions of the table validation rule, the value will be automatically validated. If it doesn’t satisfy the table validation rule, the value will be flagged for review.

These rules are set at the document type level.

Configuring Table Validation Rules

This section describes how to create and configure table validation rules.

  1. From the Batch Class Management screen, select and open your batch class.
  2. Go to Document Types > <your document type> > Tables ><your table> > Table Validation Rules.
Figure 1. Table Validation Rules
  1. Click Add.
Figure 2. Add New Rule

A new rule will be added as a row on the grid. The grid is broken up into three columns:

Column Description
Rule This field displays the rule as you are creating it. This field is view-only and cannot be edited.
Description This mandatory field is where you describe the validation rule, limited to 255 characters.
Set Rule This field contains an interactive editor.

  • The first drop-down contains all columns mapped in Table Columns, plus the option to enter a value.
  • The middle field is enabled when the first drop-down is set to Enter Value. This field becomes a text field you can use to validate a column against a specific dataset.
  • The second drop-down contains a list of logical operators that can be used to configure the validation rule.
    • + (add)
    • * (multiply)
    • – (subtract)
    • / (division, returns the quotient)
    • % (modulo operator, returns the remainder after division)
    • <= (less than or equal to)
    • >= (greater than or equal to)
    • != (does not equal)
    • == (equals)
  1. Create the rule in the Set Rule field.
    1. In the left drop-down, select a column. If Enter Value is selected, enter a value in the middle text field.
    2. In the right drop-down, select a logical operator.
    3. Repeat to refine the validation rule.
  2. Enter an intuitive description in the Description field.
  3. When you’re satisfied, click Apply.

Configuring the Validation Rule Operator

When creating multiple table validation rules, you can specify whether all rules must be satisfied for a field to be validated, or only one rule. To do so, change the Validation Rule Operator on the Tables page.

  1. With your batch class open, go to Document Types > <your document type> > Tables.
  2. Select the Validation Rule Operator for your table.
    1. AND — All rules must be satisfied (default).
    2. OR — Only one rule must be satisfied.
Figure 3. Validation Rule Operator
  1. Click Apply.

Best Practices

  1. Create and test table validation rules in a non-production environment, to prevent disrupting the workflow.
  2. After creating table validation rules, do not rename your Table Columns. This will require reconfiguring the rules.
  3. Be careful not to create too many validation rules. Always ask: Is the rule a “need to have” or “nice to have”? When in doubt, it’s best not to overcomplicate the validation process
  4. Remember to notify operators when you create or modify table validation rules.

Example Table Validation Rules

This section shows how to create table validation rules using a sample mileage log, below.

Use Case

In this scenario, we are creating table validation rules for a mileage log. Our goal is to create two validation rules:

  1. A rule to confirm that the Total Mileage is equal to the difference between the odometer start and end.
  2. A rule to flag any entries over 50 miles for approval.

The first rule is to ensure that the drivers have entered their mileage correctly, while the second is to cover a specific business need that requires a manager to approve entries over 50 miles.

Pre-configurations

In this scenario, we have already configured the following:

  • Created a document type: VehicleMileageReport
  • Created a table: Mileage Table
  • Mapped columns in Table Columns
  • Created an extraction rule in Table Extraction Rules

Creating the Rules

First, we need to create the table validation rules.

  1. Open the batch class and go to Document Types > VehicleMileageReport > Tables > Mileage Table > Table Validation Rules.
Figure 4. Table Validation Rules
  1. Click Add.
Figure 5. Add New Rule
  1. For the Description, we used “Total Mileage equals difference between odometer start and stop”.
  2. Create the rule under Set Rule.
    1. In the left drop-down, select Odometer Stop.
    2. In the right drop-down, select (minus).
    3. In the left drop-down, select Odometer Start.
    4. In the right drop-down, select == (equals).
    5. In the left drop-down, select Mileage Total.
Figure 6. Set First Rule
  1. Repeat this process for the second validation rule. For the Description, we used “Total mileage must be less than 50”.
  2. Create the second rule under Set Rule.
    1. In the left drop-down, select Mileage Total.
    2. In the right drop-down, select <= (less than or equal to).
    3. In the left drop-down, select Enter Value.
    4. In the middle field, enter “50”.
Figure 7. Set Second Rule
  1. Click Apply.

Configuring the Validation Operator

Finally, we need to determine the Validation Rule Operator. In this scenario, we want both of these table validation rules to be satisfied with our tables. Therefore, we want to use the AND operator.

Because the AND operator is the default, no changes are required.

Example Validation Flags

Refer to the following excerpt from our table:

With our table validation rules, Transact will flag two fields for validation.

  1. Row two fails our first validation rule. Tim J. probably entered his Odometer Start or Odometer End incorrectly.
  2. Row three fails our second validation rule. John H. logged over 50 miles and needs manager approval.

Conclusion

This completes an overview of how to configure table validation rules in Ephesoft Transact.

Was this article helpful to you? Yes No