Utility Object - OCR for AnyDoc - Foundation 23.1 - Foundation 23.1 - AnyDoc - external

OCR for AnyDoc Programming Reference Guide

Platform
AnyDoc
Product
OCR for AnyDoc
Release
Foundation 23.1
License

The Utility object provides a set of text validation and manipulation utilities. It contains functions that are independent of zones and algorithms. The Utility object is applicable to the following phases:

  • Post Extraction

  • AnyApp Post Extraction

  • Pre-Verification

  • Interactive

  • Interactive FKey

  • Post Verification

  • AnyApp Pre-Application

  • Anyapp Post-Algorithm

  • AnyApp Post Application

  • Zone Link

Method

Description

Applicable Event

CustomerSite

Returns True if the hardware key attached to the local workstation is a customer or dealer key, and False if it is an AnyDoc employee key. For more information, see CustomerSite (Method)(page CustomerSite (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

FormatPhoneNumber

This function takes the string expression passed in, attempts to format the string expression as if it were a phone number and return it with either 7 or 10 digits. For more information, see FormatPhoneNumber (Method)(page FormatPhoneNumber (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

GetUSStateAbbreviation

Given a state name or an abbreviation, this function returns the state code abbreviation for the given state. For more information, see GetUSStateAbbreviation (Method)(page GetUSStateAbbreviation (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

IsICD9Code

Returns a boolean indicating whether or not the value passed in is in the format of an ICD-9 code. For more information, see IsICD9Code (Method)(page IsICD9Code (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

IsISBNCode

Returns a boolean indicating whether or not the value passed in is in the format of an ISBN code. For more information, see IsISBNCode (Method)(page IsISBNCode (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

IsNMFCCode

Returns True if the string evaluated is in a legal format for an NMFC (National Motor Freight Classification), and False otherwise. It is important to note that the function does not determine if the data is actually a valid code, but rather if the data is in the proper format to be a valid code, much in the same way that 00000 is not a valid zip code, but it is in the proper format for a zip code. For more information, see IsNMFCCode (Method)(page IsNMFCCode (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

IsStateCode

Returns True if the referenced value is a valid two-letter U.S. state code. For more information, see IsStateCode (Method)(page IsStateCode (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

IsZipCode

Returns True if the referenced value is in zip code format. For more information, see IsZipCode (Method)(page IsZipCode (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

MakeAlpha

This function takes the string expression passed to it and attempts to make the data alphabetical by converting common OCR substitutions, such as “0” -> “O”. All characters are not necessarily converted.. For more information, see MakeAlpha (Method)(page MakeAlpha (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

MakeNumeric

This function takes the string expression passed to it and attempts to make the data numeric by converting common OCR substitutions, such as “O” -> “0”. All characters are not necessarily converted. For more information, see MakeNumeric (Method)(page MakeNumeric (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

MatchesEditMask

Returns True if the ASCII data in the object matches the given edit mask, and False otherwise. For more information, see MatchesEditMask (Method) (page MatchesEditMask (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

RemoveChars

Removes specified characters from ANSI data. For more information, see RemoveChars (Method) (page RemoveChars (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink

RetainChars

Removes all but the specified characters from ANSI data. For more information, see RetainChars (Method) (page RetainChars (Method)).

AnyApp Pre-Application, AnyApp Post-Algorithm, AnyApp Post-Application, Post Extract, AnyApp Post Extract, Pre-Verify, Interactive, Verification Function Key (F-Key), Post-Verify, ZoneLink