On-Premises Developer Guide

6.3.0
- 6.5.0
- 6.4.0
- 6.2.0
- 6.1.0
- 6.0.0

Back Next

QuickCapture Mode

You can configure QuickCapture mode to enable your end users to receive address suggestions as they type. When the end user enters an address or part of an address, the Address Verification engine returns all candidate matches from the reference data as suggestions to your application.

If address verification finds one or more unique matches for the input address, the end user can select a unique address in your application and the process ends.

If Address Verification finds non-unique matches, such as street address that supports a range of house numbers, the end user can drill down on the address or type additional information. The process continues until the end user selects a single unique address.

QuickCapture Configuration

QuickCapture mode supports single-line data input. Use the SingleAddressLine element and the Country element to retrieve address suggestions. You can receive up to 100 suggestions for an input address in QuickCapture mode.

You can specify the maximum number of suggestions that Informatica Address Verification returns for each partial or complete address that you enter in QuickCapture mode. For information about how to specify the number of address suggestions, see Maximum Number of Results in the Output

Use a character space as the delimiter in the input address. Use the SingleAddressLineDelimiter element to set the output delimiter. The default output delimiter for elements in QuickCapture mode is the semicolon.

You can set the output delimiter to one of the following values:

Comma

Semicolon

Tab

Address Selection Strategies

You can configure QuickCapture mode to return address suggestions in the following ways:

Return addresses based on user input: By default, QuickCapture mode returns addresses from the reference data that match the current data that the user enters.
If QuickCapture mode returns one or more unique addresses, the user can optionally select a unique address and the selection process ends. If the user enters additional data, the data entry triggers another call to the address verification engine, and the engine returns addresses that match the latest input. In this manner, the engine refines the suggestions that it returns based on the user data entry.

For example, if QuickCapture mode returns a house number range such as 11..20 MAIN STREET, the user might enter an address with a house number in that range. QuickCapture mode can then return additional suggestions or a complete address that the user can select.

Drill down on address ranges: QuickCapture mode can permit the end user to click on a non-unique address suggestion and obtain the list of addresses that the address identifies. The user needs to enter address data once. After the initial data entry, the user can select a non-unique address to drill down on the addresses that it represents.; The drill-down process can continue through multiple levels of address suggestions.; To enable the drill-down capability, add the QuickCaptureResultFilter property to your engine integration. Find the property under
Parameters
Country Sets
Result
.; If you do not implement the QuickCaptureResultFilter property, the engine uses the default strategy.; The QuickCaptureResultFilter property is an array of integers where every integer represents an index to a non-unique address suggestion. Configure your software application to read the integers on the property. When the end user selects a non-unique suggestion, the application returns the addresses that the integer represents.

If the user enters additional data while clicking through the drill-down suggestions, the indexes will not match the results for the latest input. In this case, the application must clear the QuickCaptureResultFilter array values and restart the click-through process with the latest address results.

Sorting Criteria

At the highest level, Address Verification sorts address suggestions by the type of address element in each suggestion that most closely matches the input address values.

The ResultGroup property in the AVJob.schema.json file identifies the elements.

Within each group, QuickCapture mode considers the following factors when it sorts and returns address suggestions:

The similarity between the input address and the reference address, as indicated by the MatchPercentage value.

The distance between the input address and the reference address, if the distance can be calculated.

If you provide an IP address or a set of geocoordinates in the input address, the locality that the IP address or the geocoordinates identify becomes the primary sorting criterion within each result group.

Address Verification returns a complete address in suggestions when the address type is S. For other address types, Address Verification may return a partial address that includes the information that links it to a result group.

For more information about the ResultGroup property, see Result Group.

Locality Order in QuickCapture Output

Address Verification can sort the address suggestion list according to the town or city to which the addresses belong, beginning with the addresses in the nearest town or city. Address Verification sorts the addresses by town or city when you include an IP address or a set of geocoordinates in the input address.

You can submit an IP address in the IPv4 format or the IPv6 format. When you submit IP address data with a partial address, Address Verification converts the IP address to a geocode and uses the geocode to select the town or district in which the address is located.

Find the property under

Parameters

Inputs

IPAddress

in the

AVJob.schema.json

file.

You can enter geocoordinates as a single input value, or you can enter the latitude and longitude coordinates as discrete input values.

Find the properties under

Parameters

Inputs

Geocode

in the

AVJob.schema.json

file.

If you enter both IP address and geocoordinate values for an address that you verify in QuickCapture mode, Address Verification gives precedence to the geocoordinates over the IP address.

Rules and Guidelines for QuickCapture Mode

Consider the following rules and guidelines when you submit an address for verification in QuickCapture mode:

QuickCapture mode reads the SingleAddressLine element, the Country element, and optionally the SourceID element. Enter country information in the Country element and not in the SingleAddressLine element.

Ensure that you fully preload the quick capture reference data files before you submit an address in QuickCapture mode.

QuickCapture mode can process an incomplete address. For best results, submit a complete address.

QuickCapture mode can tolerate a mis-spelling in an address element in a manner that batch and interactive modes cannot. For example, QuickCapture mode can recognize 1 FIFTH AVE NEW YO as 1 FIFTH AVE NEW YORK.

When you submit an address to QuickCapture mode in a Chinese or Japanese character set, use a character space as a delimiter between the elements.

Do not separate associated address values. For example, do not add a locality name between a street name and its associated descriptor.

Do not enter a child address element without the corresponding parent element. For example, do not enter a house number without the corresponding street name.

QuickCapture mode may return partial addresses when all elements are not provided on input or when there are ranges in the output that do not uniquely identify an address.

QuickCapture mode supports five-digit ZIP Codes in the United States but does not support +4 digit ZIP Code extensions.

Address Verification expands any house number, building number, and postal code number ranges in the addresses that it returns in a suggestion list in QuickCapture mode. Address Verification performs range expansion from the first eligible address in the suggestion list and can continue to the limit that the MaxResultCount property defines.

Address Verification applies preset values to the NumericRangeExpansion parameter properties in QuickCapture mode. For more information about range expansion, see Expand Numerical Ranges.

Rename Saved Search

Table of Contents

On-Premises Developer Guide

On-Premises Developer Guide

QuickCapture Mode

QuickCapture Mode

QuickCapture Configuration

Address Selection Strategies

Sorting Criteria

Locality Order in QuickCapture Output

Rules and Guidelines for QuickCapture Mode