mSQL - msp_GenerateCorrectedAddresses - US Addressing Settings, Inputs and Outputs

msp_GenerateCorrectedAddresses

 

Input Parameters:

  • Configuration file – the file path of the configuration file to be used when this procedure is run.
  • Datasource ID – specifies the data source to be used within the configuration file, which contains the table and column mapping specifications.

 

Generates corrected addresses for the source addresses specified in the supplied configuration.  The corrected addresses will be written to the output table specified in the configuration, and can be subsequently used in matching processes. 

The source and output mappings can be configured through the Web UI, or directly in the XML in the section called Addressing within the Datasource settings.  The output table generated from the addressing step can then be used as the source table for your addresses within the matching step.

 

Setting

Description

dataSources

Specifies the database connection, table and column mappings used to define the dataset being processed.

To use the resulting corrected address table produced on completion of this process, you should add this table into the datasource.

addressing->databaseSettings->SourceSettings->sourceTables

Table name containing the source address data that is to be used during processing.

addressing->databaseSettings->SourceSettings->sourceColumns

This allows the mapping of the source table’s columns to specific address data types.

addressing->databaseSettings->OutputSettings->outputTable

Name of the table containing the corrected addresses that will be produced following completion of this process.

addressing->databaseSettings->OutputSettings->outputColumns

This allows the configuration of the output columns. The CorrectedMapping attribute is used to specify the address element that should go into a specific field should the source address be validated.

The SourceMapping attribute specifies the source table’s data field that will populate this field, should the source address fail validation.

addressing->databaseSettings->OutputSettings->outputColumns->TIGERData

This section allows configuration of TIGER Data appending (US Only).  The enabled attribute specifies whether or not appending is turned on, and the onlyCodeValidAddresses attribute specifies whether or not to append data for non-verified addresses also.

Each TIGER field can be specified as a sub node of this node, with the name of the field as the name of the node, and an enabled attribute to specify whether or not to append the given field.  This defaults to false.  See this section for an explanation of each TIGER Data field.

(Only applicable for US addressing and is licensed separately from standard US addressing.)

addressing->apiSettings->threadCount

Number of threads that may be used during the processing. Recommendation is to use 1 thread per machine core.

addressing->apiSettings->defaultAPI

When licenced for the UK and US addressing APIs, but not the international addressing API, this setting specifies which addressing API (UK or US) to use for international addresses.

addressing->progressLoggingSettings->filePath

Location of a progress log file which is output during Address processing.

addressing->progressLoggingSettings->interval

How frequently updates will be written to the progress log file (in milliseconds).

 

US Addressing Settings

Setting

Description

Addressing->apiSettings->enabledUS

When set to “false” the US addressing API is not used even when licenced. Default “true”.

addressing->apiSettings->processing

Only applicable for US addresses that contain both a box number and a street number.

Valid values are “PreferBox” and “PreferStreet”; on output the former will place box numbers on the first address line, while the latter will instead place street numbers on the first address line.

addressing->apiSettings->useMixed

If this is set to "true", data is returned in mixed-case format. If this is set to "false", result data is returned in all upper case characters.

addressing->apiSettings->useAlias

If this is set to "true", alias street names are returned when they are used in the input. If this is set to "false", 'official' street names are returned even when alias street names are used in the input.

(An alias street name is an alternative name for a street that is acceptable to the USPS. It may be a name by which a street was formerly known, a commonly-used nickname for the street, or one the community prefers to use.)

addressing->apiSettings-> noStdOnFail

if true, the addressing engine will skip the street standardization for any lookups which were unsuccessful (lookup return was false) and may not make casing and other changes to records that are partially valid. Note that the Disable19 setting will automatically make this false when Disable19 is set to True

addressing->apiSettings-> verifyState

if true, the addressing engine will add an additional verification step for any state which it wants to change from the input state based on where the address is delivered from as opposed to the state where the actual address is located. 

*setting is required to be turned off to properly qualify for local CASS Certified Processing.

addressing->apiSettings-> disable19

if true, all records that match against the Zip+4 data will return an AddrScore of 0 which can be ambiguous. If set to false, the addressing engine will return the AddrScore 19 which details a 'DPV NoMatch'.
This means that the address was found in the Zip+4 data which is valid down to the street and premise range, but not matched against the DPV reference (meaning it is not a valid delivery point).

This setting is True by default for backwards compatability purposes and overrides the noStdOnFail setting.

 

US Addressing Input Fields

Name

Description

Organization or Company

Specifies the company name.

Suite

Specifies the suite or unit.

Address1, Address2 or Street, Street2

Specifies address lines.

Urbanization

Specifies the urbanization.

City or Town

Specifies the city.

State or County or Region

Specifies administrative area.

Zip or Zipplus4 or Postcode

Specifies the 5-digit or 9-digit ZIP code.

Plus4

Specifies the ZIP+4 (if these are in separate columns).

 

Output Fields

The following result code fields are always output:

Name

Description

AddrEngine

This indicates the addressing API (UK, US, INTernational) that each record is verified with (this is only output if licensed for multiple APIs).

PafFlag

A numeric representation of the PafDesc column.

PafDesc

Indicates the level at which an address was validated (“Verified”, “Good”, “Partial”, “Tentative”, and “NoMatch”). See US engine specific sections here for details.

PafDescExtra

See US engine specific description here.

ErrorCode

See US engine specific description here.

AddrScore

See US engine specific description here.

UpdateFlag

See US engine specific description here.

User specified output fields have a source mapping and one or more corrected mappings.

Source Mapping - The default mapping for data to populate in the selected column when no address match can be found for the given input. Available values will be the Address Types assigned to the Source Columns. Select 'None' for no default data.

Corrected Mappings - The corrected elements to populate in the selected column when a match is found. See the US engine specific output fields here. Multiple elements are permitted for a single output column, and will be separated with a space when combined.

 

Was this article helpful?
0 out of 0 found this helpful

have a question or not finding what you're looking for?

Submit a ticket to get some help