Matching Options - enterprise_tax - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413
Matching options control the address search methodology and match results handling returned by Assign GeoTAX Info.
Note: As Spectrum Enterprise Tax transitions its administrative tasks to a web-based Management Console, labels for the options may use different wording than what you see in Enterprise Designer. There is no difference in behavior.
Option Name optionName Parameter Description

Optional files: The following options enable the database resource(s) to use in the search process.

Use GeoTAX Auxiliary file

UseGeoTaxAuxiliaryFile

Option.UseGeoTaxAuxiliaryFile

Specifies whether or not Assign GeoTAX Info should attempt a match to the GeoTAX Auxiliary file. The GeoTAX Auxiliary file contains new addresses that have not yet been added to the Primary File.

Y
Use the GeoTAX Auxiliary file for matching. (default)
N
Do not use the GeoTAX Auxiliary file for matching.

Use user auxiliary file

UseAuxiliaryFile

Option.UseAuxiliaryFile

Specifies whether to attempt a match to a User Auxiliary file. User Auxiliary files are user-defined files that override results from the primary files in street-level matching.

Y
Use the User Auxiliary file for matching.
N
Do not use the User Auxiliary file for matching. (default)

State supplied file

Specifies a state-supplied file to use for address matching. State-supplied files are provided by individual state governments. By matching to the state-supplied files, you can remain compliant with tax jurisdiction assignment requirements mandated by new federal and state laws, such as the Mobile Telecommunications Sourcing Act and the Florida state Communications Services Tax Simplification Law.

There are two supported file formats: the Florida-native format and the national TS-158 format (ANSI Transaction Set No. 158). The state of Florida provides address files in both the TS-158 and its own native format. The state of Washington provides address data in the TS-158 format.

Assign GeoTAX Info attempts to match to the state supplied file first. If a state match cannot be found, it attempts a match to the primary files.

You must install the appropriate state-supplied file to use these options. For instructions, see the Spectrum Technology Platform Installation Guide.

None
Do not use a state-supplied file. (default)
Florida-Native
Use the Florida-native state-supplied file.
TS-158
Use the TS-158 state-supplied file.
Florida-Native with relaxed secondary matching
Use the Florida-native state-supplied file and allow the system to match input addresses with secondary information to records without secondary information.
Note: If you use the Spectrum Technology Platform API, see Specifying Default State-Supplied File Options for information on how these values affect the default values for related API options.

UseStateProvidedFile

Option.UseStateProvidedFile

Specifies whether to attempt a match to the state-supplied file. Use this option in combination with FileSearchOrder to specify a state-supplied file to use.

State-supplied files are provided by individual state governments. By matching to the state-supplied files, you can remain compliant with tax jurisdiction assignment requirements mandated by new federal and state laws, such as the Mobile Telecommunications Sourcing Act and the Florida state Communications Services Tax Simplification Law.

There are two supported file formats: the Florida-native format and the national TS-158 format (ANSI Transaction Set No. 158). The state of Florida provides address files in both the TS-158 and its own native format.

If this option is enabled, the address is first matched to the state supplied file. If a state match cannot be found, the primary files are used to attempt a match.

Y
Use the State-supplied file for matching.
N
Do not use the State-supplied file for matching. (default)
Note: You must install the appropriate State-supplied file to use these options. For instructions, see the Spectrum Technology Platform Installation Guide.

FileSearchOrder

Option.FileSearchOrder

Specifies which state-supplied file to use. This option only takes effect if you specify UseStateProvidedFile=Y. This option only takes effect if you specify Option.UseStateProvidedFile=Y. One of the following:

FLOnly
Use only the Florida-native formatted file. (default)
TSOnly
Use only the TS-158 formatted file.

UseRelaxedSecondaryMatching

Option.UseRelaxedSecondaryMatching

Specifies whether input addresses with secondary information are matched to records without secondary information. This option applies only to Florida-native files.

