Table of Contents

Search

  1. Preface
  2. Part 1: On-Prem Operations
  3. Part 2: Parameter and Element Reference
  4. Appendix A: Geocode Countries
  5. Appendix B: Certified Mode Values

On-Premises Developer Guide

On-Premises Developer Guide

QuickCapture Mode

QuickCapture Mode

Use QuickCapture mode to receive address suggestions as you type. 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
  • Space
  • Tab
Address Verification can return the total number of addresses in the reference data that match the address that you enter. For information about retrieving the number of matching addresses in the reference data, see Address Count.

Sorting Criteria in QuickCapture Mode

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.
  • The alphabetical order of the province names.
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 the 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 IPv4 format. When you submit an 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
IO
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
IO
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.

House Number Ranges and Sub-Building Ranges in QuickCapture Output

Address Verification uses two periods to indicate a range of house numbers or sub-building numbers in an output address.
When Address Verification identifies a range of addresses with multiple house number options on a single street, it returns the available range in a single record. Address Verification separates the first and last house numbers in the range by two periods. For example, 15500..15508 WESTON PKWY indicates that houses from 15500 through 15508 on WESTON PKWY are candidate matches for the input address.
Likewise, when Address Verification identifies a range of addresses with sub-building number options in a single building, it returns the available range in a single record and separates the first and last sub-building numbers in the range by two periods.
Address Verification might return even-numbered and odd-numbered ranges for an address in separate records. For example,
1..9 MAIN
STREET and
2..10 MAIN
STREET indicate that odd-numbered house numbers from 1 through 9 and even-numbered house numbers from 2 through 10 on MAIN ST are candidate matches for the input 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 does not apply the NumericRangeExpansion parameter to building, sub-building, or house number ranges in QuickCapture mode.


Updated May 13, 2021