ProcessCheck

Edit online

Performs data extraction from checks originating from various regions.

Syntax

boolProcessCheck(stringcountry ,stringcreateFields ,stringcheckBackSideImagePath)

Parameters

country:
The three-letter ISO code that identifies the country for the check to recognize. The following countries are supported:
  • Argentina
  • Brazil
  • Canada
  • France
  • India
  • UK
  • US
createFields:
When set to true, runtime DCO fields are created with the extracted data.
checkBackSideImagePath:

The path to the backside check image. If no image path is provided, then the next subsequent page is used at the back image. To capture only fields on the front of the check, use the value "None". This parameter is used only when the country is India. The back side image parameter that is ignored for all other countries.

Smart parameters are supported.

Level

Page

Returns

True, if the current image is a check. Otherwise, False.

Details

Detects check images and stores the extracted data into variables at the page level. The detected fields for each country are listed below. If a field is not read successfully by the recognition engine, it will not be included in the results. A correctly sized image is critical to obtain recognition results. See the top-level help topic for more information. If the country supports recognition of the Payee, then a vocabulary is required. Payee Vocabularies are created as a comma-separated text file of the following format:

"word or phrase 1",weight

"word or phrase 2",weight

"word or phrase 3",weight

"word or phrase 4",weight

and so on.

The weight is an integer value 1 - 100, inclusive. Words that are expected often should be given a higher weight and words that are expected less often should be given a lower weight. The DCO variable payeeVocab must be set on the page level object with the full path to the vocabulary file.

Example of specifying the vocabulary file by using smart parameters. The vocabulary file can exist anywhere and this example shows how to access a file that has been placed in the application's DCO directory.

rrSet("@PROCESSDIR+\+MyVocabulary.txt","@X.payeeVocab")

When a vocabulary is provided, an optional DCO page variable, payeeVocabCoverage, can be set with an integer value 1 - 100. This variable defines the approximate percentage of input payee names that match entries in a specified vocabulary for payee line recognition. If payeeVocabCoverage is not specified, then default is set to 50 percent.

Recognized check fields for each country

Argentina (ARG)

  • Amount
  • MICR
The following runtime fields are created:
  • Amount
  • AmountFull
  • CAR
  • LAR
  • MICR
  • MICRAccountNumber
  • MICRCheckNumber
  • MICRRoutingNumber
  • MICRData0
  • MICRData1
  • MICRData2
Australia (AUS):
  • Amount
  • CAR
  • LAR
  • MICR
The following fields are created:
  • AmountFull
  • CAR
  • LAR
  • MICR
  • MICRData0
  • MICRData1
  • MICRData2

Australia check processing is provided as a "preview" feature.

Brazil (BRA)

Detects check images and stores the following extracted data into variables at the page level:
  • Amount
  • Date
  • AmountVerification
  • CAR
  • LAR
  • LARCARMismatch
  • MICR
  • PayorId
  • Place
  • TopLine
  • PresenceFront
The following fields are created:
  • Amount
  • AmountFull
  • CAR
  • LAR
  • Date
  • YearPresence
  • MonthPresence
  • DayPresence
  • Interval
  • MICR
  • MICRData0
  • MICRData1
  • MICRData2
  • AmountVerification
  • CARAV
  • LARAV
  • PresenceFront
  • TopLine
  • C1
  • C2
  • C3
  • PayorID
  • Place

Canada (CAN)

Detects check images and stores the following extracted data into variables at the page level:
  • Amount
  • Date
  • MICR
The following fields are created:
  • Amount
  • AmountFull
  • CAR
  • LAR
  • Date
  • YearPresence
  • MonthPresence
  • DayPresence
  • Interval
  • MICR
  • MICRData0
  • MICRData1
  • MICRData2

France (FRA)

Detects check images and stores the following extracted data into variables at the page level:
  • Amount
  • Date
  • AmountVerification
  • CAR
  • LAR
  • LARCARMismatch
  • MICR
  • CheckSum
  • PresenceFront
The following fields are created:
  • Amount
  • AmountFull
  • CAR
  • LAR
  • Date
  • YearPresence
  • MonthPresence
  • DayPresence
  • Interval
  • MICR
  • MICRData0
  • MICRData1
  • MICRData2
  • AmountVerification
  • CARAV
  • LARAV
  • PresenceFront
  • CheckSum