Y
Use relaxed secondary matching.
N
Do not use relaxed secondary matching. (default)
Address Searching and Matching: These options can be enabled for use in the address search and match processes.

Match modes

GsMatchMode

Option.GsMatchMode

Match modes determine the leniency used to make a match between your input and the reference database. Select a match mode based on the quality of your input and your desired output. For example, if you have an input database that is prone to errors, you may want to select the relaxed match mode.

Exact
0 - Exact
Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses.
Close
1 - Close
Requires a close match and generates a moderate number of match candidates. (default)
Relaxed
2 - Relaxed
Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if you are not confident that your input is clean; free of misspellings and incomplete addresses. This is the only mode that does not respect the street parity when making an address match.

Search area preference

GsSearchArea

Option.GsSearchArea

The search area options allow for searching the address' finance area or an expanded area specified by distance.

Finance area
1
Searches the entire finance area for a match. A finance area is a region defined by the U.S. Postal Service and typically consists of a set of contiguous ZIP Codes.(default)
Search within radius
2
Searches the area specified by the radius in miles. The search area can be extended up to a 99-mile radius from the centroid of the input ZIP Code to assist in finding a match when the input address contains limited or inaccurate city or ZIP Code information. The expanded area is confined to within the state's borders. Use the Miles input field to enter the search radius (1-99 miles).

GsSearchRadius

Option.GsSearchRadius

Radius for search area.

1-99 miles
Search radius. (default = 0 miles)
Expanded matching

Check for First Letter Missing/Wrong

Option.GsEnableFirstLetterExpanded

GsEnableFirstLetterExpanded

Looks for the correct first letter of a street address if the first letter is missing or incorrect. Spectrum Enterprise Tax searches through the alphabet looking for possible correct first letters to complete the street address.

Note: This feature is disabled by default and cannot be enabled in Exact mode.
Y
Enable first letter change matches.
N
Do not allow first letter change matches. (default)

Allow Ranged Address Numbers

GsEnableRangedAddress

Option.GsEnableRangedAddress

Matches to a house range input. Some business locations are identified by address ranges. For example, a shopping plaza could be addressed as 10-12 Front St. - this is how business mail is typically addressed to such a business location. When this feature is enabled, the address range is geocoded to the interpolated mid-point of the range.

Note: This feature is disabled by default and cannot be enabled in Exact mode.
Y
Allow address range matches.
N
Do not allow address range matches. (default)

Firm name search

GsAlternateLookup

Option.GsAlternateLookup

This option allows specifying the preferred way to match when both an address and firm name are provided. The matching method can be set to match to the address rather than the firm name or vice versa. If neither are specified, the default matching method is to match to the address line only.

Street Lookup Only
Searches only street records. (default)
Prefer Street Name
1
Searches for street name, but if there isn't a match, will use the firm name.
Prefer Firm Name
2
Looks up the firm name, but if there isn't a match, will use the street name.
3
Searches only street records. (default)

Multi-match

GsMultiMatchResolution

Option.GsMultiMatchResolution

A multi-match occurs when multiple equally-scored matches are found in either the Points or Streets files and cannot be resolved to a single best candidate. There are several choices for handling a multi-match outcome:

Reject multi-matches
N
No matches are returned. (default)
Resolve multi-matches
R
Return the first match candidate in the list.
Return all multi-matches
A
The information for all the match candidates is returned.

Specifying Default State-Supplied File Options

If you use the Spectrum Technology Platform API, note that the value you specify in the Management Console for the State supplied file field controls the default settings for three AssignGeoTAXInfo API options: UseStateProvidedFile, UseRelaxedSecondary, and FileSearchOrder. The table below shows how each value in the State supplied file field affects these three options.

"State supplied file" value

UseStateProvidedFile

FileSearchOrder

UseRelaxedSecondary

None

N

N/A

N

Florida-native

Y

FSOnly

N

Florida-native with relaxed secondary matching

Y

FSOnly

Y

TS-158

Y

TSOnly

N