Support DESK

Follow

S4.2.1 - msp_GenerateNCOAAddresses

Previous Article matchIT SQL Index Next Article 

This is for US Addressing only

 

 

Before NCOA can be used the first time, follow instructions for initial setup here: Getting Set Up for NCOA

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.

 

GenerateNCOAAddresses can be used to keep your database up-to-date as your customers move or their addresses are corrected.  Note that this is available to licensed users only, and can only process US data.

If you're looking to understand the return codes - please go here

If you're looking to understand the Inputs/Outputs - please go here

 

GenerateNCOAAddresses is available as both a stored procedure and an SSIS task.  The process involves sending data from the input table to an online service, and writing the received processed data into an output table for subsequent processing and use. (Please see the Security Protocol for further information.)

 

Stored Procedure

When running as a stored procedure, the data source is used to configure the input table and field mappings that are passed to the NCOA service. If this will follow GenerateCorrectedAddresses, be sure to use the corrected addresses table and its columns as inputs to the NCOA service.

To use the output NCOA tables and columns in following stored procedures (i.e. GenerateKeys), no further configuration is necessary because the stored procedure will be able to determine the existence of the NCOA table and automatically make use of it.

 

SSIS Task

When running as an SSIS task, the user has a choice of how the input table and mappings are obtained: from a preceding GenerateKeys task (in which case no extra configuration is necessary), from a preceding GenerateCorrectedAddresses task (in which case only the required name fields need mapping, while the corrected addresses are automatically used), or via manual configuration of the connection string, tables, and columns.

To use the output NCOA tables and columns in following tasks (i.e. GenerateKeys), it is necessary to map the table and its columns in the task.

 

 

Setting

Description

dataSources

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

ncoa->customerInfo->listProcessor->name

List processor full name.

ncoa->customerInfo->listProcessor->street

List processor street address.

ncoa->customerInfo->listProcessor->lastLine

List processor city, state, ZIP.

ncoa->customerInfo->listProcessor->phone

List processor telephone number.

ncoa->customerInfo->mailer->name

Mailer full name.

ncoa->customerInfo->mailer->street

Mailer street address.

ncoa->customerInfo->mailer->lastLine

Mailer city, state, ZIP.

ncoa->customerInfo->mailer->phone

Mailer telephone number.

ncoa->output->table->name

Can be used to specify the name of the table that will be created.  If this is left blank, then the table’s name will be automatically generated.

ncoa->output->optionalFields

Any of these fields can be written to the output table. (See Optional Output Fields here.)

ncoa->options->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.

ncoa->options->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.)

ncoa->options->validAddressesOnly

If this is set to “true”, and GenerateCorrectedAddresses has been run beforehand, then only valid addresses (with a score of 0) are processed by the NCOA service.

ncoa->options->blockSize

Data is uploaded to the NCOA service in ‘blocks’.  This setting specifies the maximum number of records per block.

ncoa->options->timeout

The maximum time to allow for every 100,000 records processed, in minutes (the default is 15).

This should be increased if you have a slow internet connection or are experiencing timeouts.

Timeouts can be disabled by specifying 0.

ncoa->options->retries

The maximum number of retry attempts when processing has failed (the default is 1).  Specify 0 to disable retry attempts.

Previous Article matchIT SQL Index Next Article

 

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

0 Comments

Please sign in to leave a comment.