India (IND)

Detects check images and stores the following extracted data into variables at the page level:
  • AccountNoFront
  • AccountNoBack
  • Amount
  • Date
  • AmountVerification
  • CAR
  • LAR
  • LARCARMismatch
  • CtsCompliance
  • CurrencySymbol
  • DdMmYyyyCompliance
  • VerticalTextPresence
  • DateBoxes
  • MICR
Note: For India, front and back information can be recognized. The front image is obtained from the image belonging to the current page object. The back image is specified as the second parameter to this action. If a back image is not specified, then the image belonging to the next consecutive page will be used. To capture the fields on the front of the check only, use the parameter "None" for the back check image.

UK (GBR)

Detects check images and stores the following extracted data into variables at the page level:
  • Amount
  • CAR
  • LAR
  • MICR
  • UK MICR detection is a "preview" feature.
The following fields are created:
  • Amount
  • AmountFull
  • CAR
  • LAR
  • MICR

US (USA)

Detects check images and stores the following extracted data into variables at the page level:
  • Amount
  • Date
  • MICR
  • CAR
  • CAR_D (dollars only)
  • CAR_C (cents only)
  • LAR
  • LAR_D (dollars only)
  • LAR_C (cents only) -CARLARMatchConf
  • CheckDocumentType
  • CheckCharStyle
The following fields and DCO variables are created:
  • Amount
  • Date
  • Year
  • Month
  • Day
  • MICR
  • MICRAccountNumber
  • MICRCheckNumber
  • MICRRoutingNumber
  • MICRAmount
  • MICRData0
  • MICRData1
  • MICRData2
  • CheckNumber
  • PayeeLine

The DCO variable courtesyAcceptLevel can be optionally set to indicate the minimum confidence that is required for the engine to determine whether it should perform Legal Amount Recognition (LAR). The value can range 0 - 100. If set to 0, then the legal amount will not be recognized. If the accept level is set at 100, the legal amount is recognized as often as possible. If not set, the value defaults to 100. To change the default value, set the variable on the page object before calling ProcessCheck(). In some circumstances, the system decides itself to recognize or not the legal amount without depending on combination of accept level and confidence value.

Note: This note for all countries: The DCO fields and variables cannot be created or will be blank, if the text is not recognized or if the information is not on the check. For example, typically checks do not contain the amount in the MICR field. Any country that supports CAR/LAR, the engine attempts to recognize the LAR (Legal Amount) only if the CAR (Courtesy Amount) is not recognized or is recognized with low confidence. The DCO variable, if the CAR (Courtesy Amount) is not recognized or is recognized with low confidence. The DCO variable courtesyAcceptLevel can be set for US check processing to indicate the minimum confidence that is needed before attempting LAR recognition. courtesyAcceptLevel can be set a confidence range of 0 - 100. The Amount contains the recognized amount with a decimal separator. The AmountFull contains the amount without a decimal separator.

The MICRData fields contain the separate logical components of the recognized MICR, such as the Account Number, which is separated out into separate variables. If the MICR is not successfully recognized, then these variables cannot exist.

The CARLARMatchConf variable is generated only if it is supported for the country, the engine recognizes both CAR and LAR, and has made a conclusion regarding the confidence of how well the CAR and LAR values match. The engine's conclusion considers multiple factors and does not rely solely on recognition results. The range is 0 - 100. A confidence of 100 means that the engine believes that the CAR and LAR match. If recognized, the Amount and AmountFull DCO variables and fields have a position of 0,0,0,0. Refer to the CAR for position information. MICR font CMC-7 and E-13B are supported. The CMC-7 font is used in Argentina, Brazil, France, and the E-13B font is used in Canada, India, UK, and US.

This example is a page level rule that performs check recognition on the current page for a French check.

ProcessCheck("FRA", "true", "None")

This example is a page level rule that performs check recognition on the current page for a French check.

See also

Read the top-level help topic for more information about this action library.

It is strongly recommended that the document "Best Practices for optimal text recognition in IBM Datacap" is reviewed to understand how to get the best results from recognition.