User overrides for domain preprocessor rule sets

You can create overrides for domain preprocessor (PREP) rule sets by using user override options.

Return code values

The overrides statements must be in your pattern action table. The statements enable the overrides in the Designer client.

Recommended syntax:


OVERRIDE_P Lookup_Value @Table_Name Return_Code [ CLASS | VALUE ]
Argument Description
Lookup_Value The name of the user variable containing either a pattern or text reference to the active token set that is to be checked for any applicable user overrides by looking up to the Table_Name provided
Table_Name The name of the user override table to use
Return_Code The name of either a user variable or dictionary field in which to store the return code value
[ CLASS | VALUE ] CLASS indicates that the Lookup_Value contains a pattern reference where each token is represented by its token class.

VALUE indicates that the Lookup_Value contains a text reference where each token is represented by its token value.
Value Description
0 (zero) (default value) No user overrides were executed because no match was found for the specified Lookup_Value on the specified Table_Name
1 A user override was successfully executed with no errors

For example:


OVERRIDE_P Text @USPREPIP.TBL Return VALUE
OVERRIDE_P Pattern @USPREPIP.TBL Return CLASS

The specified Lookup_Value is searched for on the specified Table_Name. If the Lookup_Value is found, the active token set is RETYPE that uses the override instructions found in the matching table entry. A return code value is always returned and stored in the specified Return_Code.

Lookup_Value can contain either a pattern or a string of literal token values, which represents the entire active token set.

Table_Name is a two-column STAN conversion table that uses the following formats:

  • Pattern Override Table Format (for domain preprocessor rule sets)

    Column 1: <[Classification for Token #1][Classification for Token #2]...>

    Column 2: <[Domain Mask for Token #1][Domain Mask for Token #2]...>

    For example (for domain preprocessor rule sets):

    
N^D+TU^   AAAAAAA   
A++E      NNNN
A+S^      RRRR
  • Text Override Table Format (for domain preprocessor rule sets)

    Column 1: <["][Token #1][space][Token #2][space]...["]>

    Column 2: <[Domain Mask for Token #1][Domain Mask for Token #2]...>

    For example (for domain preprocessor rule sets):

    
"ZQNAMEZQ 456 SOUTH MAIN AVENUE APARTMENT 7"   AAAAAA
"ZQADDRZQ IBM CORPORATION"   NNNN
"ZQADDRZQ LITTLETON MA 01460"   RRRR

Override table syntax validation

The syntax validation of the override tables occurs during Standardize or Investigation stage initialization.

If any syntax errors are found, the stage execution stops and an error message is written to the log file including the override table name, the contents of the invalid entries, and an explanation of the nature of the errors.

For each active token there should be one corresponding domain mask in the override instruction. The domain mask is the class to use to RETYPE the corresponding token. The only valid values for a domain mask are A, N, and R.

The two primary errors to check for are:

  • Invalid domain masks (not A, N, or R)
  • Incomplete override instructions (there was not a valid instruction for each active token)