Address Validator Port Reference

Informatica Data Quality
(Version 9.6.1 HotFix 2)
Address Validator Port
Reference
Informatica Data Quality Address Validator Port Reference
Version 9.6.1 HotFix 2
January 2015
Copyright (c) 1998-2015 Informatica Corporation. All rights reserved.
This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use
and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in
any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. This Software may be protected by U.S.
and/or international Patents and other Patents Pending.
Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as
provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013©(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14
(ALT III), as applicable.
The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us
in writing.
Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange,
PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica
On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and
Informatica Master Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world.
All other company and product names may be trade names or trademarks of their respective owners.
Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights
reserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rights
reserved.Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © Meta
Integration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems
Incorporated. All rights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All
rights reserved. Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights
reserved. Copyright © Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights
reserved. Copyright © Information Builders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved.
Copyright Cleo Communications, Inc. All rights reserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ejtechnologies GmbH. All rights reserved. Copyright © Jaspersoft Corporation. All rights reserved. Copyright © International Business Machines Corporation. All rights
reserved. Copyright © yWorks GmbH. All rights reserved. Copyright © Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved.
Copyright © Daniel Veillard. All rights reserved. Copyright © Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright © MicroQuill Software Publishing, Inc. All
rights reserved. Copyright © PassMark Software Pty Ltd. All rights reserved. Copyright © LogiXML, Inc. All rights reserved. Copyright © 2003-2010 Lorenzi Davide, All
rights reserved. Copyright © Red Hat, Inc. All rights reserved. Copyright © The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright
© EMC Corporation. All rights reserved. Copyright © Flexera Software. All rights reserved. Copyright © Jinfonet Software. All rights reserved. Copyright © Apple Inc. All
rights reserved. Copyright © Telerik Inc. All rights reserved. Copyright © BEA Systems. All rights reserved. Copyright © PDFlib GmbH. All rights reserved. Copyright ©
Orientation in Objects GmbH. All rights reserved. Copyright © Tanuki Software, Ltd. All rights reserved. Copyright © Ricebridge. All rights reserved. Copyright © Sencha,
Inc. All rights reserved. Copyright © Scalable Systems, Inc. All rights reserved. Copyright © jQWidgets. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and/or other software which is licensed under various versions
of the Apache License (the "License"). You may obtain a copy of these Licenses at http://www.apache.org/licenses/. Unless required by applicable law or agreed to in
writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software
copyright © 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License
Agreement, which may be found at http:// www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any
kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.
The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California,
Irvine, and Vanderbilt University, Copyright (©) 1993-2006, all rights reserved.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and
redistribution of this software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html.
This product includes Curl software which is Copyright 1996-2013, Daniel Stenberg, <daniel@haxx.se>. All Rights Reserved. Permissions and limitations regarding this
software are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or
without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
The product includes software copyright 2001-2005 (©) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms
available at http://www.dom4j.org/ license.html.
The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to
terms available at http://dojotoolkit.org/license.
This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations
regarding this software are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html.
This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at
http:// www.gnu.org/software/ kawa/Software-License.html.
This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & Wireless
Deutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are
subject to terms available at http:/ /www.boost.org/LICENSE_1_0.txt.
This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at
http:// www.pcre.org/license.txt.
This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms
available at http:// www.eclipse.org/org/documents/epl-v10.php and at http://www.eclipse.org/org/documents/edl-v10.php.
This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http://
www.stlport.org/doc/ license.html, http:// asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html, http://
httpunit.sourceforge.net/doc/ license.html, http://jung.sourceforge.net/license.txt , http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/
license.html, http://www.libssh2.org, http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/licenseagreements/fuse-message-broker-v-5-3- license-agreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html;
http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt; http://jotm.objectweb.org/bsd_license.html; . http://www.w3.org/Consortium/Legal/
2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http://
forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http://
www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, http://www.slf4j.org/license.html; http://www.iodbc.org/dataspace/iodbc/wiki/iODBC/License; http://
www.keplerproject.org/md5/license.html; http://www.toedter.com/en/jcalendar/license.html; http://www.edankert.com/bounce/index.html; http://www.net-snmp.org/about/
license.html; http://www.openmdx.org/#FAQ; http://www.php.net/license/3_01.txt; http://srp.stanford.edu/license.txt; http://www.schneier.com/blowfish.html; http://
www.jmock.org/license.html; http://xsom.java.net; http://benalman.com/about/license/; https://github.com/CreateJS/EaselJS/blob/master/src/easeljs/display/Bitmap.js;
http://www.h2database.com/html/license.html#summary; http://jsoncpp.sourceforge.net/LICENSE; http://jdbc.postgresql.org/license.html; http://
protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; https://github.com/rantav/hector/blob/master/LICENSE; http://web.mit.edu/Kerberos/krb5current/doc/mitK5license.html; http://jibx.sourceforge.net/jibx-license.html; https://github.com/lyokato/libgeohash/blob/master/LICENSE; https://github.com/hjiang/jsonxx/
blob/master/LICENSE; and https://code.google.com/p/lz4/.
This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and Distribution
License (http://www.opensource.org/licenses/cddl1.php) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code License
Agreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php), the new BSD License (http://opensource.org/
licenses/BSD-3-Clause), the MIT License (http://www.opensource.org/licenses/mit-license.php), the Artistic License (http://www.opensource.org/licenses/artisticlicense-1.0) and the Initial Developer’s Public License Version 1.0 (http://www.firebirdsql.org/en/initial-developer-s-public-license-version-1-0/).
This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this
software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab.
For further information please visit http://www.extreme.indiana.edu/.
This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject
to terms of the MIT license.
This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775;
6,640,226; 6,789,096; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,243,110; 7,254,590; 7,281,001; 7,421,458; 7,496,588; 7,523,121; 7,584,422;
7,676,516; 7,720,842; 7,721,270; 7,774,791; 8,065,266; 8,150,803; 8,166,048; 8,166,071; 8,200,622; 8,224,873; 8,271,477; 8,327,419; 8,386,435; 8,392,460;
8,453,159; 8,458,230; 8,707,336; 8,886,617 and RE44,478, International Patents and other Patents Pending.
DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the
implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is
error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and
documentation is subject to change at any time without notice.
NOTICES
This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software
Corporation ("DataDirect") which are subject to the following terms and conditions:
1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT
INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT
LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.
Part Number: DQ-AVP-96100HF2-0001
Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica My Support Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica Product Availability Matrixes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Informatica How-To Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Informatica Support YouTube Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Informatica Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Informatica Velocity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 1: Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Address Validation Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Address Reference Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Address Validator Modes and Address Reference Data. . . . . . . . . . . . . . . . . . . . . . . . . . 14
Templates and Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Input Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Output Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Multiple-Instance Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Address Validation Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Formatted Addresses and Mail Carrier Standards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Suggestion List Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Customer Segmentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Mail Certification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Regulatory Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Partial Address Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Improvements to Data Quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Address Validation and Informatica AddressDoctor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Before You Begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 2: Address Validation Status Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Address Resolution Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Element Status Ports Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Element Input Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Element Relevance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Element Result Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Extended Element Result Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Geocoding Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4
Table of Contents
Match Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Mailability Score . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Result Percentage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Chapter 3: Building and Residence Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Building Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Building Complete with Sub-building Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Building Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Building Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Building Number Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
House Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
House Number Alpha. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Sub-building Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Sub-building Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Sub-building Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sub-building Number Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Chapter 4: Business and Organization Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Contact Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Contact First Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Contact Function Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Contact Gender Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Contact Last Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Contact Middle Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Contact Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Contact Salutation Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Contact Title Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Organization Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Organization Department Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Organization Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Organization Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Postal Phrase Additional Info Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Postal Phrase Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Postal Phrase Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Postal Phrase Number Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Chapter 5: City and Locality Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Locality Additional Info Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Locality Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Locality Identifier DE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Locality Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Locality Sort Code Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Preferred Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Table of Contents
5
Chapter 6: Country Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Country Abbreviation Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Country ISO2 Char Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Country ISO3 Char Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Country ISO3 Digit Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Country Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Country Name Abbreviation Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Language ISO3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Chapter 7: Customer Segmentation Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
CAMEO Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Category Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Category Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Group Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Group Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
International Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
International Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
MVID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Chapter 8: Enrichment Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Address Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Count Overflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Finance Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Geocoding Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Latitude. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Latitude Longitude Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Longitude. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Record ID Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Time Zone Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Time Zone Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Transaction Key Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Chapter 9: Formatted Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Complete Address Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Country Specific Last Line Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Delivery Address Line Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Formatted Address Line Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Recipient Line Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Chapter 10: Postal Carrier Certification Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Address Matching Approval System Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
6
Table of Contents
AMAS Error Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Barcode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
CASS Error Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Coding Accuracy Support System Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Carrier Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Commercial Mail Receiving Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Default Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Congressional District . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Delivery Point Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Delivery Point Check Digit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Delivery Point Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Delivery Point Validation Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Delivery Point Validation False Positive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Delivery Point Validation Footnote 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Delivery Point Validation Footnote 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Delivery Point Validation Footnote 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Delivery Point Validation Footnote Complete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Delivery Service Locality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Delivery Service Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Delivery Service Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Delivery Sequence File Second Generation No Statistics Indicator. . . . . . . . . . . . . . . . . . . . . 161
Delivery Sequence File Second Generation Vacant Indicator. . . . . . . . . . . . . . . . . . . . . . . . . 162
ELOT Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ELOT Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Early Warning System Return Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Exclude Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
High Rise Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
High Rise Exact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Hygiene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Locatable Address Conversion System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Locatable Address Conversion System Link Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Locatable Address Conversion System Link Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Lot Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
National Address Management Service Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Postal Phrase Number Ports (AMAS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Postal Phrase Prefix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Postal Phrase Suffix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
RD Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Residential Delivery Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
SendRight Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Software Evaluation And Recognition Program Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Table of Contents
7
SOA Record Ignored. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Street Number Ports (AMAS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Suite Link Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Validity Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Zip Move Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Chapter 11: Postcode Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Postcode Ports Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Postal Address Code AT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Postal Address Code RS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Postal Code Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Postcode Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Postcode Add On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Postcode Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Postcode Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Postcode Formatted Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Postcode Unformatted Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Rural Route Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Rural Route Exact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Chapter 12: Province and State Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Province Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Province Abbreviation Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Province Extended Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Province Country Standard Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Province ISO Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Chapter 13: Residual Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Residue Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Residue Superfluous Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Residue Unrecognized Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Chapter 14: Street Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Street Additional Info Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Street Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Street Complete with Number Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Street Identifier DE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Street Name Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Street Number Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Street Number Additional Info Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Street Number Complete Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Street Number Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Street Number Suffix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
8
Table of Contents
Street Post-Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Street Post-Directional Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Street Pre-Descriptor Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Street Pre-Directional Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Chapter 15: Supplementary Data Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Address Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Census Block Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Census Block Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Census Tract Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Choumei Aza Code JP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Choumei Aza and Gaiku Code JP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Consolidated Metropolitan Statistical Area Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Core-Based Statistical Area Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
County Federal Information Processing Standard Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Delivery Point Suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Gaiku Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Gmina Code PL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
INSEE 9-Digit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
INSEE 5-Digit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Institute of Geography and Statistics Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Locality Identifier DE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Metropolitan Statistical Area Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Minor Civil Division Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
National Address Database Identifier ZA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
New Choumei Aza Code JP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Official Municipality Key DE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Place Federal Information Processing Standard Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Postal Address Code AT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Postal Address Code RS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Postal Code Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Primary Metropolitan Statistical Area Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Record Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
State Federal Information Processing Standard Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Street Identifier DE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Supplementary AT Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Supplementary BR Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Supplementary CH Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Supplementary DE Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Supplementary FR Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Supplementary GB Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Supplementary JP Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Supplementary PL Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Table of Contents
9
Supplementary RS Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Supplementary US Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Supplementary ZA Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
TERYT Locality Identifier PL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
TERYT Street Identifier PL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Unique Delivery Point Reference Number GB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Chapter 16: XML Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Input Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
10
Table of Contents
Preface
The Address Validator Port Reference is written for Data Quality users who configure the Address Validator
transformation to perform address parsing and validation tasks. The document describes the functionality and
usage of each port and the types of information each port can contain. The Address Validator Port Reference
lists the ports alphabetically.
This guide assumes that you are familiar with Informatica Developer and with concepts related to address
validation.
Informatica Resources
Informatica My Support Portal
As an Informatica customer, you can access the Informatica My Support Portal at
http://mysupport.informatica.com.
The site contains product information, user group information, newsletters, access to the Informatica
customer support case management system (ATLAS), the Informatica How-To Library, the Informatica
Knowledge Base, Informatica Product Documentation, and access to the Informatica user community.
Informatica Documentation
The Informatica Documentation team makes every effort to create accurate, usable documentation. If you
have questions, comments, or ideas about this documentation, contact the Informatica Documentation team
through email at infa_documentation@informatica.com. We will use your feedback to improve our
documentation. Let us know if we can contact you regarding your comments.
The Documentation team updates documentation as needed. To get the latest documentation for your
product, navigate to Product Documentation from http://mysupport.informatica.com.
Informatica Product Availability Matrixes
Product Availability Matrixes (PAMs) indicate the versions of operating systems, databases, and other types
of data sources and targets that a product release supports. You can access the PAMs on the Informatica My
Support Portal at https://mysupport.informatica.com/community/my-support/product-availability-matrices.
Informatica Web Site
You can access the Informatica corporate web site at http://www.informatica.com. The site contains
information about Informatica, its background, upcoming events, and sales offices. You will also find product
11
and partner information. The services area of the site includes important information about technical support,
training and education, and implementation services.
Informatica How-To Library
As an Informatica customer, you can access the Informatica How-To Library at
http://mysupport.informatica.com. The How-To Library is a collection of resources to help you learn more
about Informatica products and features. It includes articles and interactive demonstrations that provide
solutions to common problems, compare features and behaviors, and guide you through performing specific
real-world tasks.
Informatica Knowledge Base
As an Informatica customer, you can access the Informatica Knowledge Base at
http://mysupport.informatica.com. Use the Knowledge Base to search for documented solutions to known
technical issues about Informatica products. You can also find answers to frequently asked questions,
technical white papers, and technical tips. If you have questions, comments, or ideas about the Knowledge
Base, contact the Informatica Knowledge Base team through email at KB_Feedback@informatica.com.
Informatica Support YouTube Channel
You can access the Informatica Support YouTube channel at http://www.youtube.com/user/INFASupport. The
Informatica Support YouTube channel includes videos about solutions that guide you through performing
specific tasks. If you have questions, comments, or ideas about the Informatica Support YouTube channel,
contact the Support YouTube team through email at supportvideos@informatica.com or send a tweet to
@INFASupport.
Informatica Marketplace
The Informatica Marketplace is a forum where developers and partners can share solutions that augment,
extend, or enhance data integration implementations. By leveraging any of the hundreds of solutions
available on the Marketplace, you can improve your productivity and speed up time to implementation on
your projects. You can access Informatica Marketplace at http://www.informaticamarketplace.com.
Informatica Velocity
You can access Informatica Velocity at http://mysupport.informatica.com. Developed from the real-world
experience of hundreds of data management projects, Informatica Velocity represents the collective
knowledge of our consultants who have worked with organizations from around the world to plan, develop,
deploy, and maintain successful data management solutions. If you have questions, comments, or ideas
about Informatica Velocity, contact Informatica Professional Services at ips@informatica.com.
Informatica Global Customer Support
You can contact a Customer Support Center by telephone or through the Online Support.
Online Support requires a user name and password. You can request a user name and password at
http://mysupport.informatica.com.
The telephone numbers for Informatica Global Customer Support are available from the Informatica web site
at http://www.informatica.com/us/services-and-training/support-services/global-support-centers/.
12
Preface
CHAPTER 1
Introduction
This chapter includes the following topics:
•
Address Validation Overview, 13
•
Address Reference Data, 14
•
Templates and Groups, 16
•
Input Groups, 16
•
Output Groups, 17
•
Multiple-Instance Ports, 19
•
Address Validation Projects, 20
•
Formatted Addresses and Mail Carrier Standards, 21
•
Customer Segmentation, 23
•
Mail Certification, 23
•
Regulatory Requirements, 24
•
Partial Address Completion , 25
•
Improvements to Data Quality, 26
•
Address Validation and Informatica AddressDoctor, 27
•
Before You Begin, 27
Address Validation Overview
This document describes the input and output ports that you can select on the Address Validator
transformation.
Use this document to get the following information about each port:
•
The type of information that the port contains.
•
The location of the port in the transformation.
•
The main uses of the port.
•
The port input and output precision values.
•
The other ports that the port can work with in an address.
13
Address Reference Data
An address reference data set describes the addresses that a national mail carrier recognizes for each valid
mailbox in a country. Before you perform address validation with the Address Validator transformation, install
the address reference data on the Informatica services machine in the domain. You buy and download the
address reference data from Informatica.
You install an address reference data file for each country that the source address data identifies. A country
that has a large population might require multiple files. In addition, you can install data files that enrich the
source address data. The mail carrier can use the data enrichments to certify the accuracy of the addresses
and to accelerate mail delivery.
When you perform address validation, the Address Validator transformation compares each input data record
to the address reference data. If the transformation finds the input address in the address reference data, the
transformation updates the record with the correct and complete address data. If you purchased additional
data sets, the transformation can also enrich the address data.
Use the Preferences window in the Developer tool to view information about the address reference data files
on the Informatica services machine in the domain.
Address Validator Modes and Address Reference Data
When you configure the Address Validator transformation, you select the type of address validation that the
transformation performs. The validation type determines whether the transformation compares the input
address to the address reference data. The validation type also specifies the types of address reference data
that the transformation reads.
The Address Validator transformation can read the following types of address reference data:
Address Code Lookup
Install address code lookup data to retrieve a partial address or full address from a code value on an
input port. The completeness of the address depends on the level of address code support in the country
to which the address belongs. To read the address code from an input address, select the countryspecific ports in the Discrete port group.
You can select ports for the following countries:
•
Germany. Returns an address to locality, municipality, or street level.
•
Japan. Returns an address to the unique mailbox level.
•
South Africa. Returns an address to street level.
•
Serbia. Returns an address to street level.
•
United Kingdom. Returns an address to the unique mailbox level.
The Address Validator transformation reads address code lookup data when you configure the
transformation to run in address code lookup mode.
Batch data
Install batch data to perform address validation on a set of address records. Use batch data to verify that
the input addresses are fully deliverable and complete based on the current postal data from the national
mail carrier.
The Address Validator transformation reads batch data when you configure the transformation to run in
batch mode.
14
Chapter 1: Introduction
CAMEO data
Install CAMEO data to add customer segmentation data to residential address records. Customer
segmentation data indicates the likely income level and lifestyle preferences of the residents at each
address.
The Address Validator transformation reads CAMEO data when you configure the transformation to run
in batch mode or certified mode.
Certified data
Install certified data to verify that address records meet the certification standards that a mail carrier
defines. An address meets a certification standard if contains data elements that can identify a unique
mailbox, such as delivery point data elements. When an address meets a certification standard, the mail
carrier charges a reduced delivery rate.
The following countries define certification standards:
•
Australia. Certifies mail according to the Address Matching Approval System (AMAS) standard.
•
Canada. Certifies mail according to the Software Evaluation And Recognition Program (SERP)
standard.
•
France. Certifies mail according to the National Address Management Service (SNA) standard.
•
New Zealand. Certifies mail according to the SendRight standard.
•
United States. Certifies mail according to the Coding Accuracy Support System (CASS) standard.
The Address Validator transformation reads batch data when you configure the transformation to run in
certified mode.
Geocode data
Install geocode data to add geocodes to address records. Geocodes are latitude and longitude
coordinates.
The Address Validator transformation reads geocode data when you configure the transformation to run
in batch mode or certified mode.
Note: Informatica provides different types of geocode data. If you need arrival point or parcel centroid
geocodes for addresses, you must purchase additional geocode data sets.
Interactive data
Install interactive data to find the complete valid address when an input address is incomplete or when
you are uncertain about the validity of the input address.
The Address Validator transformation reads interactive data when you configure the transformation to
run in interactive mode.
Suggestion list data
Install suggestion list data to find alternative valid versions of a partial address record. Use suggestion
list data when you configure an address validation mapping to process address records one by one in
real time. The Address Validator transformation uses the data elements in the partial address to perform
a duplicate check on the suggestion list data. The transformation returns any valid address that includes
the information in the partial address.
The Address Validator transformation reads suggestion list data when you configure the transformation
to run in suggestion list mode.
Supplementary data
Install supplementary data to add data to an address record that can assist the mail carrier in mail
delivery. Use the supplementary data to add detail about the geographical or postal area that contains
Address Reference Data
15
the address. In some countries, supplementary data can provide a unique identifier for a mailbox within
the postal system.
Templates and Groups
You connect the source data ports to predefined ports in the Address Validation transformation. The
transformation has multiple ports for each type of information in the source data set.
You select the ports you need and save them in the transformation. Select input ports that correspond to the
structure and content of the source data. Select output ports that create the address format and data
structure that your organization needs.
The Address Validator transformation organizes input and output ports in groups. Browse the groups to find
the ports that you want to use. You find the groups in a Basic model and an Advanced model in the
transformation. You can define most addresses using ports from the groups in the Basic model. If the
address structure is complex, you may need to select ports in the Advanced model.
Input Groups
You select input ports from one group in the Address Validator transformation.
The transformation has the following input groups:
Discrete
Reads data columns that contain complete information on a single data element, such as house number,
street name, or post code. The Discrete group is available in the Basic and Advanced models.
Hybrid
Reads data columns that contain one or multiple data elements. The Hybrid group combines ports from
the Discrete and Multiline groups. Use Hybrid ports to create address records that you can submit to a
mail carrier. Hybrid ports structure an address to mail carrier standards and identify the type of data on
each line. The Hybrid group is available in the Basic and Advanced models.
Multiline
Reads data columns that contain multiple data elements. Each input string corresponds to a line of an
address that is structured in the format required by the mail carrier. Connect address columns to
Multiline ports to create a printable set of address records.
Each Multiline port represents one line in the printed address, such as the following line of street data:
"123 Main Street Apartment 2"
Multiline ports do not specify the type of data that appears on each address line. The Multiline group is
available in the Basic and Advanced models.
16
Chapter 1: Introduction
Output Groups
You can select output ports from one or more groups in the Address Validator transformation.
The transformation has the following output groups:
Address Elements
Writes street data elements such as house number, apartment number, and street name to separate
ports. Find the Address Elements group in the Basic and Advanced models.
AT Supplementary
Writes data to Austrian addresses that can help postal delivery, such as building-level post code data.
Find the AT Supplementary group in the Basic model.
Australia Specific
Writes data to Australian addresses that enables the addresses to meet the Address Matching Approval
System (AMAS) standards of Australia Post. Find the Australia Specific group in the Basic and Advanced
models.
BR Supplementary
Writes data to Brazilian addresses that can help postal delivery, such as district identification codes from
the Institute of Geography and Statistics (IBGE). Find the BR Supplementary group in the Basic model.
CAMEO
Generates demographic and income summary data that you can use in customer segmentation analysis.
Find the CAMEO group in the Basic model.
Canada Specific
Writes data to Canadian addresses that enables the addresses to meet the Software Evaluation and
Recognition Program (SERP) standards of Canada Post. Find the Canada Specific group in the Basic
model.
CH Supplementary
Writes data to Swiss addresses that can help postal delivery, such as extended post code data. Find the
CH Supplementary group in the Basic model.
DE Supplementary
Writes data to German addresses that can help postal delivery, such as municipality and district code
data. Find the DE Supplementary group in the Basic model.
Contact Elements
Writes person or contact data, such as names, salutations, and job titles. Find the Contact Elements
group in the Advanced model.
Country
Writes the country name or country code defined by the International Organization for Standardization
(ISO). Find the Country group in the Basic and Advanced models.
Formatted Address Line
Writes addresses that are formatted for printing and mailing. Find the Formatted Address Line group in
the Basic and Advanced models.
Output Groups
17
FR Supplementary
Writes data to French addresses that can help postal delivery, such as identification codes from the
National Institute of Statistics and Economic Studies (INSEE). Find the FR Supplementary group in the
Basic model.
France Specific
Writes data to French addresses that enables the addresses to meet the National Address Management
Service (SNA) standards of La Poste. Find the France Specific group in the Basic model.
Geocoding
Generates geocode data, such as latitude and longitude coordinates, for an address. Find the
Geocoding group in the Basic model.
ID Elements
Writes Record ID and Transaction Key data. Find the ID Elements group in the Advanced model.
JP Supplementary
Writes data to Japanese addresses that can help postal delivery, such as choumei aza codes. Find the
JP Supplementary group in the Basic model.
Last Line Elements
Writes data that can appear on the last line of a domestic address. Find the Last Line Elements group in
the Basic and Advanced models.
New Zealand Specific
Writes data to Australian addresses that enables the addresses to meet the SendRight standards of New
Zealand Post. Find the New Zealand Specific group in the Basic model.
PL Supplementary
Writes data to Polish addresses that can help postal delivery, such as Territorial Division (TERYT) data.
Find the PL Supplementary group in the Basic model.
Residue
Writes data elements that the transformation cannot parse to other ports. Find the Residue group in the
Basic and Advanced models.
RS Supplementary
Writes data to Serbian addresses that can help postal delivery, such as post code suffix data. Find the
RS Supplementary group in the Basic model.
Status Info
Generates detailed data on the quality of each input and output address. Find the Status Info group in
the Basic model.
UK Supplementary
Writes data to United Kingdom addresses that can help postal delivery, such as delivery point data. Find
the UK Supplementary group in the Basic model.
US Specific
Writes data to Australian addresses that enables the addresses to meet the Coding Accuracy Support
System (CASS) standards of the United States Postal Service. Find the US Specific group in the Basic
model.
18
Chapter 1: Introduction
US Supplementary
Writes geographic and demographic data such as Federal Information Processing Standard (FIPS)
codes for United States addresses. Find the US Supplementary group in the Basic model.
XML
Writes address record data in an XML structure that the AddressDoctor software library defines. Find the
XML group in the Advanced model.
ZA Supplementary
Writes data to South African addresses that can help postal delivery, such as National Address
Database data. Find the ZA Supplementary group in the Basic model.
Multiple-Instance Ports
Many types of address data can occur more than once in an address. You can select multiple instances of a
port when the address contains multiple cases of a data element.
A multiple-instance port can contain up to six instances. Many addresses use one instance of a port for each
data element that they contain. Some addresses use a second instance of a port. A small set of addresses
use more than one port instance.
Often, the first instance of a port is the primary name or the largest area that the port identifies. You must
verify the relationship between the port instances for any port that you select.
Street Complete Ports Example
A United Kingdom address record can contain two street names when one street is part of a larger street
plan.
The following table contains an address that uses two Street Complete ports:
Port
Data
Street Number Complete 1
1A
Street Complete 1
THE PHYGTLE
Street Complete 2
SOUTH STREET
Locality Name 1
NORFOLK
Postcode 1
NR25 7QE
In the example, the street data in Street Complete 1 is dependent on the street data in Street Complete 2.
The data in Street Number Complete 1 refers to the data in Street Complete 1.
Note: Although Street Complete 1 specifies the location of the mailbox, Street Complete 2 might be the larger
street.
Contact Ports Example
An address record can contain multiple contacts when each contact is a member of the same household.
Multiple-Instance Ports
19
The following table contains an address that uses two Contact Name ports:
Port
Data
Contact Name 1
MR. JOHN DOE
Contact Name 2
MS. JANE DOE
Formatted Address Line 1
2 MCGRATH PLACE EAST
Formatted Address Line 2
ST. JOHN'S NL A1B 3V4
Formatted Address Line 3
CANADA
In the example, the organization can decide on the precedence to apply to Contact Name 1 or Contact Name
2. The Address Validator transformation does not prioritize the contact data.
If you format addresses for printed output, you might use multiple instances of the Formatted Address Line
ports. You can select up to 12 Formatted Address Line ports.
Address Validation Projects
You can use the Address Validator transformation in many types of project. You create an address template
with different ports for each project type.
You can define an address validation project with one or more of the following objectives:
Create formatted addresses that conform to mail carrier standards
You can prepare a large address record set for a mail campaign. If you create the addresses in the
format that the mail carrier prefers, your mail costs are significantly reduced. When you prepare
addresses for mailing, select output ports that write each line of the formatted address to a single port.
You can select a different port for the contact name, the street address lines, and the locality and post
code lines.
Organize addresses by income and lifestyle indicators
You can add customer segmentation data to residential address records. Customer segmentation data
indicates the likely income level and lifestyle preferences of the residents at each address. You select
ports from the CAMEO output group to add customer segmentation data to address records. You can
use customer segmentation data in mail campaigns that target multiple consumer markets.
Create addresses that are certified by the mail carrier
When you prepare a record set for Australia Post, Canada Post, or the United States Postal Service
(USPS), you can add data that confirms the deliverability of each address.
The Address Validator transformation can generate reports to certify that the address records are
complete and accurate to the data standards of each mail carrier.
Create addresses that meet regulatory requirements
You can verify that the address records held by your organization are accurate to industry or government
regulations. Select output ports that write each address data element to a separate field. Also select the
address validation status ports that provide detailed information on the accuracy and completeness of
the output data.
20
Chapter 1: Introduction
Complete partial addresses
You can enter a partial address and retrieve the valid complete addresses that match the partial address
in the reference data. To complete partial addresses, configure the transformation to run in suggestion
list mode or interactive mode. You can enter the input address as a single line on the Complete Address
port.
Improve the data quality of addresses
In parallel with other data projects, you can to improve the structure and general data quality of the
address data set. For example, the data set may contain more columns that you need, or it may contain
the same type of data across multiple columns. You can reduce the number of columns in the data set,
and you can simplify the columns that you use for different types of data.
Formatted Addresses and Mail Carrier Standards
When you prepare address records for a mail campaign, you create a printable address structure that
matches the formatting standards of the mail carrier.
For example, the USPS maintains the following address format for domestic United States addresses:
Line 1
Person/Contact Data
JOHN DOE
Line 2
Street Number, Street, Sub- 123 MAIN ST NW STE 12
Building
Line 3
Locality, State, ZIP Code
ANYTOWN NY 12345
You can define a printable address format that writes each line of the address to a single port. You can use
ports that recognize the types of data on each line, or you can use ports that populate the address structure
regardless of the data on each line.
The following table shows different ways you can format a United States address for printing:
For This Address
Use These Ports
Or Use These Ports
JOHN DOE
Recipient Line 1
Formatted Address Line 1
123 MAIN ST NW STE 12
Delivery Address Line 1
Formatted Address Line 2
ANYTOWN NY 12345
Country Specific Last Line 1
Formatted Address Line 3
Use Formatted Address Line ports when the data set contains different types of address, such as business
and residential addresses. A business address may need three address lines for contact and organization
data. The Address Validator transformation ensures that each business or residential address is correctly
formatted by using Formatted Address Line ports only when they are needed. However, Formatted Address
Line ports do not identify the type of data that they contain.
Use Recipient Line, Delivery Address Line, and Country Specific Last Line ports when all address follow one
format. The Recipient Line, Delivery Address Line, and Country Specific Last Line ports separate the address
data elements by information type and make the data set easy to understand.
Note: You can select other ports to process this address. This example focuses on ports that format the
addresses for printing and delivery.
Formatted Addresses and Mail Carrier Standards
21
Demographic and Geographic Data
When you create a record set for a mail campaign, you can add multiple types of data that may not otherwise
appear in the address. Use this data to review the demographic and geographic spread of the mail items.
For example, you can identify the Congressional District that a United States address belongs to. You can
also generate latitude and longitude coordinates if the destination country includes the coordinates in its mail
system reference data.
Suggestion List Example
You are a data quality specialist at an airline company. You need to ensure that the addresses in the
passenger database are valid and correctly formatted. You design a mapping to verify the addresses that
airline employees enter to the data system.
You configure the mapping to run in suggestion list mode, and you assign the mapping to web services that
run from the data entry applications. When an airline employee enters a partial address to an application, the
web service runs the mapping. The mapping returns all addresses from the address reference data that
match the input data.
When an airline passenger checks in at an airport, an airline employee enters key fields from the passenger
address to the data entry application. When the employee enters the data, the mapping runs.
The following table slows the address data that the employee enters:
Input Element
Data
Street Number
133
Street Name
Fayetteville Street
State
North Carolina
The address validation mapping returns all addresses that contain the input data. The employee can select
an address that the mapping returns or continue to enter the passenger address.
The following table shows a valid complete address and the output ports that contain the address elements:
22
Port
Data
Street Number Complete 1
133
Street Complete 1
Fayetteville Street
Sub-building Complete 1
Suite 201
Locality Complete 1
Raleigh
Postcode Unformatted 1
27601
Postcode Unformatted 2
1356
Province Country Standard
NC
Country Name 1
USA
Chapter 1: Introduction
Customer Segmentation
Customer segmentation data helps you understand the lifestyles and purchasing habits of individuals and
households. You can use customer segmentation data to better understand your current customers and to
identify potential customers.
Customer segmentation is a form of demographic analysis that uses address reference data to estimate the
type of residents that an address is likely to contain. Customer segmentation can provide the following social
and economic indicators for the residents at an address:
•
Number of residents
•
Financial status, such as less affluent, comfortable, or affluent
•
Life stage, such as young families or retired couples
•
Household size, such as singles, couples, or families with children
•
Occupation type, such as blue collar or white collar
•
Property status, such as home rental or home owner
You select ports from the CAMEO output group to add customer segmentation data to address records.
Example: Using CAMEO Port Data in a Mail Campaign
Customer segmentation data applies to residential addresses. You may be able to organize the address
record set by residence type before you perform address validation. For example, you may use the address
records from a Customer Relationship Management (CRM) database as input data for the address validation
mapping. If you cannot verify that the address record set contains residential addresses, use the Category
Code or Group Code port to identify records that return customer segmentation data.
You can select the following ports to verify that an address contains customer or prospect data:
•
Use the Residential Delivery Indicator port with United States data to verify that an address identifies a
private residence.
•
Use contact name and contact function ports to identify mail recipients at a place of business. You may
decide to omit business addresses from the mail campaign. CAMEO ports can return data for a business
address if there are residential addresses nearby.
•
Use sub-building ports to identify apartment residences.
•
Use Commercial Mail Receiving Agent (CMRA) ports to identify commercial mailboxes. You may decide to
omit commercial mailboxes from the mail campaign.
•
Use postal phrase ports to identify Post Office boxes. You may decide to omit Post Office boxes from the
mail campaign.
Mail Certification
The Address Validator transformation has output ports that can indicate if an address contains the data
required by the certification standards of national mail carriers.
The standards require that a software application validates address accuracy and prepares address records
in the correct format for automated mail sorting and delivery. The mail carriers offer discounts to
organizations that use certified applications to prepare address records.
The Address Validator transformation is certified for address validation by the following mail carriers:
Customer Segmentation
23
Australia Post
Australia Post defines the Address Matching Approval System (AMAS) standard for software
applications that validate Australian addresses. Select the Address Matching Approval System Status
port to verify that an address was validated by an AMAS-certified application.
Canada Post
Canada Post defines the Software Evaluation and Recognition Program (SERP) standard for software
applications that validate Canadian addresses. Select the Software Evaluation And Recognition Program
Status port to indicate that an address was validated by a SERP-certified application.
La Poste
La Poste defines the National Address Management Service (SNA) standard for software applications
that validate French addresses. Select the National Address Management Service Status port to indicate
that an address was validated by an SNA-certified application.
New Zealand Post
New Zealand Post defines the SendRight standard for software applications that validate New Zealand
addresses. Select the SendRight Status port to indicate that an address was validated by a SendRightcertified application.
USPS
The USPS defines the Coding Accuracy Support System (CASS) standard for software applications that
validate United States addresses. Select the Coding Accuracy Support System Status port to verify that
an address was validated by a CASS-certified application.
Configure the Address Validator transformation in certified mode to validate address to the mail carrier
standard.
Regulatory Requirements
When you submit an address data set to an industry or government regulator, you must verify that each
address correctly identifies a deliverable mailbox.
The Address Validator transformation can analyze and report on the accuracy and completeness of each
address in the data set. The transformation can also verify that each address can receive mail.
Note: An address can be correct and complete but unable to receive mail. For example, the address may be
vacant, or the property may be under construction. Full regulatory compliance can require that you identify
the undeliverable addresses in your data set. An undeliverable address may contain errors or indicate a
regulatory issue.
Element Status Ports
Use Element Status Ports to confirm the accuracy and completeness of each address. Add the following
status ports to the address template:
24
•
Element Input Status. Describes the quality of the match found between the input address data and the
address reference data.
•
Element Relevance. Identifies the address elements that are necessary for address delivery in the
destination country.
•
Element Result Status. Describes any change made to the input data during processing.
Chapter 1: Introduction
Delivery Point Validation Ports
Use Delivery Point Validation ports to verify that an address contains a deliverable mailbox.
A delivery point is the unique mailbox in an address. In many countries, the mail carrier can encode the data
that identifies the mailbox in the address record. For example, the Royal Mail defines an eight-character
string to identify every valid address in the United Kingdom. The USPS defines an 11-digit number for every
valid address in the United States.
If an address record is complete and correct to the level defined in the address reference data, the Address
Validator transformation can generate delivery point data for the mail carrier. Delivery point data verifies that
the address identifies a currently deliverable mailbox.
You can select different ports to verify the delivery point accuracy of an address. For example, you can select
the Delivery Point Code or Delivery Point Validation Confirmation ports to verify that a United States address
contains a Delivery Point Code (DPC). You can select the Delivery Point Suffix port to verify delivery point
data for a United Kingdom address.
Partial Address Completion
When you use suggestion list mode or interactive mode, you can enter an incomplete address and retrieve
valid and complete addresses from the reference data.
Select suggestion list mode when you are uncertain of an address and you want to view a list of valid
address candidates. Select interactive mode when you are confident of an address and you want to validate
the complete form. In each case, the Address Validator transformation searches the address reference data
and returns all addresses that contain the input data.
Consider the following rules and guidelines when you configure the transformation to run in suggestion list
mode or interactive mode:
•
You can define an input address on multiple ports, or you can enter all address elements on the Complete
Address input port.
•
When you configure the transformation in suggestion list mode, select ports from the Discrete input group.
Alternatively, select a Complete Address port and optionally select a Country Name port from the Multiline
group.
•
Suggestion list mode and interactive mode can return multiple addresses for each input address. The Max
Result Count property specifies an upper limit for the number of addresses returned. If the number of
matching address is greater than the Max Result Count value, the Count Overflow port returns the number
of additional addresses.
•
Informatica AddressDoctor refers to suggestion list mode as fast completion mode.
Partial Address Completion
25
Improvements to Data Quality
You can design an address validation project as part of another data project. Your address validation
objectives may be to review and enhance the quality and structure of the data as part of a data migration or
data warehousing project.
In the address validation stage of a project, your objective may not include building additional data into the
database. Your goal may be to ensure that the data is correct and easy to understand. To achieve this goal,
select ports from the Discrete group.
The Discrete group contains a separate port for each type of information in an address. For example, the
Discrete group contains ports for province name, post code, and country name. It also contains ports with
names that end with the word "Complete."
Complete Ports
The Complete ports each contain all required data for an address element data type.
The following table describes the Complete ports:
Port Type
Description
Building Complete
Contains data that identifies a building in a building
complex.
Geocoding Complete
Contains latitude and longitude coordinates and identifies
the coordinate standard used.
Locality Complete
Contains data that identifies the city or town.
Organization Complete
Contains the full organization name.
Postal Phrase Complete
Contains Post Office Box data.
Postcode Complete
Contains postcode output data.
Street Complete
Contains data that identifies the street.
Street Number Complete
Contains data on a building or house number at street
level.
Sub-building Complete
Contains apartment or suite data.
Combining Complete Ports and Other Ports
Depending on the level of detail you need in the data set, select a Complete port or select the ports that
contain a subset of the complete data. For example, select Organization Complete 1 to write organization
data to a single column. Select Organization Name 1 and Organization Descriptor 1 to check the organization
names against a reference data set or to sort the organizations by type.
Note: Some Complete ports are incompatible with other ports of the same information type. For example, if
you select the Organization Complete 1 input port and the Organization Name 1 or Organization Descriptor 1
input port in the same transformation, the transformation processes the same data twice, which causes
parsing and validation errors.
Read the documentation on each Complete port for information about how you can combine the ports.
26
Chapter 1: Introduction
Organization Complete Example
Each Complete port can contain more than one data element. For example, an Organization Complete port is
composed of two data elements, Organization Name and Organization Descriptor.
The following table shows the relationship between the organization data in the ports:
Port
Data
Organization Complete 1
DEF Inc.
Organization Name 1
DEF
Organization Descriptor 1
Inc.
Address Validation and Informatica AddressDoctor
Informatica AddressDoctor is an Informatica organization with products that include an address validation
software library and a global set of address reference data files. The Address Validator transformation uses
the software library to perform address parsing and validation operations on data. The software library uses
AddressDoctor address reference data files to validate and enhance the address data.
The AddressDoctor software library reads and writes an address record as an XML document. The software
library uses DTD (Document Type Definition) files to define the address structure and to describe the values
in the input and output records. The Address Validator transformation represents each element in the DTD
files as an input port or an output port.
Note: Most of the port names on the Address Validator transformation closely resemble the address element
names in the DTD files. Sometimes, the port names differ from the names in the DTD files. For example, the
Process Status element in the AddressDoctor DTD files corresponds to the Match Code output port in the
Address Validator transformation.
Before You Begin
Before you configure an Address Validator transformation, review the content and structure of the source
data. Review the objectives of your data project, and decide on the types of address data that the project
needs.
Consider the following questions:
How is the source address data structured?
When you connect data columns to an Address Validator transformation, select input ports that best
represent the input address structure. Select output ports that define the address record structures you
need. You can use an Address Validator transformation to create multiple types of address structure in
one data set. You can then select different data columns for different uses.
What datatype can ports contain?
All ports read or write string data.
Address Validation and Informatica AddressDoctor
27
What are the precision values of the data columns?
The precision of a column is its width. Precision is measured in characters. Every Address Validator
transformation port has a default precision value. Before you select a port, verify that it can accept the
data from the port that you will connect to it.
Some ports have different input and output precision values. For example, the Postal Phrase Number
ports have an input precision of 50 and an output precision of 12. When the Address Validator
transformation writes output data to a Postal Phrase Number port, the transformation truncates the data
after 12 characters.
The Address Validator transformation truncates some port data values to ensure that the data does not
exceed the mail carrier limits for formatted data length.
Do you want to want to validate and enhance the deliverable status of the source addresses?
To validate and enhance the status of the addresses, you must buy and install address reference data
sets from Informatica. Use Informatica Administrator to configure the address reference data properties.
If you do not want to validate addresses, you can configure the Address Validator transformation in
parsing mode. Parsing mode lets you create output addresses in the standard postal format for the
destination country. Parsing mode does not verify the accuracy or deliverability of the data.
What countries do the addresses refer to?
Informatica provides address reference data sets on a country basis. You buy and install data for each
country you need.
28
Chapter 1: Introduction
CHAPTER 2
Address Validation Status Ports
This chapter includes the following topics:
•
Address Resolution Code, 29
•
Element Status Ports Overview, 31
•
Element Input Status, 33
•
Element Relevance, 34
•
Element Result Status, 35
•
Extended Element Result Status, 38
•
Geocoding Status, 40
•
Match Code, 41
•
Mailability Score , 44
•
Result Percentage, 45
Address Resolution Code
Output port that contains high-level information about non-valid address elements in an input address. The
code describes the validation issues that affect address records with a Match Code status in the range I1
through I4.
Address Resolution Code Usage
To identify address elements that fail address validation, select the Address Resolution Code port. The port
output codes can also identify the reasons why an address is not valid.
Consider the following factors when you select the Address Resolution Code port:
•
An address with a Match Code status in the range I1 through I4 might contain enough information to be
deliverable by the local mail carrier. The address element that defines the record as not valid might not be
required for delivery.
•
To read the output codes of the Address Resolution Code port, you must understand the types of address
information that the characters in the code represent. For information about the type of address
information that each character in the code represents, see the Element Status Ports Overview.
29
Port Location
The following table provides the location and default precision of the Address Resolution Code port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
30
Address Resolution Code Output Codes
The Address Resolution Code value is a 20-character string in which each character represents a different
type of address information. The following table describes the codes that Address Resolution Code can
return in each position on the output string:
Code
Description
2
The address element is required for delivery but is not present in the input address.
The address reference data contains the missing address element.
An output of 2 indicates that address is not valid for delivery without the address
element.
3
The address element is a house number or street number that is outside the valid
range for the address. For example, the address element contains a house number
that does not exist on the specified street. Suggestion list mode returns alternative
addresses.
4
Address validation cannot verify or correct the address element because the input
address contains more than one instance of the element.
5
The address element is ambiguous in the current address, and the address
reference data contains alternatives. Address validation copies the input element
to the output address.
For example, the address element is a valid post code that does not match a valid
locality in the address.
30
6
The address element contradicts another element in the address. Address
validation cannot determine the correct element for the address. The output
address copies the input address.
7
The address element cannot be corrected without multiple changes to the address.
Address validation can correct the address, but the number of changes indicate
that the address is not reliable.
8
The data does not conform to mail carrier validation rules.
Chapter 2: Address Validation Status Ports
Element Status Ports Overview
The Element Input Status, Element Relevance, Element Result Status, and Extended Element Result Status
ports provides status information about the validity of input and output data elements. Select the element
ports to review the outcomes of an address validation operation.
The codes contain the following information:
•
Element Input Status codes represent the quality of the match found between the input address data and
the reference data.
•
Element Relevance codes identify the address elements that are necessary for address delivery in the
destination country.
•
Element Result Status codes describe any change made to the input data during processing.
•
Extended Element Result Status codes indicate that the address reference data contains additional
information about the address element.
Each port returns a 20-character code in which each character refers to a different address data element.
When you read the output codes on element ports, you must know the element that each character refers to.
The 20 characters consist of 10 pairs. The two codes in each pair represent a type of address information.
For example, the first position in the return code represents basic postal code information.
Note: The Address Resolution Code port returns a 20-character string based on the same address elements
as the Element Status ports.
The following table describes the address elements that the values at each position identify:
Positio
n
Address Element
Description
Address Element Example
1
Postal code level 0
Basic postal code
information, such as a fivedigit ZIP Code.
The five-digit ZIP Code 10118
2
Postal code level 1
Additional postal code
information, such as the final
four digits of a ZIP+4 Code.
0110, in the ZIP+4 Code
10118-0110
3
Locality level 0
Primary location, such as city
or town.
London, in England
4
Locality level 1
Dependent locality, suburb,
village.
Islington, in London
5
Province level 0
Primary region within a
country, such as a United
States state name, Canadian
province name, Swiss canton.
New York State
6
Province level 1
United States county name.
Queens County, in New York State
7
Street level 0
Primary street information.
South Great George's Street
8
Street level 1
Dependent street information.
George's Arcade, on South Great
George's Street
Element Status Ports Overview
31
Positio
n
Address Element
Description
Address Element Example
9
Number level 0
Building or house number
related to the primary street.
460, on South Great George's
Street
10
Number level 1
Building or house number
related to the dependent
street.
81, on George's Arcade
11
Delivery service level 0
Case postale or post box
descriptor and number.
PO Box 111
12
Delivery service level 1
Code of the post office that is
responsible for delivery.
MAIN STN
13
Building level 0
Building name or number.
Alice Tully Hall
Does not identify a house
number.
14
Building level 1
Additional building name or
number.
Starr Theater, at Alice Tully Hall
15
Sub-building level 0
Apartment, suite, or floor
name or number.
80, in 350 5th Avenue, Floor 80
16
Sub-building level 1
Apartment, suite, or floor
information, when paired with
Sub-building level 0
information.
80-18, where 18 is the suite
number and 80 is the floor number
17
Organization level 0
Company name.
Address Doctor GmbH
18
Organization level 1
Additional corporate
information, such as a parent
company.
Informatica Corporation
19
Country level 0
Country name.
United States of America
20
Country level 1
Territory.
United States Virgin Islands
When a port name has a number suffix, level 0 refers to data on port number 1 and level 1 refers to data on
port numbers 2 through 6.
Level 0 information can precede or follow level 1 information in a printed address. For example, Postal code
level 1 follows Postal code level 0, and Locality level 1 precedes Locality level 0.
RELATED TOPICS:
32
•
“Element Input Status” on page 33
•
“Element Relevance” on page 34
•
“Element Result Status” on page 35
•
“Extended Element Result Status” on page 38
Chapter 2: Address Validation Status Ports
Element Input Status
Output port that indicates the similarities between the input address data and the address reference data.
Element Input Status Usage
To view detailed information about the validity of an input address, select Element Input Status. Review the
data on the Element Input Status port to identify any address data element that does not match the reference
data.
To read the output codes on the Element Input Status port, you must understand the types of address
information that the code values refer to. For information about the type of address information that each
character in the code represents, see the Element Status Ports Overview.
Note: Element Input Status contains status information about input address records. To review status
information about output address records, use the Element Result Status port.
Port Location
The following table provides the location and default precision of the Element Input Status port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
30
Element Input Status Output Codes
The Element Input Status value is a 20-character string in which each character represents a different type of
address information. The meanings of the Element Input Status values depend on the operational mode of
the Address Validator transformation.
The following table describes the codes that port can return on each position for address validation:
Code
Description
0
The input address contains no data at the current position.
1
The reference data does not contain the data at the current position.
2
Cannot check the data because the reference data is missing.
3
The data at the current position is incorrect. The reference database suggests that
the number or delivery service value is outside the range that the reference data
expects.
In batch and certified modes, the transformation passes the input data at the
current position uncorrected as output.
4
The data at the current position matches the reference data but contains errors.
5
The data at the current position matches the reference data, but the transformation
corrected or standardized the data.
6
The data at the current position matches the reference data without any error.
Element Input Status
33
The following table describes the codes that port can return on each position for address parsing:
Code
Description
0
The input address contains no data at the current position.
1
The transformation moved the element at the current position to another position in
the output address.
2
The element at the current position matched the reference data value, but the
transformation normalized the element in the output address.
3
The data at the current position is correct.
RELATED TOPICS:
•
“Element Relevance” on page 34
•
“Element Result Status” on page 35
•
“Element Status Ports Overview” on page 31
•
“Extended Element Result Status” on page 38
Element Relevance
Output port that indicates if an address element is required for postal delivery.
The Element Relevance value is a 20-character string in which each character can represent a different type
of address data. After you run the address validation mapping, review the output from this port to identify the
address elements that are necessary for each address. Use the results to verify that you selected the right
output ports for the address data. If you do not select an output port for a relevant address data element, the
output for that address will not be valid.
To read the output codes on the Element Relevance port, you must understand the types of address
information that the characters in the code refer to. For information about the type of address information that
each character in the code represents, see the Element Status Ports Overview.
Element Relevance Usage
Select Element Relevance to identify the address elements that are relevant to delivery for each address in
the data set. You can refer to the list of element code positions and meanings to identify the address
elements.
For example, position 8 in the output codes represents dependent street data. If Element Relevance indicates
that some addresses must contain this information, you must select an output port for dependent street data.
Element Relevance codes apply to addresses with a match code value of V or C. If address validation
defines a different match code for an address, Element Relevance codes are less meaningful.
34
Chapter 2: Address Validation Status Ports
Port Location
The following table provides the location and default precision of the Element Relevance port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
30
Element Relevance Output Codes
The following table describes the codes that Element Relevance can return in each position on the output
string:
Code
Description
0
Not relevant to delivery to the address.
1
Relevant to delivery to the address.
The national postal carrier cannot deliver to the address without the data at this
position in the output string.
RELATED TOPICS:
•
“Element Input Status” on page 33
•
“Element Result Status” on page 35
•
“Element Status Ports Overview” on page 31
•
“Extended Element Result Status” on page 38
Element Result Status
Output port that describes the actions that the address validation process takes for each element in the input
address data.
Element Result Status Usage
Select Element Result Status to identify the address data elements that changed during address validation.
To read the output codes of the Element Result Status port, you must understand the types of address
information that the code values refer to. For information about the type of address information that each
character in the code represents, see the Element Status Ports Overview.
Note: Element Result Status contains status information about output address records. To review status
information about input address records, use the Element Input Status port.
Element Result Status
35
Port Location
The following table provides the location and default precision of the Element Result Status port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
30
Element Result Status Output Codes
The Element Result Status value is a 20-character string in which each character represents a different type
of address information.
The following table describes the codes that Element Result Status can return in each position on the output
string:
Code
Description
0
The output address contains no data at the current position.
1
The transformation cannot find the data at the current position in the reference
data. The transformation copies the input data to the output data.
2
Data at the current position is not checked but is standardized.
3
Data at the current position is checked but does not match the reference data. The
reference data suggests that the number data is not in the valid range. The
transformation copies the input data to the output port.
Applies in batch mode.
4
The transformation copies the input data to the output data because the reference
data is missing.
5
Data at the current position is validated but not changed because multiple matches
exist in the reference data.
Applies in batch mode.
6
Data validation deleted the input value at the current position.
7
Data at the current position is validated but the input data contained a spelling
error. Validation corrected the error with a value from the reference data.
8
Data at the current position is validated and updated with a value from the
reference data.
A value of 8 can also mean that the reference database contains additional data
for the input element. For example, validation can add a building number or subbuilding number if it finds a perfect match for the street name or building name.
36
9
Data at the current position is validated but not changed, and the delivery status is
not clear. For example, the DPV value is wrong.
C
Data at the current position is validated and verified, but the name data is out of
date. Validation changed the name data.
D
Data at the current position is validated and verified but changed from an exonym
to an official name.
Chapter 2: Address Validation Status Ports
Code
Description
E
Data at the current position is validated and verified. However, address validation
standardized the character case or the language.
Address validation can change the language if the value fully matches a language
alternative. For example, address validation can change "Brussels" to "Bruxelles"
in a Belgian address.
F
Data at the current position is validated, verified, and not changed, due to a perfect
match with the reference data.
Positions 19 and 20 in the output string relate to country data.
The following table describes the values that validation can return for positions 19 and 20:
Code
Description
0
The output address contains no data at the current position.
1
Address validation does not recognize the country data.
4
Address validation identifies the country from the Default Country value in the
Address Validator transformation.
5
Address validation cannot determine the country because the reference data
contains multiple matches.
6
Address validation identifies the country from a script.
7
Address validation identifies the country from the address format.
8
Address validation identifies the country from major town data.
9
Address validation identifies the country from province data.
C
Address validation identifies the country from territory data.
D
Address validation identifies the country from the country name, but the name
contains errors.
E
Address validation identifies the country from the address data, for example from
an ISO code or a country name.
F
Address validation identifies the country from the Force Country value set in the
Address Validator transformation.
RELATED TOPICS:
•
“Element Input Status” on page 33
•
“Element Relevance” on page 34
•
“Element Status Ports Overview” on page 31
•
“Extended Element Result Status” on page 38
Element Result Status
37
Extended Element Result Status
Output port that supplements the status data on the Element Input Status port and Element Result Status
port. The port can also indicate the presence of additional information about an address element in the
reference data.
Extended Element Result Status Usage
To verify that an address record is complete, select Extended Element Result Status. The Extended Element
Result Status codes indicate the following general conditions for an address:
•
An address is complete, but the address reference data contains additional information.
•
An address is incomplete because it requires additional address elements.
•
An address is incomplete because the address elements identify more than one mailbox.
To find out if the mail carrier requires the missing information, use the Extended Element Result Status port
with other status ports. For example, the following address does not identify a single building:
1 Harbour Rd.
Wan Chai
Hong Kong Island
The following table describes the status that address validation returns for the Building element:
Element Level
Element Input
Status
Element Result
Status
Extended
Element Result
Status
Element
Relevance
Building level 1
0
0
1
0
The return code of 1 indicates that Hong Kong address reference data includes additional building data for
the address. However, Hongkong Post accepts mail for delivery to the address without the additional data.
Note: To read the output codes on the Extended Element Result Status port, you must understand the types
of address information that the characters in the code refer to. For information about the type of address
information that each character in the code represents, see the Element Status Ports Overview.
Port Location
The following table provides the location and default precision of the Extended Element Result Status port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
30
Extended Element Result Status Output Codes
The Extended Element Result Status value is a 20-character string in which each character represents a
different type of address information.
38
Chapter 2: Address Validation Status Ports
The following table describes the codes that Extended Element Result Status can return in each position on
the output string:
Code
Description
1
Address reference data contains additional information about the address element.
Address validation does not require the additional information.
2
Address validation updated the address element to resolve a data error or format
error. Address validation did not verify the address element.
3
Address validation updated the address element to resolve a data error or format
error. Address validation verified the number data in the address element.
4
Address validation moved the address element to another field to resolve a format
error.
5
Address reference data contains an alternative version of the address element,
such as a preferred locality name.
6
Address validation did not verify all parts of the address element. The element
includes data that address validation cannot validate.
7
Address validation found a valid address element in the wrong position in an
address. Address validation moved the address element to the correct position.
8
Address validation found a valid address element in the wrong data field. Address
validation moved the address element to the correct field.
9
Address validation generated the output element according to mail carrier
validation rules.
A
Address validation found address elements from different address types that are
eligible for the current position. Address validation selected the output address
element that conforms the mail carrier rules in the destination country.
B
Address validation cannot determine the element relevance. Address validation
returns the default value for the country that the address specifies.
C
Suggestion list mode. Address validation can return additional address suggestions
for the address element. To return the additional suggestions, update the Max
Result Count property for the Address Validator transformation.
D
Address validation interpolated the numeric data in the address element.
E
Address validation cannot return the address element in the preferred language.
Address validation returns the element in the default language.
F
Address code lookup mode. The input address is out of date.
RELATED TOPICS:
•
“Element Input Status” on page 33
•
“Element Relevance” on page 34
•
“Element Result Status” on page 35
•
“Element Status Ports Overview” on page 31
Extended Element Result Status
39
Geocoding Status
Output port that indicates the result of the process to generate geocodes for the address. Geocodes are
latitude and longitude coordinates.
Address validation can generate geocodes for different locations in the building or the parcel of land that
contains the mailbox. When you configure the Address Validator transformation, select the type of geocode
data to return for the address set.
You can select one of the following options:
Arrival point
Returns the latitude and longitude coordinates of the entrance to a building or parcel of land. Default
option.
You can select the arrival point option for addresses in the following countries:
Austria, Canada, Denmark, Finland, Germany, Hungary, Latvia, Luxembourg, Mexico, Netherlands,
Norway, Slovenia, Sweden, the United Kingdom, and the United States.
When you select the arrival point option for addresses in the United Kingdom, the Address Validator
transformation returns the rooftop geocodes for the address. Rooftop geocodes identify the physical
center of the building that contains the mailbox.
If the Address Validator transformation cannot return arrival point geocodes for an address, the
transformation returns interpolated geocodes.
Parcel centroid
Returns the latitude and longitude coordinates of the geographic center of a parcel of land at ground
level.
You can select the parcel centroid option for addresses in the following countries:
Austria, Canada, Denmark, Finland, Germany, Hungary, Latvia, Luxembourg, Netherlands, Norway,
Slovenia, Sweden, and the United States.
If the Address Validator transformation cannot return parcel centroid geocodes for an address, the
transformation does not return any geocode data.
Standard
Returns the estimated latitude and longitude coordinates of the entrance to the building or parcel of land.
An estimated geocode is also called an interpolated geocode.
The Address Validator transformation uses the nearest available geocodes in the address reference data
to estimate the geocodes for the address.
Geocoding Status Usage
Select Geocoding Status to view a four-character code that describes the results of the geocode operation for
each address.
The geocode coordinates conform to the World Geodetic Coordinate System of 1984 (WGS84). Coordinates
are in decimal degrees.
40
Chapter 2: Address Validation Status Ports
Port Location
The following table provides the location and default precision of the Geocoding Status port:
Port Type
Port Group
Template Model
Precision
Output
Geocoding
Basic
10
Geocoding Status Output Codes
The following table describes Geocoding Status output codes:
Value
Description
EGC0
Cannot append geocodes to the input address because geocodes are not available
for the address.
EGC1-3
Reserved for future use.
EGC4
Geocodes are partially accurate to the postal code level.
EGC5
Geocodes are accurate to the postal code level.
EGC6
Geocodes are accurate to the locality level.
EGC7
Geocodes are accurate to the street level.
EGC8
Geocodes are accurate to the house number level. The geocodes estimate the
house number location and include an offset to the side of the street that contains
the mailbox.
EGC9
Geocodes are accurate to the arrival point or rooftop.
EGCA
Geocodes are accurate to the center of the parcel of land.
EGCC
The geocode database is corrupted.
EGCN
Cannot find the geocode database.
EGCU
The geocode database is not unlocked.
Match Code
Output port that summarizes the result of the address validation process for each input record. The address
validation process compares each input record with the address reference data that you install.
The Match Code value can summarize the address validation process in the following ways:
•
If an address in the reference data matches the input address, the Match Code value indicates the type of
match that the validation process defines.
Match Code
41
•
If an address in the reference data is more accurate or complete than the input address, the validation
process updates the address. The Match Code value indicates the type of update that the validation
process performs.
•
If the input address matches multiple addresses in the reference data, the validation process can return
multiple address suggestions. The Match Code value indicates the types of suggestions that the validation
process can generate.
•
If the validation process cannot match the input address to the reference data, the Match Code value
indicates the reason for the validation failure.
Note: The Match Code value does not necessarily indicate the quality or deliverability of the address after
validation. If the address validation process validates or updates the address, you can use the Match Code
value as a general indicator of the address quality. Often, the Match Code value describes the result of the
data comparison and does not directly indicate the level of validity of the address.
The AddressDoctor software library displays the Match Code values on the Process Status field.
Match Code Usage
Select Match Code to view a code that represents the result of the address validation process for each
address record.
Use Match Code with the Element Result Status port. Element Result Status provides detailed information
about the validity of the data on each output port.
Port Location
The following table provides the location and default precision of the Match Code port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
4
Match Code Output Codes
The following table describes the Match Code output values and identifies the process modes that return the
values:
42
Code
Description
A1
Address code lookup found a partial address or a complete address for the input
code.
A0
Address code lookup found no address for the input code.
C4
Corrected. All postally relevant elements are checked.
C3
Corrected. Some elements cannot be checked.
C2
Corrected, but the delivery status is unclear due to absent reference data.
C1
Corrected, but the delivery status is unclear because user standardization
introduced errors.
I4
Data cannot be corrected completely, but there is a single match with an address
in the reference data.
Chapter 2: Address Validation Status Ports
Code
Description
I3
Data cannot be corrected completely, and there are multiple matches with
addresses in the reference data.
I2
Data cannot be corrected. Batch mode returns partial suggested addresses.
I1
Data cannot be corrected. Batch mode cannot suggest an address.
N7
Validation error. Validation did not take place because single-line validation is not
unlocked.
N6
Validation error. Validation did not take place because single-line validation is not
supported for the destination country.
N5
Validation error. Validation did not take place because the reference database is
out of date.
N4
Validation error. Validation did not take place because the reference data is corrupt
or badly formatted.
N3
Validation error. Validation did not take place because the country data cannot be
unlocked.
N2
Validation error. Validation did not take place because the required reference
database is not available.
N1
Validation error. Validation did not take place because the country is not
recognized or not supported.
Q3
Suggestion List mode. Address validation can retrieve one or more complete
addresses from the address reference data that correspond to the input address.
Q2
Suggestion List mode. Address validation can combine the input address elements
and elements from the address reference data to create a complete address.
Q1
Suggestion List mode. Address validation cannot suggest a complete address. To
generate a complete address suggestion, add data to the input address.
Q0
Suggestion List mode. There is insufficient input data to generate a suggestion.
RB
Country recognized from abbreviation. Recognizes ISO two-character and ISO
three-character country codes. Can also recognize common abbreviations such as
"GER" for Germany.
RA
Country recognized from the Force Country setting in the transformation.
R9
Country recognized from the Default Country setting in the transformation.
R8
Country recognized from the country name.
R7
Country recognized from the country name, but the transformation identified errors
in the country data.
R6
Country recognized from territory data.
R5
Country recognized from province data.
Match Code
43
Code
Description
R4
Country recognized from major town data.
R3
Country recognized from the address format.
R2
Country recognized from a script.
R1
Country not recognized because multiple matches are available.
R0
Country not recognized.
S4
Parse mode. The address was parsed perfectly.
S3
Parse mode. The address was parsed with multiple results.
S1
Parse mode. There was a parsing error due to an input format mismatch.
V4
Verified. The input data is correct. Address validation checked all postally relevant
elements, and inputs matched perfectly.
V3
Verified. The input data is correct, but some or all elements were standardized, or
the input contains outdated names or exonyms.
V2
Verified. The input data is correct, but some elements cannot be verified because
of incomplete reference data.
V1
Verified. The input data is correct, but user standardization has negatively
impacted deliverability. For example, the post code length is too short.
Mailability Score
Output port that contains a single digit that represents the likelihood of successful delivery to the validated
address, based on overall validation results.
Mailability Score Usage
Select Mailability Score to review code values that summarize the deliverability of the output addresses. The
return codes are in a range from 0 through 5.
A return code of 0 represents an undeliverable address, and 5 represents an address that is certain of
delivery.
Use the Match Code port with the Mailability Score port. The Mailability Score output codes provide additional
information about addresses with Match Code values in the range I1 through I4.
44
Chapter 2: Address Validation Status Ports
Port Location
The following table provides the location and default precision of the Mailability Score port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
2
Mailability Score Output Codes
The following table describes the Mailability Score output codes:
Code
Description
5
Fully certain of delivery
4
Almost certain of delivery
3
Confident of delivery
2
Reasonably confident of delivery
1
Delivery is doubtful
0
Undeliverable
Result Percentage
Output port that indicates the degree of similarity between an input address and the data written as output for
the address. The port represents the similarity as a percentage value.
Result Percentage Usage
To review the levels of similarity between the input and output forms of an address, select Result Percentage.
A value of 100 percent indicates that the input and output addresses match perfectly.
Use Result Percentage to identify addresses that have undergone significant address correction. If the input
and output address records differs significantly, the input record may contain data quality problems that are
relevant to other data management activities. For example, if the organization runs a master data
management program, notify the data stewards that the record is likely to contain poor-quality data. Consider
reviewing the result percentage values for records that return a C match code in batch or certified address
validation.
Port Location
The following table provides the location and default precision of the Result Percentage port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
6
Result Percentage
45
Result Percentage Output Values
The Result Percentage output values range from 0 through 100.
46
Chapter 2: Address Validation Status Ports
CHAPTER 3
Building and Residence Data
Ports
This chapter includes the following topics:
•
Building Complete Ports, 47
•
Building Complete with Sub-building Ports, 49
•
Building Descriptor Ports, 51
•
Building Name Ports, 52
•
Building Number Ports, 54
•
House Number, 56
•
House Number Alpha, 57
•
Sub-building Complete Ports, 58
•
Sub-building Descriptor Ports, 60
•
Sub-building Name Ports, 62
•
Sub-building Number Ports, 64
Building Complete Ports
Input and output ports that contain all building data in an address record. A single Building Complete port
contains all building-level address data. The port does not contain sub-building-level data.
The Building Complete ports contain all the data from the Building Descriptor, Building Name, and Building
Number ports in the address.
The building data ports are related by number. For example, Building Complete 1 contains the data in
Building Descriptor 1 and either Building Name 1 or Building Number 1.
Building Complete Usage
To read all building-level data from a single port, select a Building Complete input port. To write all buildinglevel data to a single port, select a Building Complete output port.
Consider the following guidelines when you use Building Complete ports:
•
There are six Building Complete ports. If an address record contains more than one building, select
additional Building Complete ports.
47
•
Most countries use Building Complete 1 or Building Complete 2 ports. You may need to select a port in
the Building Complete 3 through Building Complete 6 range if the building identification data is highly
complex.
•
For each building in an address, select the Building Complete input port or select one or more of the
Building Descriptor, Building Name or Building Number input ports.
•
You can select all building data output ports.
•
The Address Validator transformation can recognize either building name or building number data in an
address. If an address contains name and number data for a building, the transformation treats the data
as a building name.
•
To write all building-level and sub-building-level data to a single port, select a Building Complete with Subbuilding port.
Port Locations
The following table provides the location and default precision of the Building Complete 1 and Building
Complete 2 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
128
Output
Address Elements
Basic
128
The following table provides the location and default precision of ports Building Complete 3 through Building
Complete 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
128
Building Complete Example
The following example address contains data that can populate the Building Complete 1 and Building
Complete 2 ports:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the building data in the
address:
48
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Chapter 3: Building and Residence Data Ports
Port Name
Data
Building Name 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Name 2
Hiu Fung
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Building Complete with Sub-building Ports
Output ports that contain all building data in an address record. A single Building Complete with Sub-building
port contains all building-level and sub-building-level data.
The Building Complete with Sub-building ports contain all the data from the Building Complete ports and Subbuilding Complete ports in the address.
The building data ports are related by number. For example, Building Complete with Sub-building 1 contains
the data in Building Descriptor 1 and either Building Name 1 or Building Number 1.
Building Complete with Sub-building Usage
To write all building-level data and sub-building-level data to a single port, select a Building Complete with
Sub-building port.
Consider the following guidelines when you use Building Complete with Sub-building ports:
•
There are six Building Complete with Sub-building ports. If an address record contains more than one
building or sub-building, select additional Building Complete with Sub-building ports.
•
Most countries use Building Complete with Sub-building 1 or Building Complete with Sub-building 2 ports.
You might need to select port numbers 3 through 6 if the building identification data is highly complex.
•
You can select Building Complete with Sub-building output ports with other building data output ports.
Building Complete with Sub-building Ports
49
Port Locations
The following table provides the location and default precision of the Building Complete with Sub-building 1
and Building Complete with Sub-building 2 ports:
Port Type
Port Group
Template Model
Precision
Output
Address Elements
Basic
128
The following table provides the location and default precision of ports Building Complete with Sub-building 3
through Building Complete with Sub-building 6:
Port Type
Port Group
Template Model
Precision
Output
Address Elements
Advanced
128
Building Complete with Sub-building Example
The following example address contains data that can populate the Building Complete with Sub-building 1
and Building Complete with Sub-building 2 ports:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the building data in the
address:
50
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Building Complete with Sub-building 1
Apt 231; Floor 12; Hiu Fung Tower; Fung Wah
Estate
Street Number Complete 1
No. 11
Street Complete 1
North St.
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Chapter 3: Building and Residence Data Ports
Building Descriptor Ports
Input and output ports that contain all building descriptor data in an address record.
In address validation, Building Descriptor data identifies the building type. For example, "Tower" is the
building descriptor in "Sears Tower."
The data in a Building Descriptor port is a subset of the data in the corresponding Building Complete port. For
example, Building Complete 1 includes all data in Building Descriptor 1.
Building Descriptor Usage
Select a Building Descriptor input port when an input address contains a building type in a single port.
Select a Building Descriptor output port to write a building type in a single port.
Consider the following guidelines when you use Building Descriptor ports:
•
There are six Building Descriptor ports. If an address record contains more than one building descriptor,
select additional Building Descriptor ports.
•
Most countries use Building Descriptor 1 or Building Descriptor 2 ports. You may need to select a port in
the Building Descriptor 3 through Building Descriptor 6 range if the building data is highly complex.
•
For each building in an address, select the Building Complete input port or select one or more of the
Building Descriptor, Building Number, or Building Name input ports.
•
You can select all building data output ports.
Port Locations
The following table provides the location and default precision of the Building Descriptor 1 and Building
Descriptor 2 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Building Descriptor 3 through Building
Descriptor 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Building Descriptor Example
The following example address contains data that can populate the Building Descriptor 2 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
Building Descriptor Ports
51
The following table shows the Address Validator transformation ports that relate to the building descriptor
data in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Name 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Name 2
Hiu Fung
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Building Name Ports
Input and output ports that contain all building name data in an address record.
The data in a Building Name port is a subset of the data in the corresponding Building Complete port. For
example, Building Complete 1 includes all data in Building Name 1.
Building Name Usage
Select a Building Name input port when an input address contains a building name in a single port.
Select a Building Name output port to write the name of a building in the address in a single port.
Consider the following guidelines when you use Building Name ports:
52
•
There are six Building Name ports. If an address record contains more than one building name, select
additional Building Name ports.
•
Most countries use Building Name 1 or Building Name 2 ports. You may need to select a port in the
Building Name 3 through Building Name 6 range if the building data is highly complex.
•
For each building in an address, select the Building Complete input port or select one or more of the
Building Name, Building Number, or Building Descriptor input ports.
•
You can select all building data output ports.
Chapter 3: Building and Residence Data Ports
•
The Address Validator transformation can recognize either building name or building number data in an
address. If an address contains name and number data for a building, the transformation treats the data
as a building name.
Port Locations
The following table provides the location and default precision of the Building Name 1 and Building Name 2
ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
50
The following table provides the location and default precision of ports Building Name 3 through Building
Name 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
50
Building Name Example
The following example address contains data that can populate the Building Name 1 and Building Name 2
ports:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the building name data in
the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Name 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Name 2
Hiu Fung
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Building Name Ports
53
Port Name
Data
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Building Number Ports
Input and output ports that contain all building number data in an address record.
In address validation, Building Number data identifies a building within a set of buildings. For example, the
digit "2" is the building number in "Terminal 2." Building numbers do not identify houses or other buildings at
street level. Use the Street Number ports to identify houses or other buildings on a street.
The data in a Building Number port is a subset of the data in the corresponding Building Complete port. For
example, Building Complete 1 includes all data in Building Number 1.
Building Number Usage
To read the building number from a single port in an input address, select a Building Number input port.
To write the building number to a single port in an output address, select a Building Number output port.
Consider the following guidelines when you use Building Number ports
54
•
There are six Building Number ports. If an address record contains more than one building number, select
additional Building Number ports.
•
Most countries use Building Number 1 or Building Number 2 ports. Select a port in the Building Number 3
through Building Number 6 range if the building data is highly complex.
•
For each building in an address, select the Building Complete input port or select one or more of the
Building Name, Building Number, or Building Descriptor input ports.
•
You can select all building data output ports.
•
The Address Validator transformation can recognize either building name or building number data in an
address. If an address contains name and number data for a building, the transformation treats the data
as a building name.
Chapter 3: Building and Residence Data Ports
Port Locations
The following table provides the location and default precision of the Building Number 1 and Building Number
2 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Building Number 3 through Building
Number 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Building Number Example
The following address contains data that can populate the Building Number 1 and Building Number 2 ports:
Ms. S. Chen
Kin Liong Mansion 5
No. 16 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation port that relates to the building number data
in the address:
Port Name
Data
Contact Complete 1
Ms. S. Chen
Building Complete 1
Kin Liong Mansion 5
Building Name 1
Kin Liong Mansion
Building Number 1
5
Street Complete 1
North St.
Street Number Complete 1
No. 16
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Building Number Ports
55
House Number
Output port that contains the building number in a New Zealand residential address.
The house number identifies a building at street level. If the building contains multiple residences, such as an
apartment building, use sub-building ports to identify the apartments.
To view street number data for an Australian address, configure the Address Validator transformation in
certified mode.
House Number Usage
To write the number of a residential building to a single port, select the House Number port.
Use the House Number port for New Zealand addresses. Use the Street Number ports for addresses from
other countries.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
House Number Example
The following address contains data that can populate the House Number port:
JOHN SMITH
1153 GREAT SOUTH ROAD
EPSOM
AUCKLAND 1050
The following table shows the ports that relate to house number data in the address:
Port Name
Data
Recipient Line 1
JOHN SMITH
House Number
1153
Street Name 1
GREAT SOUTH ROAD
Locality Name 2
EPSOM
Locality Name 1
AUCKLAND
Postcode 1
1050
Note: New Zealand Post includes the suburb and city name in an urban address.
56
Chapter 3: Building and Residence Data Ports
RELATED TOPICS:
•
“House Number Alpha” on page 57
House Number Alpha
Output port that contains the building identifier in a New Zealand residential address when the identifier
includes alphabetic characters.
The house number identifies a building at street level. If the building contains multiple residences, such as an
apartment building, use sub-building ports to identify the apartments.
To view street number data for a New Zealand address, configure the Address Validator transformation in
certified mode.
House Number Alpha Usage
To write an alphabetic or alphanumeric building identifier to a single port, select House Number Alpha.
The House Number Alpha port applies to New Zealand addresses. To write building identifier data for other
countries to a single port, use the Street Number and Street Number Suffix ports.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
House Number Alpha Example
The following address contains data that can populate the House Number port:
ANNE BROOKS
224B CLARENCE STREET
VOGELTOWN
WELLINGTON 6023
The following table shows the ports that relate to house number data in the address:
Port Name
Data
Recipient Line 1
ANNE BROOKS
House Number Alpha
224B
Street Name 1
CLARENCE STREET
Locality Name 2
VOGELTOWN
Locality Name 1
WELLINGTON
Postcode 1
6023
Note: New Zealand Post includes the suburb and city name in an urban address.
House Number Alpha
57
RELATED TOPICS:
•
“House Number” on page 56
Sub-building Complete Ports
Input and output ports that contain the sub-building data in an address record.
Sub-building data identifies a mailbox location inside a building, such as an apartment, suite, or floor.
The Sub-building Complete ports contain all data in the following ports:
•
Sub-building Descriptor
•
Sub-building Name
•
Sub-building Number
Sub-building ports are related by port number. For example, Sub-building Complete 1 contains all data in
Sub-building Descriptor 1, Sub-building Name 1, and Sub-building Number 1 ports.
Sub-building Complete Usage
Select a Sub-building Complete input port when an input address contains all data related to one sub-building
level in a single port.
Select a Sub-building Complete output port to write all data related to one sub-building level to a single port.
Consider the following guidelines when you use Sub-building Complete ports:
•
There are six Sub-building Complete ports. If an address record contains more than one sub-building
level, select additional Sub-building Complete ports.
•
The Address Validator transformation does not parse the sub-building data by type. One address may
have apartment data at sub-building 1 level, while another address may have floor data at sub-building 1
level and apartment data at sub-building 2 level.
•
Most countries use Sub-building Complete 1 or Sub-building Complete 2 ports. You may need to select a
port in the Sub-building Complete 3 through Sub-building Complete 6 range if the building data is highly
complex.
•
For each sub-building level in an address, select the Sub-building Complete input port or select one or
more of the Sub-building Descriptor, Sub-building Name, or Sub-building Number input ports.
•
You can select all sub-building data output ports.
Port Locations
The following table provides the location and default precision of the Sub-building Complete 1 and Subbuilding Complete 2 ports:
58
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Output
Address Elements
Basic
128
Chapter 3: Building and Residence Data Ports
The following table provides the location and default precision of ports Sub-building Complete 3 through Subbuilding Complete 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
128
Sub-building Complete Example
The following example address contains data that can populate the Sub-building Complete 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Hiu Fung Tower, Fung Wah Estate
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to sub-building data in the
address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Name 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Name 2
Hiu Fung
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Sub-building Descriptor 1
Floor
Sub-building Descriptor 2
Apt
Sub-building Number 1
12
Sub-building Number 2
231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Sub-building Complete Ports
59
Port Name
Data
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Sub-building Descriptor Ports
Input and output ports that describe the type of sub-building data in an address record.
Sub-building data identifies a mailbox location inside a building, such as an apartment, suite, or floor. For
example, the Address Validator transformation parses "Suite" in "Honeymoon Suite" to a Sub-building
Descriptor port.
Sub-building ports are related by port number. For example, Sub-building Complete 1 contains all data in
Sub-building Descriptor 1, Sub-building Name 1, and Sub-building Number 1 ports.
Sub-building Descriptor Usage
Select a Sub-building Descriptor input port when an input address contains terms such as apartment, floor, or
suite at a sub-building level in a single port.
Select a Sub-building Descriptor output port to write terms such as apartment, floor, or suite to a single port.
Consider the following guidelines when you use Sub-building Descriptor ports:
•
There are six Sub-building Descriptor ports. If an address record contains more than one sub-building
level, select additional Sub-building Descriptor ports.
•
The Address Validator transformation does not parse the sub-building data by type. One address may
have apartment data at sub-building 1 level, while another address may have floor data at sub-building 1
level and apartment data at sub-building 2 level.
•
Most countries use Sub-building Descriptor 1 or Sub-building Descriptor 2 ports. You may need to select a
port in the Sub-building Descriptor 3 through Sub-building Descriptor 6 range if the sub-building data is
highly complex.
•
For each sub-building level in an address, select a Sub-building Complete input port or select one or more
of the Sub-building Descriptor, Sub-building Name, or Sub-building Number input ports.
•
You can select all sub-building ports as outputs.
Port Locations
The following table provides the location and default precision of the Sub-building Descriptor 1 and Subbuilding Descriptor 2 ports:
60
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
Chapter 3: Building and Residence Data Ports
The following table provides the location and default precision of ports Sub-building Descriptor 3 through
Sub-building Descriptor 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Sub-building Descriptor Example
The following example address contains data that can populate Sub-building Descriptor ports:
Mr. J. Tsang
Floor 12, Apt A
Hiu Fung Tower, Fung Wah Estate
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to sub-building descriptor
data in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Name 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Name 2
Hiu Fung
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt A
Sub-building Descriptor 1
Floor
Sub-building Descriptor 2
Apt
Sub-building Number 1
12
Sub-building Name 2
A
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Sub-building Descriptor Ports
61
Port Name
Data
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Sub-building Name Ports
Input and output ports that contain the sub-building name data in an address record.
Sub-building data identifies a mailbox location inside a building, such as an apartment, suite, or floor. For
example, the Address Validator transformation parses "Honeymoon" in "Honeymoon Suite" to a Sub-building
Name port.
Sub-building ports are related by port number. For example, Sub-building Complete 1 contains all data in
Sub-building Descriptor 1, Sub-building Name 1, and Sub-building Number 1 ports.
Sub-building Name Usage
Select a Sub-building Name input port when an input address contains the name of an apartment, floor, or
suite in a single port.
Select a Sub-building Name output port to write the apartment, floor, or suite name to a single port.
Consider the following guidelines when you use Sub-building Name ports:
•
There are six Sub-building Name ports. If an address record contains more than one sub-building level,
select additional Sub-building Name ports.
•
The Address Validator transformation does not parse the sub-building data by type. One address may
have apartment data at sub-building 1 level, while another address may have floor data at sub-building 1
level and apartment data at sub-building 2 level.
•
Most countries use Sub-building Name 1 or Sub-building Name 2 ports. You may need to select a port in
the Sub-building Name 3 through Sub-building Name 6 range if the sub-building data is highly complex.
•
For each sub-building level in an address, select a Sub-building Complete input port or select one or more
of the Sub-building Descriptor, Sub-building Name, or Sub-building Number input ports.
•
You can select all sub-building data output ports.
•
The Address Validator transformation parses alphanumeric sub-building data as numeric data. For
example, "33C" in "Apartment 33C" is an apartment number.
Port Locations
The following table provides the location and default precision of the Sub-building Name 1 and Sub-building
Name 2 ports:
62
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
50
Chapter 3: Building and Residence Data Ports
The following table provides the location and default precision of ports Sub-building Name 3 through Subbuilding Name 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
50
Sub-building Name Example
The following example address contains data that can populate the Sub-building Name 2 port:
Mr. J. Tsang
Floor 12, Apt A
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to sub-building name data in
the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Building Descriptor 2
Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt A
Sub-building Descriptor 1
Floor
Sub-building Descriptor 2
Apt
Sub-building Number 1
12
Sub-building Name 2
A
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Sub-building Name Ports
63
Sub-building Number Ports
Input and output ports that contain the sub-building number data in an address record.
Sub-building data identifies a mailbox location inside a building, such as an apartment, suite, or floor. The
Address Validator transformation parses the number "200" in "79 Park Avenue, Apartment 200" to a Subbuilding Number port.
The Sub-building Number ports contain a subset of the data in the Sub-building Complete ports.
Sub-building Number Usage
Select a Sub-building Number input port when an input address contains apartment, floor, or suite number
data in a single port.
Select a Sub-building Number output port to write the apartment, floor, or suite number to a single port.
Consider the following guidelines when you use Sub-building Number ports:
•
There are six Sub-building Number ports. If an address record contains more than one sub-building level,
select additional Sub-building Number ports.
•
The Address Validator transformation does not parse the sub-building data by type. One address may
have apartment data at Sub-building Number 1 level, while another address may have floor data at Subbuilding Number 1 and apartment data at Sub-building Number 2.
•
Most countries use Sub-building Number 1 or Sub-building Number 2 ports. You may need to select a port
in the Sub-building Number 3 through Sub-building Number 6 range if the sub-building data is highly
complex.
•
For each sub-building level in an address, select a Sub-building Complete input port or select one or more
of the Sub-building Descriptor, Sub-building Name, and Sub-building Number input ports.
•
You can select all sub-building data output ports.
•
The Address Validator transformation parses alphanumeric sub-building data as numeric data. For
example, "33C" in "Apartment 33C" is an apartment number
Port Locations
The following table provides the location and default precision of the Sub-building Number 1 and Sub-building
Number 2 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
50
The following table provides the location and default precision of ports Sub-building Number 3 through Subbuilding Number 6:
64
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Chapter 3: Building and Residence Data Ports
Sub-building Number Example
The following example address contains data that can populate the Sub-building Number ports:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to sub-building number data
in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Sub-building Number 1
12
Sub-building Number 2
231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Sub-building Number Ports
65
CHAPTER 4
Business and Organization Data
Ports
This chapter includes the following topics:
•
Contact Complete Ports, 66
•
Contact First Name Ports, 68
•
Contact Function Ports, 69
•
Contact Gender Ports, 70
•
Contact Last Name Ports, 72
•
Contact Middle Name Ports, 73
•
Contact Name Ports, 74
•
Contact Salutation Ports, 75
•
Contact Title Ports, 77
•
Organization Complete Ports, 78
•
Organization Department Ports, 79
•
Organization Descriptor Ports, 81
•
Organization Name Ports, 83
•
Postal Phrase Additional Info Ports, 84
•
Postal Phrase Complete Ports, 86
•
Postal Phrase Descriptor Ports, 87
•
Postal Phrase Number Ports, 89
Contact Complete Ports
Input and output ports that contain all data related to contact or person names in the address record.
The Contact Complete ports contain all the data in the following ports:
66
•
Contact First Name
•
Contact Last Name
•
Contact Middle Name
•
Contact Name
•
Contact Salutation
•
Contact Title
Note: The Contact Name port contains the data in the Contact First Name, Contact Last Name, and Contact
Middle Name ports.
The contact data ports are related by port number. For example, Contact Complete 1 contains all data in the
Contact First Name 1, Contact Last Name 1, Contact Middle Name 1, Contact Name 1, Contact Salutation 1,
and Contact Title ports.
Contact Complete Usage
Select a Contact Complete input port when an input address contains all data related to a contact or person
in a single port.
Select a Contact Complete output port to write all data related to a contact or person in a single port.
Consider the following guidelines when you use Contact Complete ports:
•
There are three Contact Complete ports. If an address record contains more than one contact, select
additional Contact Complete ports.
•
For each contact in an address, if you select a Contact Complete input port, do not select a Contact First
Name, Contact Last Name, Contact Middle Name, Contact Name, Contact Salutation, or Contact Title
port. You can select a Contact Complete input port with the corresponding Contact Function and Contact
Gender input ports.
•
You can select all contact ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Complete 1, Contact Complete
2, and Contact Complete 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
Contact Complete Example
The following table shows the Address Validator transformation ports that can contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Complete Ports
67
Port Name
Data
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact First Name Ports
Input and output ports that contain the first name of any contact in the address record.
Use a Contact First Name port with a Contact Last Name port. Optionally, use a Contact Middle Name port.
The contact data ports are related by port number. For example, Contact Name 1 contains all data in the
Contact First Name 1, Contact Last Name 1, and Contact Middle Name 1 ports.
Note: The Contact Complete port also contains contact first name data.
Contact First Name Usage
Select a Contact First Name input port when an input address contains the first name of a contact.
Select a Contact First Name output port to write the first name of a contact in a single port.
Consider the following guidelines when you use Contact First Name ports:
•
There are three Contact First Name ports. If an address record contains more than one contact, select
additional Contact First Name ports.
•
For each contact in an address, select the Contact Name input port or select one or more of the Contact
First Name, Contact Last Name, and Contact Middle Name input ports. If you select a Contact First Name
port, do not select the corresponding Contact Complete port.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact First Name 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact First Name 2 and Contact First
Name 3 ports:
68
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Chapter 4: Business and Organization Data Ports
Contact First Name Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Function Ports
Input and output ports that contain the job title of any contact in the address record.
The contact data ports are related by port number. For example, Contact Function 1 identifies the function of
the person named in the Contact Complete 1 port.
Contact Function Usage
Select a Contact Function input port when an input address contains the job title of a contact.
Select a Contact Function output port to write the contact job title as output.
Consider the following guidelines when you use Contact Function ports:
•
There are three Contact Function ports. If an address record contains function data for more than one
contact, select additional Contact Function ports.
•
You can select a Contact Complete input port with the corresponding Contact Function port. A Contact
Complete port does not contain function or gender data.
•
You can select all contact data ports as outputs.
Contact Function Ports
69
Port Locations
The following table provides the location and default precision of the Contact Function 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact Function 2 and Contact
Function 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Function Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Gender Ports
Input and output ports that contain the gender of any contact in the address record.
The contact data ports are related by port number. For example, Contact Gender 1 identifies the gender of
the person named in the Contact Complete 1 port.
Contact Gender Usage
Select a Contact Gender input port when an input address identifies the gender of a contact.
70
Chapter 4: Business and Organization Data Ports
Select a Contact Gender output port to write the gender of the contact in a single port.
Consider the following guidelines when you use Contact Gender ports:
•
There are three Contact Gender ports. If an address record contains gender data for more than one
contact, select additional Contact Gender ports.
•
You can select a Contact Complete input port with the corresponding Contact Gender input port. A
Contact Complete port does not contain function or gender data.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Gender 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact Gender 2 and Contact Gender 3
ports:
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Gender Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Gender Ports
71
Contact Last Name Ports
Input and output ports that contain the surname of any contact in the address record.
Use a Contact Last Name port with a Contact First Name port. Optionally, use a Contact Middle Name port.
The contact data ports are related by number. Contact Name 1 contains the data in the Contact First Name 1,
Contact Last Name 1, and Contact Middle Name 1 ports.
Note: The Contact Complete port also contains contact last name data.
Contact Last Name Usage
Select a Contact Last Name input port when an input address contains the surname of a contact.
Select a Contact Last Name output port to write the surname of a contact in a single port.
Consider the following guidelines when you use Contact Last Name ports:
•
There are three Contact Last Name ports. If an address record contains more than one name, select
additional Contact Last Name ports.
•
For each contact in an address, select the Contact Name input port or select one or more of the Contact
First Name, Contact Last Name, and Contact Middle Name input ports. If you select a Contact Last Name
port, do not select the corresponding Contact Complete port.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Last Name 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact Last Name 2 and Contact Last
Name 3 port:s
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Last Name Example
The following table shows the Address Validator transformation ports that contain contact data:
72
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Chapter 4: Business and Organization Data Ports
Port Name
Data
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Middle Name Ports
Input and output ports that contain the middle name of any contact in the address record.
Use a Contact Middle Name port with Contact First Name and Contact Last Name ports.
The contact data ports are related by port number. For example, Contact Name 1 contains all data in the
Contact First Name 1, Contact Last Name 1, and Contact Middle Name 1 ports.
Note: The Contact Complete port also contains contact middle name data.
Contact Middle Name Usage
Select a Contact Middle Name input port when an input address contains the middle name or middle initial of
a contact.
Select a Contact Middle Name output port to write the middle name or middle initial of a contact in a single
port.
Consider the following guidelines when you use Contact Middle Name ports:
•
There are three Contact Middle Name ports. If an address record contains more than one name, select
additional Contact Middle Name ports.
•
For each contact in an address, select the Contact Name input port or select one or more of the Contact
First Name, Contact Last Name, and Contact Middle Name input ports. If you select a Contact Middle
Name port, do not select the corresponding Contact Complete port.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Middle Name 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
Contact Middle Name Ports
73
The following table provides the location and default precision of the Contact Middle Name 2 and Contact
Middle Name 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Middle Name Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Name Ports
Input and output ports that contain the full name of any contact in the address record.
The Contact Name ports contain all data in the following ports:
•
Contact First Name
•
Contact Middle Name
•
Contact Last Name
Note: The Contact Complete port also contains contact name data.
The contact data ports are related by port number. For example, Contact Name 1 contains all data in the
Contact First Name 1, Contact Last Name 1, and Contact Middle Name 1 ports.
Contact Name Usage
Select a Contact Name input port when an input address contains the full name of a contact in a single port.
Select a Contact Name output port to write the full name of a contact in a single port.
74
Chapter 4: Business and Organization Data Ports
Consider the following guidelines when you use Contact Name ports:
•
There are three Contact Name ports. If an address record contains more than one contact name, select
additional Contact Name ports.
•
For each contact name in an address, select the Contact Name input port or select one or more of the
Contact First Name, Contact Last Name, and Contact Middle Name ports. If you select a Contact Name
port, do not select the corresponding Contact Complete port.
•
You can select all contact data output ports.
Port Locations
The following table provides the location and default precision of the ports Contact Name 1 through Contact
Name 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
Contact Name Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Contact Salutation Ports
Input and output ports that contain contact salutation data.
The contact salutation is a formal introduction to a contact name. Each name in an address may have a
contact salutation, such as Mister or Mrs.
The contact data ports are related by port number. For example, the data on the Contact Salutation 1 port
relates to the person identified in the Contact Name 1 port.
Contact Salutation Ports
75
The data in the Contact Salutation port is a subset of the data in the corresponding Contact Complete port.
Contact Salutation Usage
Select a Contact Salutation input port when an input address contains salutation data in a single port.
Select a Contact Salutation output port to write salutation data in a single port.
Consider the following guidelines when you use Contact Salutation ports:
•
There are three Contact Salutation ports. If an address record contains more than one salutation, select
additional Contact Salutation ports.
•
If you select a Contact Salutation port, do not select the corresponding Contact Complete port.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Salutation 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact Salutation 2 and Contact
Salutation 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Salutation Example
The following table shows the Address Validator transformation ports that contain contact data:
76
Port Name
Data
Contact Complete 1
Mr. John Edward Smith
Contact Title 1
[Blank]
Contact Salutation 1
Mr.
Contact First Name 1
John
Contact Middle Name 1
Edward
Contact Last Name 1
Smith
Contact Name 1
John Edward Smith
Contact Gender 1
M
Contact Function 1
Software Technician
Chapter 4: Business and Organization Data Ports
Contact Title Ports
Input and output ports that contain contact title data.
The contact title is a professional title or qualification, such as Doctor or Professor.
The contact data ports are related by port number. For example, the data on the Contact Title 1 port relates
to the person identified in the Contact Name 1 port.
The data in the Contact Title port is a subset of the data in the corresponding Contact Complete port.
Contact Title Usage
Select a Contact Title input port when an input address contains a title in a single port.
Select a Contact Salutation output port to write title data in a single port.
Consider the following guidelines when you use Contact Title ports:
•
There are three Contact Title ports. If an address record contains more than one title, select additional
Contact Title ports.
•
If you select a Contact Title port, do not select the corresponding Contact Complete port.
•
You can select all contact data ports as outputs.
Port Locations
The following table provides the location and default precision of the Contact Title 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
The following table provides the location and default precision of the Contact Title 2 and Contact Title 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Contact Elements
Advanced
50
Contact Title Example
The following table shows the Address Validator transformation ports that contain contact data:
Port Name
Data
Contact Complete 1
Dr. Evelyn Michelle Jones
Contact Title 1
Dr.
Contact Salutation 1
[Blankl]
Contact First Name 1
Evelyn
Contact Middle Name 1
Michelle
Contact Title Ports
77
Port Name
Data
Contact Last Name 1
Jones
Contact Name 1
Evelyn Michelle Jones
Contact Gender 1
F
Contact Function 1
Chief Information Officer
Organization Complete Ports
Input and output ports that contain all information that identifies a company or other organization in an
address.
The organization data ports are related by port number. For example, the Organization Complete 1 port
contains all data in the Organization Name 1 and Organization Descriptor 1 ports.
Note: An Organization Complete port data does not include Organization Department data.
Organization Complete Usage
Select an Organization Complete input port when an input address contains all data that identifies an
organization in a single port.
Select an Organization Complete output port to write all organization data to a single port.
Consider the following guidelines when you use Organization Complete ports:
•
There are three Organization Complete ports. If an address contains data on more than one organization,
review the input data structure and verify that you need to select all organization data for address
validation. An address can only deliver to one organization. You may need to select additional
organization ports if the data is highly complex.
•
For each organization in an address, select an Organization Complete input port or select one or more of
the Organization Name or Organization Descriptor ports. You can select Organization Complete and
Organization Department ports for the same organization.
•
You can select all organization data output ports.
Port Locations
The following table provides the location and default precision of the Organization Complete 1 port:
78
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
128
Input
Hybrid
Basic
128
Output
Address Elements
Basic
128
Chapter 4: Business and Organization Data Ports
The following table provides the location and default precision of the Organization Complete 2 and
Organization Complete 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Advanced
128
Organization Complete Example
The following example address contains data that can populate the Organization Complete port:
DEF INC
RND GROUP
MR. JOHN DOE
38A ST. JAMES'S STREET
LONDON
E17 7PE
UNITED KINGDOM
The following table shows the Address Validator transformation ports that relate to organization data in the
address:
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Organization Complete 1
DEF INC.
Organization Name 1
DEF
Organization Descriptor 1
INC.
Organization Department 1
RND GROUP
Street Complete 1
ST. JAMES'S STREET
Street Number Complete 1
38A
Postcode 1
E17 7PE
Locality Complete 1
LONDON
Country ISO3 Char
GBR
Organization Department Ports
Input and output ports that identify a department in the address data.
The destination may be a department or a contact in the department.
Organization Department Ports
79
The organization data ports are related by port number. For example, the Organization Complete 1 port
contains all data in the Organization Name 1 and Organization Descriptor 1 ports.
Note: Organization Complete port data does not include Organization Department data.
Organization Department Usage
Select an Organization Department input port when an input address contains data that identifies an
organization department in a single port.
Select an Organization Department output port to write the department name to a single port.
Consider the following guidelines when you use Organization Department ports:
•
There are three Organization Department ports. If an address contains data on more than one
organization, review the input data structure and verify that you need to select all organization data for
address validation. An address can only deliver to one organization. You may need to select additional
organization ports if the data is highly complex.
•
For each organization in an address, select an Organization Complete input port or select one or more of
the Organization Name or Organization Descriptor ports. You can select Organization Complete and
Organization Department ports for the same organization.
•
You can select all organization data output ports.
Port Locations
The following table provides the location and default precision of the Organization Department 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Basic
50
The following table provides the location and default precision of the Organization Department 2 and
Organization Department 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Advanced
50
Organization Department Example
The following example address contains data that can populate the Organization Department port:
DEF INC
RND GROUP
MR. JOHN DOE
38A ST. JAMES'S STREET
LONDON
E17 7PE
UNITED KINGDOM
80
Chapter 4: Business and Organization Data Ports
The following table shows the Address Validator transformation ports that relate to organization data in the
address:
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Organization Complete 1
DEF INC.
Organization Name 1
DEF
Organization Descriptor 1
INC.
Organization Department 1
RND GROUP
Street Complete 1
ST. JAMES'S STREET
Street Number Complete 1
38A
Postcode 1
E17 7PE
Locality Complete 1
LONDON
Country ISO3 Char
GBR
Organization Descriptor Ports
Input and output ports that contain information that describes the type of organization identified in the
address data.
Organization descriptor data can tell you about the type of organization that receives the mail and where the
organization is located. For example, the descriptor "plc" identifies a public limited company based in the
United Kingdom.
The organization data ports are related by port number. For example, the Organization Complete 1 port
contains all data in the Organization Name 1 and Organization Descriptor 1 ports.
Note: Organization Complete port data does not include Organization Department data.
Organization Descriptor Usage
Select an Organization Descriptor input port when an input address contains the descriptive term for an
organization in a single port.
Select an Organization Descriptor output port to write the organization descriptor to a single port.
Consider the following guidelines when you use Organization Descriptor ports:
•
There are three Organization Descriptor ports. If an address contains data on more than one organization,
review the input data structure and verify that you need to select all organization data for address
validation. An address can only deliver to one organization. You may need to select additional
organization ports if the data is highly complex.
Organization Descriptor Ports
81
•
For eachorganization in an address, select an Organization Complete input port or select one or more of
the Organization Name or Organization Descriptor ports. You can select Organization Complete and
Organization Department ports for the same organization.
•
You can select all organization data output ports.
Port Locations
The following table provides the location and default precision of the Organization Descriptor 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Basic
50
The following table provides the location and default precision of the Organization Descriptor 2 and
Organization Descriptor 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Advanced
50
Organization Descriptor Example
The following example address contains data that can populate the Organization Descriptor port:
DEF INC
RND GROUP
MR. JOHN DOE
38A ST. JAMES'S STREET
LONDON
E17 7PE
UNITED KINGDOM
The following table shows the Address Validator transformation ports that relate to organization data in the
address:
82
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Organization Complete 1
DEF INC.
Organization Name 1
DEF
Organization Descriptor 1
INC.
Organization Department 1
RND GROUP
Street Complete 1
ST. JAMES'S STREET
Chapter 4: Business and Organization Data Ports
Port Name
Data
Street Number Complete 1
38A
Postcode 1
E17 7PE
Locality Complete 1
LONDON
Country ISO3 Char
GBR
Organization Name Ports
Input and output ports that contain organization name information in the address data.
The Address Validation transformation treats the organization name and descriptor as different ports. For
example, in the organization "Barker Shedwell plc," "Barker Shedwell" is the organization name and "plc" is
the organization descriptor.
The organization data ports are related by port number. For example, the Organization Complete 1 port
contains all data in the Organization Name 1 and Organization Descriptor 1 ports.
Note: Organization Complete port data does not include Organization Department data.
Organization Name Usage
Select an Organization Name input port when an input address contains the name of an organization in a
single port.
Select an Organization Name output port to write the organization name to a single port.
Consider the following guidelines when you use Organization Name ports:
•
There are three Organization Name ports. If an address contains data on more than one organization,
review the input data structure and verify that you need to select all organization data for address
validation. An address can only deliver to one organization. You may need to select additional
organization ports if the data is highly complex.
•
For each organization in an address, select an Organization Complete input port or select one or more of
the Organization Name or Organization Descriptor ports. You can select Organization Complete and
Organization Department ports for the same organization.
•
You can select all organization data output ports.
Port Locations
The following table provides the location and default precision of the Organization Name 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Basic
50
Organization Name Ports
83
The following table provides the location and default precision of the Organization Name 2 and Organization
Name 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Address Elements
Advanced
50
Organization Name Example
The following example address contains data that can populate the Organization Name port:
DEF INC
RND GROUP
MR. JOHN DOE
38A ST. JAMES'S STREET
LONDON
E17 7PE
UNITED KINGDOM
The following table shows the Address Validator transformation ports that relate to organization data in the
address:
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Organization Complete 1
DEF INC.
Organization Name 1
DEF
Organization Descriptor 1
INC.
Organization Department 1
RND GROUP
Street Complete 1
ST. JAMES'S STREET
Street Number Complete 1
38A
Postcode 1
E17 7PE
Locality Complete 1
LONDON
Country ISO3 Char
GBR
Postal Phrase Additional Info Ports
Input and output ports that contain additional information about a postal agency mailbox in an address.
Postal Phrase Additional Info ports can contain background information about the owner of the Post Office
Box (PO Box). For example, additional information can identify if the PO Box relates to a television station or
newspaper promotion. Address validation does not parse or validate this information.
84
Chapter 4: Business and Organization Data Ports
The postal phrase ports are related by number. For example, Postal Phrase Additional Info 1 provides
information about the data in the Postal Phrase Number 1 port. You can select a Postal Phrase Additional
Info port and other postal phrase ports concurrently.
Postal Phrase Additional Info Usage
Select a Postal Phrase Additional Info input port if the input address contains additional information about the
PO Box in a single port.
Select a Postal Phrase Additional Info output port to write additional information about the PO Box to a single
port.
Consider the following guidelines when you use Postal Phrase Additional Info ports:
•
There are three Postal Phrase Additional Info ports. If an address record contains information about more
than one PO Box, select additional Postal Phrase Additional Info ports.
•
For each PO Box in an address, you can select a Postal Phrase Additional Info port in addition to other
postal phrase ports. You cannot select a Postal Phrase Complete input port and also select a Postal
Phrase Descriptor or Postal Phrase Number input port.
•
You can select all postal phrase data output ports.
Port Locations
The following table provides the location and default precision of the Postal Phrase Additional Info 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
30
The following table provides the location and default precision of the Postal Phrase Additional Info 2 and
Postal Phrase Additional Info 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
30
Postal Phrase Additional Info Example
The following table shows the Address Validator transformation ports that relate to postal phrase data in the
address:
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Postal Phrase Additional Info Ports
85
Port
Data
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Complete 1
Montrose
Province Country Standard 1
CO
Postcode 1
81402-2038
Postal Phrase Complete Ports
Input and output ports that contain all address data that describes a postal agency mailbox.
Post Office Box (PO Box) data is the most common type of postal phrase data.
The postal phrase ports are related by number. For example, Postal Phrase Complete 1 contains the data in
Postal Phrase Descriptor 1 and Postal Phrase Number 1.
The data in a Postal Phrase Complete port does not include the data in a corresponding Postal Phrase
Additional Info port.
Postal Phrase Complete Usage
Select a Postal Phrase Complete input port if the input address contains PO Box data in a single port.
Select a Postal Phrase Complete output port to write PO Box data to a single port.
Consider the following guidelines when you use Postal Phrase Complete ports:
•
There are three Postal Phrase Complete ports. If an address record contains more than one PO Box,
select additional Postal Phrase Complete ports.
•
Most countries use Postal Phrase Complete 1. You may need to select Postal Phrase Complete 2 or
Postal Phrase Complete 3 if the postal phrase data is highly complex.
•
For each PO Box in an address, select a Postal Phrase Complete input port or select one or more of the
Postal Phrase Descriptor or Postal Phrase Number input ports.
•
You can select all postal phrase data output ports.
Port Locations
The following table provides the location and default precision of the Postal Phrase Complete 1 and Postal
Phrase Complete 2 ports:
86
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Output
Address Elements
Basic
50
Chapter 4: Business and Organization Data Ports
The following table provides the location and default precision of the Postal Phrase Complete 3 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
50
Postal Phrase Complete Example
The following table shows the Address Validator transformation ports that relate to postal phrase data in the
address:
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Complete 1
Montrose
Province Country Standard 1
CO
Postcode 1
81402-2038
Postal Phrase Descriptor Ports
Input and output ports that describe a type of mailbox at a postal agency.
The postal phrase descriptor precedes the postal phrase number. Post Office Box (PO Box) number data is
the most common type of postal phrase data. For example, the postal phrase in "PO Box 12345" is "PO Box."
The data in a Postal Phrase Descriptor port is a subset of the data in the corresponding Postal Phrase
Complete port.
The postal phrase ports are related by number. For example, Postal Phrase Complete 1 contains the data in
Postal Phrase Descriptor 1 and Postal Phrase Number 1.
The data in a Postal Phrase Complete port does not include the data in a corresponding Postal Phrase
Additional Info port.
Postal Phrase Descriptor Usage
Select a Postal Phrase Descriptor input port if the input address contains "PO Box" and the postal phrase
number in separate ports.
Postal Phrase Descriptor Ports
87
Select a Postal Phrase Descriptor output port to write the "PO Box" string to a separate port in the output
data.
Consider the following guidelines when you use Postal Phrase Descriptor ports:
•
There are three Postal Phrase Descriptor ports. If an address record contains more than one PO Box,
select additional Postal Phrase Descriptor ports.
•
Most countries use Postal Phrase Descriptor 1. You may need to select Postal Phrase Descriptor 2 or
Postal Phrase Descriptor 3 if the postal phrase data is highly complex.
•
For each PO Box in an address, select a Postal Phrase Complete input port or select one or more of the
Postal Phrase Descriptor or Postal Phrase Number input ports.
•
You can select all postal phrase data output ports.
Port Locations
The following table provides the location and default precision of the Postal Phrase Descriptor 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
30
The following table provides the location and default precision of the Postal Phrase Descriptor 2 and Postal
Phrase Descriptor 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
30
Postal Phrase Descriptor Example
The following table shows the Address Validator transformation ports that relate to postal phrase data in the
address:
88
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Complete 1
Montrose
Chapter 4: Business and Organization Data Ports
Port
Data
Province Country Standard 1
CO
Postcode 1
81402-2038
Postal Phrase Number Ports
Input and output ports that contain a mailbox number at a postal agency.
Post Office Box (PO Box) data is the most common type of postal phrase data.
The Address Validator transformation has four ports named Postal Phrase Number. The following table
describes when to use each port:
Port Name
When To Use
Postal Phrase Number
Use with Australian address records that you submit for
Address Matching Approval System (AMAS)
certification.
Postal Phrase Number 1
Use with addresses from any country.
Postal Phrase Number 2
Postal Phrase Number 3
The postal phrase ports are related by number. For example, the Postal Phrase Complete 1 port contains the
data in Postal Phrase Descriptor 1 and Postal Phrase Number 1. The Postal Phrase Number and Postal
Phrase Number 1 ports validate the same data, and you can use both output ports in the same
transformation.
Postal Phrase Number Ports and Australian Address Data
The Address Validator transformation writes five digits to the Postal Phrase Number output port. For
example, the Postal Phrase Number port writes the PO Box number "2" as "00002." The five-digit format is
mandated by Australia Post for AMAS certification.
You can select Postal Phrase Number and Postal Phrase Number 1 output ports for an address. The Postal
Phrase Number port writes the data in the five-digit format. Postal Phrase Number writes numerical data as
output. If an Australian PO Box value contains alphabetical data, select the Postal Phrase Prefix or Postal
Phrase Suffix ports with Postal Phrase Number.
To view postal phrase number data for an Australian address, configure the Address Validator transformation
to run in certified mode.
Postal Phrase Number Usage
Select a Postal Phrase Number input port if the input address contains the PO Box number in a single port.
Select the Postal Phrase Number output port to write the PO Box number to a single port in the format
required for AMAS certification. The Postal Phrase Number output port contains number data only. If the
Australian PO Box data includes alphabet characters, use the Postal Phrase Prefix or Postal Phrase Suffix
ports in addition to the Postal Phrase Number port.
Select a Postal Phrase Number 1, 2, or 3 output port to write the PO Box number to a single port.
Postal Phrase Number Ports
89
Consider the following guidelines when you use Postal Phrase Number ports:
•
There are four Postal Phrase Number ports. Use Postal Phrase Number for Australian addresses that you
will submit for AMAS certification. Use the other ports for other address validation projects.
•
You can use Postal Phrase Number 1, Postal Phrase Number 2, or Postal Phrase Number 3 with
Australian address data. However, the output from these port cannot be AMAS certified.
•
Most countries use Postal Phrase Number 1. You may need to select Postal Phrase Number 2 or Postal
Phrase Number 3 if the postal phrase data is highly complex.
•
For each PO Box in an address, select a Postal Phrase Complete input port or select one or more of the
Postal Phrase Descriptor or Postal Phrase Number input ports.
•
You can select all postal phrase data output ports.
Port Locations
The following table provides the location and default precision of the Postal Phrase Number port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
12
The following table provides the location and default precision of the Postal Phrase Number 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
12
The following table provides the location and default precision of the Postal Phrase Number 2 and Postal
Phrase Number 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
12
Postal Phrase Number Example
The following table shows the Address Validator transformation ports that relate to postal phrase data in an
address:
90
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Chapter 4: Business and Organization Data Ports
Port
Data
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Complete 1
Montrose
Province Country Standard 1
CO
Postcode 1
81402-2038
Postal Phrase Number Ports
91
CHAPTER 5
City and Locality Data Ports
This chapter includes the following topics:
•
Locality Additional Info Ports, 92
•
Locality Complete Ports, 93
•
Locality Identifier DE, 94
•
Locality Name Ports, 95
•
Locality Sort Code Ports, 97
•
Preferred Name Ports, 98
Locality Additional Info Ports
Input and output ports that contain information that can assist delivery to the address.
Locality ports are related by number. For example, Locality Additional Info 1 provides information about the
data in the Locality Name 1 port. You can select a Locality Additional Info port and other Locality ports
concurrently.
Locality Additional Info Usage
Select Locality Additional Info when the input data set contains information that can assist in delivering mail
to an address.
Address validation does not parse or validate data for this port. If you select a Locality Additional Info input
port, connect the data to a Locality Additional Info output port. Address validation will not try to validate this
data.
Port Locations
The following table provides the location and default precision of ports Locality Additional Info 1 through
Locality Additional Info 6:
92
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
30
Locality Additional Info Example
The following information relates to an address in Rockingham County, Virginia, United States:
"Exit Interstate 81 at milepost 262 northbound"
Locality Complete Ports
Input and output ports that contain all locality information in the address data.
The locality ports are related by number. For example, Locality Complete 1 contains all data in the Locality
Name 1 and Locality Sort Code 1 ports.
Locality Complete Usage
Select a Locality Complete input port if the address contains all data related to a locality in a single port.
Select a Locality Complete output port to write all data for a locality to a single port.
Consider the following guidelines when you use Locality Complete ports:
•
If an address contains multiple locality levels, use multiple locality ports. For example, use Locality
Complete 1 or Locality Name 1 for the primary or largest locality in the address. Use Locality Complete 2
or Locality Name 2 to identify a town within Locality Complete 1 or Locality Name 1.
•
There are six Locality Complete ports. Most countries use Locality Complete 1 or Locality Complete 2.
You may need to select additional locality ports if the locality data is highly complex.
•
Select a Locality Complete 1 input port or select one or more of the Locality Name 1 or Locality Sort Code
1 input ports. If you select a port in the range Locality Complete 2 through Locality Complete 6, do not
select the corresponding Locality Sort Code port. The Locality Sort Code 2 through Locality Sort Code 6
ports are reserved for future use.
•
You can select all locality data output ports, except ports Locality Sort Code 2 through Locality Sort Code
6.
Port Locations
The following table provides the location and default precision of ports Locality Complete 1 through Locality
Complete 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
100
Input
Hybrid
Basic
100
Output
Last Line Elements
Basic
100
Locality Complete Ports
93
The following table provides the location and default precision of ports Locality Complete 4 through Locality
Complete 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
100
Input
Hybrid
Advanced
100
Output
Last Line Elements
Advanced
100
Locality Complete Example
The following table shows the Address Validator transformation port that contains Locality Complete data in
this address:
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Complete 1
Montrose
Province Country Standard 1
CO
Postcode 1
81402-2038
Locality Identifier DE
Input and output ports that contain the identification number that Deutsche Post assigns to a locality.
Deutsche Post uses the number to identify the post town for the address.
Locality Identifier DE Usage
To read the locality identification number from a German address, select the Locality Identifier DE input port.
To write the locality identification number to a German address, select the Locality Identifier DE output port.
94
Chapter 5: City and Locality Data Ports
Port Location
The following table provides the location and default precision of the Locality Identifier DE port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
8
Output
DE Supplementary
Basic
8
Locality Identifier DE Output Codes
The Locality ID is a code of variable length that uniquely identifies a German postal locality. For example, the
locality identifier key for the town of Maxdorf is 07338018.
Locality Name Ports
Input and output ports that contain locality data.
Locality Name 1 identifies the primary locality in the address. A county is the primary locality within a state of
the United States.
The locality ports are related by number. For example, Locality Complete 1 contains the information in the
Locality Name 1 and Locality Sort Code 1 ports.
Locality Name Usage
Select a Locality Name input port to read the primary locality from the input address.
Select a Locality Name output port to write the primary locality to the validated address.
Consider the following guidelines when you use Locality Name ports:
•
If an address contains multiple locality levels, use multiple locality ports. For example, use Locality
Complete 1 or Locality Name 1 for the primary or largest locality in the address. Use Locality Complete 2
or Locality Name 2 to identify a town within Locality Complete 1 or Locality Name 1.
•
There are six Locality Name ports. Most countries use Locality Name 1 or Locality Name 2. You may need
to select additional locality ports if the locality data is highly complex.
•
Select a Locality Complete 1 input port or select one or more of the Locality Name 1 or Locality Sort Code
1 input ports.
•
You can select all locality data output ports, except ports Locality Sort Code 2 through Locality Sort Code
6. The Locality Sort Code 2 through Locality Sort Code 6 ports are reserved for future use.
Locality Name Ports
95
Port Locations
The following table provides the location and default precision of ports Locality Name 1 through Locality
Name 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
100
Input
Hybrid
Advanced
100
Output
Last Line Elements
Basic
100
The following table provides the location and default precision of ports Locality Name 4 through Locality
Name 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
100
Input
Hybrid
Advanced
100
Output
Last Line Elements
Advanced
100
Locality Name Example
The following table shows the Address Validator transformation port that contains Locality Name data in this
address:
96
Port
Data
Contact Complete 1
Mr. John Doe
Organization Complete 1
DEF Inc.
Postal Phrase Complete 1
PO Box 2038
Postal Phrase Descriptor 1
PO Box
Postal Phrase Number 1
2038
Postal Phrase Additional Info 1
"Sales Promotion"
Locality Name 1
Montrose
Province Country Standard 1
CO
Postcode 1
81402-2038
Chapter 5: City and Locality Data Ports
Locality Sort Code Ports
Input and output ports that identify the mail facility that handles mail for the address. In a country that does
not use post codes for all addresses, the Locality Sort Code port can also identify the post code that applies
to the address.
Sort codes speed up the mail distribution process. A mail carrier can use sort codes to assign mail items to a
facility when a locality contains multiple mail facilities. If you add sort code information to an address, you can
qualify for postal discounts. For example, the Royal Mail Walksort system offers discounts on the cost of
delivery for large quantities of presorted mail.
If a country uses post codes for some addresses but not others, address validation writes the post code to
the Locality Sort Code port. For example, Ireland defines post codes for the cities of Dublin and Cork but not
for other Irish addresses.
Locality Sort Code Usage
Select a Locality Sort Code input port to read the sort code for the mail facility that organizes items for
delivery to the address.
Select a Locality Sort Code output port to write the sort code for the mail facility to the output address.
When a country does not define post codes for all addresses, use Locality Sort Code to read or write the post
code for the address.
Consider the following guidelines when you use Locality Sort Code ports:
•
There are six Locality Sort Code ports. Locality Sort Code 1 port can identify a sorting facility in the area
identified in Locality Name 1. Do not use Locality Sort Code ports with other locality levels.
•
The ports Locality Sort Code 2 through Locality Sort Code 6 are reserved for future use.
•
The Locality Complete 1 input port contains the data that address validation reads on the Locality Name 1
and Locality Sort Code 1 input ports.
•
The Locality Complete 1 output port contains the data that address validation writes to the Locality Name
1 and Locality Sort Code 1 output ports.
Port Locations
The following table provides the location and default precision of the Locality Sort Code 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Basic
10
Locality Sort Code Ports
97
The following table provides the location and default precision of ports Locality Sort Code 2 through Locality
Sort Code 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
10
Locality Sort Code Examples
France uses sort codes to identify mail sorting facilities. The following table shows sort code data for an
address in Paris:
Postcode 1
Locality Name 1
Locality Sort Code
75291
Paris
CEDEX 06
CEDEX stands for Courrier d'Entreprise à Distribution Exceptionnelle. CEDEX indicates that the address
receives mail in large quantities and has a dedicated post code. The CEDEX number identifies the facility
that sorts mail items for the address, as the locality has more than one mail facility.
Note: You can validate CEDEX and CEDEXA data in a French address. A CEDEXA code identifies a mailbox
that receives a large volume of mail.
Preferred Name Ports
Output port that returns the official or formally correct name of a locality in Canada or in the United States.
In almost all addresses, the Preferred Name port returns the same name as the Locality Name port. In a
small number of cases, the formal or official locality name is not used by the general public. For example,
"North York" is a locality within the area covered by the city of Toronto. If the Address Validator
transformation finds an address in the North York locality, it writes "Toronto" to the Locality Name port and
writes "North York" to the Preferred Name port.
Preferred Name Usage
Select Preferred Name to write the formally correct version of a locality name to the address record. Use the
port to find the locality name when the address uses an alternative name for the locality.
Consider the following guidelines when you use Preferred Name ports:
98
•
If an address contains multiple locality levels, use multiple locality ports. For example, use Preferred
Name 1 for the primary or largest locality in the address. Use Preferred Name 2 to identify a town within
the locality that Preferred Name 1 identifies.
•
There are six Preferred Name ports. Most countries use Preferred Name 1 or Preferred Name 2. You may
need to select additional locality ports if the locality data is highly complex.
•
You can use Preferred Name ports with any other locality data output port.
Chapter 5: City and Locality Data Ports
Port Location
The following table provides the location and default precision of ports Preferred Name 1 through Preferred
Name 3:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Basic
100
The following table provides the location and default precision of ports Preferred Name 4 through Preferred
Name 6:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Advanced
100
Preferred Name Output Codes
The following example address contains data that the Address Validator transformation can parse to the
Preferred Name port:
Ms. Susan Smith
DEF Inc.
1850 Wilson Ave.
Toronto ON M9M 1A1
CAN
The following table shows the Address Validator transformation port that contains the Preferred Name data in
this address:
Port
Data
Contact Complete 1
MS. SUSAN SMITH
Organization Complete 1
DEF INC.
Street Number Complete 1
1850
Street Complete 1
WILSON AVE
Locality Name 1
TORONTO
Preferred Name 1
NORTH YORK
Province Abbreviation 1
ON
Postcode Complete 1
M9M 1A1
Country ISO3 Char
CAN
Preferred Name Ports
99
CHAPTER 6
Country Data Ports
This chapter includes the following topics:
•
Country Abbreviation Ports, 100
•
Country ISO2 Char Ports, 101
•
Country ISO3 Char Ports, 102
•
Country ISO3 Digit Ports, 104
•
Country Name , 106
•
Country Name Abbreviation Ports, 107
•
Language ISO3, 108
Country Abbreviation Ports
Input port that contains a country abbreviation value.
Address validation is not currently implemented for Country Abbreviation output ports. If you connect data to
a Country Abbreviation port, the Address Validator transformation parses the data to an appropriate output
port for the address and validates the data on output.
Country Abbreviation Usage
Use one of the following ports to validate country abbreviation data:
•
Country ISO2 Char
•
Country ISO3 Char
•
Country ISO3 Digit
Port Locations
The following table provides the location and default precision of ports Country Abbreviation 1 through
Country Abbreviation 3:
100
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Country ISO2 Char Ports
Input and output ports that identify the country in an address by its two-letter ISO Code.
The International Organization for Standardization (ISO) maintains the sets of country name abbreviations
that mail carriers use. The ISO 3166-1 alpha-2 standard provides a two-letter address code for every country.
Country ISO2 Char Usage
Select an Country ISO2 Char input port when an address contains an ISO 3166-1 alpha-2 code.
Select an Country ISO2 Char output port to write the ISO 3166-1 alpha-2 code for the address as output.
Consider the following guidelines when you use Country ISO2 Char ports:
•
There are three Country ISO2 Char ports. Select one Country ISO2 Char port for each address.
•
The Address Validator transformation contains Country ISO2 Char ports, Country ISO3 Char ports, and
Country ISO3 Digit ports. If the ports contain conflicting data, the Address Validator transformation
prioritizes the data in the Country ISO3 Char port.
•
The Address Validator transformation uses country code data to select the address reference data set to
apply to the address record. If country code data is absent, the Address Validator transformation selects
the default country reference data that is configured in the transformation.
Port Locations
The following table provides the location and default precision of the Country ISO2 Char ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Basic
2
The following table provides the location and default precision of the Country ISO2 Char 2 and Country ISO2
Char 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Advanced
2
Country ISO2 Char Example
The following example address contains data that can populate the Country ISO2 Char port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Country ISO2 Char Ports
101
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation port that relate to ISO data in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO2 Char
HK
Country ISO3 Char
HKG
You can view a list of ISO 3166-1 alpha-2 codes on the following site:
http://www.iso.org/iso/home/standards/country_codes.htm
Country ISO3 Char Ports
Input and output ports that identify the country in an address by its three-letter ISO Code.
The International Organization for Standardization (ISO) maintains the sets of country name abbreviations
that mail carriers use. The ISO 3166-1 alpha-3 standard provides a three-letter address code for every
country.
Country ISO3 Char Usage
Select an Country ISO3 Char input port when an address contains an ISO 3166-1 alpha-3 code.
Select an Country ISO3 Char output port to write the ISO 3166-1 alpha-3 code for the address as output.
Consider the following guidelines when you use Country ISO3 Char ports:
102
•
There are three Country ISO3 Char ports. Select one Country ISO3 Char port for each address.
•
The Address Validator transformation contains Country ISO2 Char ports, Country ISO3 Char ports, and
Country ISO3 Digit ports. If the ports contain conflicting data, the Address Validator transformation
prioritizes the data in the Country ISO3 Char port.
Chapter 6: Country Data Ports
•
The Address Validator transformation uses country code data, if it is present, to select the address
reference data set to apply to the address record. If country code data is absent, the Address Validator
transformation selects the default country reference data that is configured in the transformation.
Port Locations
The following table provides the location and default precision of the Country ISO3 Char ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Basic
3
The following table provides the location and default precision of the Country ISO3 Char 2 and Country ISO3
Char 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Advanced
3
Country ISO3 Char Example
The following example address contains data that can populate the Country ISO3 Char port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation port that relate to ISO data in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Country ISO3 Char Ports
103
Port Name
Data
Street Complete 1
North St.
Street Number Complete 1
No. 11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO2 Char
HK
Country ISO3 Char
HKG
You can view a list of ISO 3166-1 alpha-3 codes on the following site:
http://unstats.un.org/unsd/methods/m49/m49alpha.htm
Country ISO3 Digit Ports
Input and output ports that identify the country in an address by its three-digit ISO Code.
The International Organization for Standardization (ISO) maintains the sets of country name abbreviations
that mail carriers use. The ISO 3166-1 numeric standard provides a three-digit address code for every
country. The ISO 3166-1 numeric codes are identical to the three-digit country codes developed and
maintained by the United Nations Statistics Division.
Country ISO3 Digit Usage
Select an Country ISO3 Digit input port when an address contains an ISO 3166-1 numeric code.
Select an Country ISO3 Digit output port to write the ISO 3166-1 numeric code for the address as output.
Use Country ISO3 Digit ports to identify countries in data sets that may be read in multiple language locales.
Country ISO3 Digit port data is not affected by the writing system or code page used to store the data.
Consider the following guidelines when you use Country ISO3 Digit ports:
104
•
There are three Country ISO3 Char ports. Select one Country ISO3 Char port for each address.
•
The Address Validator transformation contains Country ISO2 Char ports, Country ISO3 Char ports, and
Country ISO3 Digit ports. If the ports contain conflicting data, the Address Validator transformation
prioritizes the data in the Country ISO3 Char port.
•
The Address Validator transformation uses country code data, if it is present, to select the address
reference data set to apply to the address record. If country code data is absent, the Address Validator
transformation selects the default country reference data that is configured in the transformation.
Chapter 6: Country Data Ports
Port Locations
The following table provides the location and default precision of the Country ISO3 Digit ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Basic
3
The following table provides the location and default precision of the Country ISO3 Digit 2 and Country ISO3
Digit 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Advanced
3
Country ISO3 Digit Example
The following example address contains data that can populate the Country ISO3 Digit port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation port that relate to ISO data in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Country ISO3 Digit Ports
105
Port Name
Data
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Country ISO3 Digit
344
You can view a list of ISO 3166-1 numeric codes on the following site:
http://unstats.un.org/unsd/methods/m49/m49alpha.htm
Country Name
Input and output ports that contain the country name identified in the address.
The Country Name ports contain the English language version of the name.
Country Name Usage
Select a Country Name input port when the input address contains the country name in a single port.
Select a Country Name output port to add the country name to the output address record.
Consider the following guidelines when you use Country Name ports:
•
There are four Country Name ports. However, an address can deliver to one country. If an input address
contains multiple country names, the address may contain province or territory data in a country field. For
example, Puerto Rico is a state-equivalent territory in the United States. Use a Province port to read or
write the name "Puerto Rico."
•
Mail carriers prefer ISO country abbreviation data to country name data. Use an ISO abbreviation output
port instead of a Country Name output port.
•
The Address Validator transformation writes all words in a country name to a single port.
•
If the address contains country name and country abbreviation data, the country abbreviation data takes
precedence. The Address Validator transformation gives priority to Country ISO3 Char port data.
Port Locations
The following table provides the location and default precision of the Country Name port:
106
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Input
Hybrid
Basic
50
Input
Multiline
Basic
50
Chapter 6: Country Data Ports
The following table provides the location and default precision of the Country Name 1 port:
Port Type
Port Group
Template Model
Precision
Output
Country
Basic
50
The following table provides the location and default precision of the Country Name 2 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Basic
50
The following table provides the location and default precision of the Country Name 3 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Advanced
50
Country Name Abbreviation Ports
Input and output ports that contain a country abbreviation value.
Address validation is not currently implemented for Country Name Abbreviation ports. If you connect data to
a Country Name Abbreviation port, the Address Validator transformation parses the data to an appropriate
output port for the address and validates the data on output.
Country Name Abbreviation Usage
Use one of the following ports to validate country abbreviation data:
•
Country ISO2 Char
•
Country ISO3 Char
•
Country ISO3 Digit
Country Name Abbreviation Ports
107
Port Locations
The following table provides the location and default precision of ports Country Name Abbreviation 1 through
Country Name Abbreviation 3:
Port Type
Port Group
Template Model
Precision
Input
Hybrid
Advanced
50
Input
Multiline
Advanced
50
Output
Country
Advanced
50
Language ISO3
Output port that identifies the language used in the address. The port writes the three-character language
code that the International Organization for Standardization (ISO) defines in the ISO 639-3 standard.
The Language ISO3 port identifies the language in which the database originally stored the address. If the
address is transliterated from another language, the port identifies the original language. For example, if the
address validation process reads a romanized Japanese address, the port returns JPN as the language code.
Language ISO3 Usage
To add the language code to an address record, select the Language ISO3 port.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
3
Language ISO3 Output Codes
You can view the list of ISO 639-3 codes on the following site:
http://www.sil.org/iso639-3/codes.asp
108
Chapter 6: Country Data Ports
CHAPTER 7
Customer Segmentation Data
Ports
This chapter includes the following topics:
•
CAMEO Status, 109
•
Category Code, 110
•
Category Description, 112
•
Group Code, 114
•
Group Description, 115
•
International Code, 116
•
International Description, 118
•
MVID, 120
CAMEO Status
Output port that indicates whether an address record contains the data required for customer segmentation
analysis.
CAMEO Status Usage
Select CAMEO Status to verify that an address record contains the required data. Customer segmentation
analysis requires address data that identifies an individual household or business contact. When you select
CAMEO Status, configure the Address Validator transformation to run in batch or interactive mode.
The CAMEO Status value indicates whether address validation can add customer segmentation data to an
address. It does not indicate the quality or deliverability of the address. However, if address validation cannot
provide customer segmentation data for an address, the address is likely to be inaccurate or incomplete. For
example, the Address Validator transformation does not write customer segmentation data if the address has
a Match Code value in the range I1 through I4.
109
Port Location
The following table provides the location and default precision of the CAMEO Status port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
4
CAMEO Status Output Codes
The following table describes the CAMEO Status output codes:
Code
Description
ECON
The CAMEO reference data is not installed. Address validation did not add
customer segmentation data to the address.
ECOI
The address is inaccurate or incomplete. For example, the address has a Match
Code value in the range I1 through I4. Address validation did not add customer
segmentation data to the address.
ECO0
The CAMEO reference data does not include the address. Address validation did
not add customer segmentation to the address.
ECO1
Address validation added customer segmentation data to the address.
Category Code
Output port that writes a code value that represents the social and economic status of a household.
The Category Code port uses reference data to return customer segmentation data for the address.
Customer segmentation is a form of demographic analysis that infers social and economic status information
about the residents at an address. For example, customer segmentation can estimate financial wealth, age,
and family size for the address residents. The Category Code value combines customer segmentation data
about several status indicators into a single value.
Category Code Usage
Select Category Code to write a code value that estimates the social and economic status of the residents at
an address.
Consider the following guidelines when you use the Category Code port:
110
•
Category definitions vary from country to country. If you perform customer segmentation analysis on
addresses from more than one country, add a country code output port to the address record.
•
Select the Category Description port with the Category Code port to return a text description of the
category code.
•
The category code represents several social and economic factors that may apply to residents at an
address. Select the Group Code or Group Description port to add higher-level demographic data to the
address record.
Chapter 7: Customer Segmentation Data Ports
Port Location
The following table provides the location and default precision of the Category Code port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
3
Category Code Output Codes
The Category Code port writes a two-character or three-character code that identifies the customer
segmentation category for the address. The port can return code values for multiple countries. The code
value range can be different for each country.
For example, the following table describes the output codes generated on the Category Code port for Belgian
addresses:
Code
Description
1A
Mature couples and families in wealthy suburban areas
1B
Wealthy households in pleasant outer suburbs
1C
Wealthy families in executive areas
1D
Wealthy families with school-age children
2A
Couples and families in affluent rural areas
2B
Couples in affluent family communities
2C
Older families in outer suburbs
3A
Older couples in rural and suburban districts
3B
Single people in densely populated city areas
3C
Mature couples and single people in urban areas
4A
Families and single people in outer suburbs
4B
Mixed-age families and couples in rural areas
4C
Older and retired couples in rural communities
5A
Young households in multi-cultural urban areas
5B
Less affluent families in rural dwellings
5C
Young couples and families in less affluent rural areas
6A
Young couples and families in retired areas
6B
Retired couples in suburban neighbourhoods
6C
Retired couples and single people in poorer communities
Category Code
111
Code
Description
7A
Couples and single people in poorer suburbs
7B
Families and single people in poorer communities
7C
Young single people and couples in poorer multi-cultural areas
7D
Young households in poorer communities
Category Description
Output port that writes a text description of the likely social and economic status of a household.
The Category Description port uses reference data to return customer segmentation data for the address.
Customer segmentation is a form of demographic analysis that infers social and economic status information
about the residents at an address. For example, customer segmentation can estimate financial wealth, age,
and family size for the address residents. The Category Description port describes the social and economic
indicators that customer segmentation infers about an address.
Category Description Usage
Select Category Description to write a description of the customer segmentation category to which the
address residents belong. The category represents the likely social and economic status of the residents.
Consider the following guidelines when you use the Category Description port:
•
Category definitions vary from country to country. If you perform customer segmentation analysis on
addresses from more than one country, add a country code output port to the address record.
•
You can select the Category Code port when you select Category Description. The Category Code port
writes a code value that represents the category.
•
The category description identifies several social and economic factors that may apply to residents at an
address. Select the Group Code or Group Description port to add higher-level demographic data to the
address record.
Port Location
The following table provides the location and default precision of the Category Description port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
200
Category Description Output Values
The Category Description port writes a text description of the customer segmentation category for the
address. The port can return descriptions for multiple countries.
112
Chapter 7: Customer Segmentation Data Ports
For example, the following table describes the output generated on the Category Description port for Swedish
addresses:
Code
Description
1A
Educated couples and families in exclusive areas
1B
Mature and retired home owners in rural dwellings
1C
Older and mature couples in executive family neighborhoods
1D
Affluent couples and families in rural and suburban areas
1E
Older and mature households in wealthy family neighborhoods
2A
Wealthy school-age families in retired communities
2B
Retired executives in affluent areas
2C
Older couples and single people in retired neighborhoods
3A
Couples in comfortable family neighborhoods
3B
Couples and families in rural and suburban areas
3C
Comfortable couples and families with school-age children
3D
Couples and families with pre-school and school-age children
4A
Retired couples and single people in older rural communities
4B
Comfortable couples and families in rural neighborhoods
4C
Comfortable older couples and single people in retired areas
5A
Couples and families in retired outer suburban areas
5B
Less affluent mature families and retired couples
5C
Young couples and single people in retired neighborhoods
6A
Educated couples and single people in less affluent neighborhoods
6B
Couples and families in less affluent outer suburbs
6C
Less affluent couples and single people in student areas
6D
Young and older couples and families in mixed areas
7A
Poorer couples and single people in student areas
7B
Poorer mature households in retired areas
7C
Students in young single person neighborhoods
Category Description
113
Group Code
Output port that writes a code value to indicate the demographic group to which a household is likely to
belong. The Group Code port identifies a demographic group within a country.
The Group Code port uses reference data to return customer segmentation data for an address. Customer
segmentation is a form of demographic analysis that infers social and economic status information about the
residents at an address. For example, customer segmentation can estimate financial wealth, age, and family
size for the address residents. The Group Code value summarizes the results of the customer segmentation
analysis for the address.
Group Code Usage
Select Group Code to write a code value that represents the demographic group identified for the address
residents.
Consider the following guidelines when you use the Group Code port:
•
Group codes vary from country to country. If you perform customer segmentation analysis on addresses
from more than one country, add a country code output port to the address record.
•
Select the Group Description port with the Group Code port to return a text description of the category
code.
•
The group code summarizes the results of the customer segmentation analysis for an address. Select the
Category Code port to add a numeric code to the address record that provides lower-level customer
segmentation data.
Port Location
The following table provides the location and default precision of the Group Code port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
2
Group Code Output Codes
The Group Code port writes a one-character or two-character code that identifies the demographic group that
the address belongs to. The port can return code values for multiple countries.
For example, the following table describes the output codes generated on the Group Code port for United
States addresses:
114
Code
Description
1
Affluent, single
2
Wealthy, nearing retirement
3
Affluent family
4
Well-off family
5
Comfortable, mixed family size
6
Less affluent, retired
Chapter 7: Customer Segmentation Data Ports
Code
Description
7
Less affluent, young
8
Poor families and single parents
9
Poorer, single
Group Description
Output port that writes a text description of the demographic group to which a household is likely to belong.
The Group Description port identifies a demographic group within a country.
The Group Description port uses reference data to return customer segmentation data for the address.
Customer segmentation is a form of demographic analysis that infers social and economic status information
about the residents at an address. For example, customer segmentation can estimate financial wealth, age,
and family size for the address residents. The Group Description port summarizes the customer
segmentation analysis. It writes a text description of the demographic group that the address is likely to
belongs to.
Group Description Usage
Select Group Description to write the demographic group identified for the address residents.
Consider the following guidelines when you use the Group Description port:
•
Group descriptions vary from country to country. If you perform customer segmentation analysis on
addresses from more than one country, add a country code output port to the address record.
•
You can select the Group Code port when you select Group Description. The Group Code port returns a
code value of one or two characters that identifies the demographic group.
•
The group description provides a high-level summary of the customer segmentation analysis for the
address. Select the Category Code or Category Description port to add lower-level customer
segmentation data to the address.
Port Location
The following table provides the location and default precision of the Group Description port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
200
Group Description Output Values
The Group Description port writes a text description of the demographic group that customer segmentation
analysis identifies for the address. The port can return descriptions for multiple countries.
Group Description
115
For example, the following table describes the output generated on the Group Description port for German
addresses:
Code
Description
1
Upper class
2
Upper middle class
3
Middle class
4
Middle class couples
5
Middle class single people
6
Middle class families
7
Lower middle class
8
Working class
9
Urban working class
International Code
Output port that writes a code value to indicate the global demographic group to which a household is likely
to belong.
The International Code port uses reference data to return customer segmentation data for the address.
Customer segmentation is a form of demographic analysis that infers social and economic status information
about the residents at an address. The International Code port provides high-level customer segmentation
analysis that identifies addresses with common demographic indicators in multiple countries. For example,
customer segmentation can estimate financial wealth, age, and family size for the address residents. The
International Code value summarizes the results of the customer segmentation analysis for the address.
International Code Usage
Select International Code to write the global demographic group identified for the address residents.
Consider the following guidelines when you use the International Code port:
116
•
The International Code port identifies addresses in different countries that share demographic status
indicators. To write customer segmentation codes for addresses in a single country, select the Group
Code or Category Code port.
•
Select the International Description port with the International Code port to return a text description of the
international code.
Chapter 7: Customer Segmentation Data Ports
Port Location
The following table provides the location and default precision of the International Description port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
2
International Description Output Codes
The International Description port writes a text description of the demographic group that customer
segmentation analysis identifies for the address.
The following table describes the output generated on the International Code port:
Code
Description
11
Wealthy pre-family couples and single people
12
Wealthy young couples with children
13
Wealthy families with school-age children
14
Wealthy older families and mature couples
15
Wealthy elders in retirement
21
Prosperous pre-family couples and single people
22
Prosperous young couples with children
23
Prosperous families with school-age children
24
Prosperous older families and mature couples
25
Prosperous elders in retirement
31
Comfortable pre-family couples and single people
32
Comfortable young couples with children
33
Comfortable families with school-age children
34
Comfortable older families and mature couples
35
Comfortable elders in retirement
41
Less affluent pre-family couples and single people
42
Less affluent young couples with children
43
Less affluent families with school-age children
44
Less affluent older families and mature couples
45
Less affluent elders in retirement
International Code
117
Code
Description
51
Poorer pre-family couples and single people
52
Poorer young couples with children
53
Poorer families with school-age children
54
Poorer older families and mature couples
55
Poorer elders in retirement
XX
Communal establishments
International Description
Output port that writes a text description of the global demographic group to which a household is likely to
belong.
The International Description port uses reference data to return customer segmentation data for the address.
Customer segmentation is a form of demographic analysis that infers social and economic status information
about the residents at an address. The International Description port provides high-level customer
segmentation analysis that identifies addresses with common demographic indicators in multiple countries.
For example, customer segmentation can estimate financial wealth, age, and family size for the address
residents. The International Description port writes a text description of the demographic group that the
address is likely to belongs to.
International Description Usage
Select International Description to write the global demographic group identified for the address residents.
Consider the following guidelines when you use the International Description port:
•
The International Description port identifies addresses in different countries that share demographic status
indicators. To write a summary of the customer segmentation analysis for addresses in a single country,
select the Group Description or Category Description port.
•
You can select the International Code port when you select International Description. The International
Code port returns a two-character code that identifies the demographic group.
Port Location
The following table provides the location and default precision of the International Description port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
200
International Description Output Values
The International Description port writes a text description of the demographic group that customer
segmentation analysis identifies for the address.
118
Chapter 7: Customer Segmentation Data Ports
The following table describes the output generated on the International Description port:
Code
Description
11
Wealthy pre-family couples and single people
12
Wealthy young couples with children
13
Wealthy families with school-age children
14
Wealthy older families and mature couples
15
Wealthy elders in retirement
21
Prosperous pre-family couples and single people
22
Prosperous young couples with children
23
Prosperous families with school-age children
24
Prosperous older families and mature couples
25
Prosperous elders in retirement
31
Comfortable pre-family couples and single people
32
Comfortable young couples with children
33
Comfortable families with school-age children
34
Comfortable older families and mature couples
35
Comfortable elders in retirement
41
Less affluent pre-family couples and single people
42
Less affluent young couples with children
43
Less affluent families with school-age children
44
Less affluent older families and mature couples
45
Less affluent elders in retirement
51
Poorer pre-family couples and single people
52
Poorer young couples with children
53
Poorer families with school-age children
54
Poorer older families and mature couples
55
Poorer elders in retirement
XX
Communal establishments
International Description
119
MVID
Output port that writes a code value to link CAMEO port outputs to customer segmentation analyses from
other applications.
When you use the Address Validator transformation to add customer segmentation data to address records,
you can use the records in other applications that read customer segmentation data.
MVID Usage
Select MVID when you want to use CAMEO port output with customer segmentation data from a nonInformatica application.
Port Location
The following table provides the location and default precision of the MVID port:
Port Type
Port Group
Template Model
Precision
Output
CAMEO
Basic
30
MVID Example
The following example address contains data that can populate the CAMEO ports:
MS. JANE SMITH
100 5TH AVE, #1
NEW YORK NY 10011
The following table shows the outputs on the MVID port and other ports that you can select for the address:
120
Port Name
Data
Formatted Address Line 1
MS. JANE SMITH
Formatted Address Line 2
100 5TH AVE, #1
Formatted Address Line 3
NEW YORK NY 10011
Category Code
1A
Category Description
Affluent young single people in exclusive rented
housing
Group Code
1
Group Description
Affluent, single
International Code
11
International Description
Wealthy pre-family couples and single people
MVID
360610054002
Chapter 7: Customer Segmentation Data Ports
CHAPTER 8
Enrichment Data Ports
This chapter includes the following topics:
•
Address Type, 121
•
Count, 123
•
Count Overflow, 123
•
Finance Number , 124
•
Geocoding Complete , 125
•
Latitude, 125
•
Latitude Longitude Unit , 126
•
Longitude, 126
•
Record ID Ports, 127
•
Time Zone Code, 128
•
Time Zone Name, 128
•
Transaction Key Ports, 129
Address Type
Output port that describes the type of mailbox that the address identifies.
Use the Address Type port to identify the mailbox type in an address from Canada, New Zealand, or the
United States. The types of mailbox that you can identify depends on the country that the address specifies.
Note: The Address Type port and Record Type port provide similar information. If you submit address
records for Address Matching Approval System certification or for Coding Accuracy Support System
certification, use Record Type.
Address Type Usage
To find out the type of mailbox that the address record contains, select Address Type.
121
Port Locations
The following table provides the location and default precision of the Address Type port:
Port Type
Port Group
Template Model
Precision
Output
Status Info
Basic
2
Output
New Zealand Specific
Basic
30
Address Type Output Codes
When you select the Address Type port for an Australian or United States address, the port returns a single
character. The following table describes the Address Type output codes for an Australian or United States
address:
Code
Description
B
Mailbox at a building.
F
Mailbox at an organization or firm.
G
General delivery address.
H
High-rise default address.
L
Mailbox at a large volume receiver.
M
Military address. Reserved for future use.
P
Post Office Box.
R
Rural route mailbox.
S
Mailbox at a street address.
U
Unknown. The transformation did not validate or correct the address.
When you select the Address Type port for a New Zealand address, the port returns a string. The following
table describes the Address Type output codes for a New Zealand address:
122
Code
Description
Urban Address
Mailbox that uses urban data, including street number data.
Rural Address
Mailbox that uses rural data, including rural delivery route data.
Delivery Service Address
Mailbox that uses a delivery service, for example a Post Office Box.
Chapter 8: Enrichment Data Ports
RELATED TOPICS:
•
“Record Type ” on page 248
Count
Output port that indicates the number of addresses in the address reference data sets that match the data in
the input address. Select the Count port when you configure the Address Validator transformation to run in
suggestion list mode.
Use suggestion list mode when you have a partial address and you want to see the valid addresses that
contain the values in the partial address. When address validation runs in suggestion list mode, it returns all
addresses that contain the data values in the input address.
Count Usage
To view the number of addresses in the address reference data that match the input address, select the
Count port.
Port Location
The following table provides the location and default precision of the Count port:
Port Type
Port Group
Template Model
Precision
Output
Basic
Status Info
3
Count Output Codes
The Count value is the number of matching addresses that address validation finds in the address reference
data. Address validation returns all matching addresses until it reaches the value that you specify in the Max
Result Count property in the Address Validator transformation.
If the number of matching addresses is greater than the Max Result Count value, perform one of the following
steps:
•
Increase then Max Result Count value.
•
Add data to the input address.
Note: The default value on the Max Result Count property is 20, You can increase the value to 100.
Count Overflow
Output port that indicates whether the address reference data contains addresses that address validation
does not return to the Address Validator transformation output ports. Select the Count Overflow port when
you configure the transformation to run in suggestion list mode.
When address validation runs in suggestion list mode, it returns all addresses that match the input address
up to a maximum number that you specify. You specify the maximum number of addresses in the Max Result
Count property on the Address Validator transformation. If the address reference data contains additional
addresses, the Address Validator transformation writes a value to the Count Overflow port.
Count
123
Count Overflow Usage
Select Count Overflow to determine whether the address reference data sets contain addresses that the
validation process did not return to the Address Validator transformation.
Port Location
The following table provides the location and default precision of the Count Overflow port:
Port Type
Port Group
Template Model
Precision
Output
Basic
Status Info
3
Count Overflow Output Codes
The following table describes the Count Overflow output codes:
Code
Description
No
Address validation returned all matching addresses
from the address reference data sets.
The address reference data sets do not contain
additional addresses.
Yes
Address validation did not return all matching
addresses from the address reference data sets.
The address reference data sets contain additional
addresses.
Finance Number
Output port that contains the code assigned to United States post offices and other postal facilities to enable
collection of cost and statistical data.
A finance number has six digits. The first two digits of the finance number identify the state. The final four
digits identify the United States Postal Service (USPS) post office or postal facility.
Finance Number Usage
Select Finance Number when you need to identify the post office or postal facility that processes an address.
You can use a finance number to identify a Business Mail Entry Unit (BMEU), as each BMEU has a unique
finance number.
Port Location
The following table provides the location and default precision of the Finance Number port:
124
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
6
Chapter 8: Enrichment Data Ports
Geocoding Complete
Output port that contains the Geocoding coordinates for the address.
Geocoding Complete Usage
Select Geocoding Complete to generate complete geocode coordinates for the output address. The port
contains the latitude and longitude coordinates and the standard used to calculate the coordinates.
The geocode coordinates conform to the World Geodetic Coordinate System of 1984 (WGS84). Coordinates
are in decimal degrees.
You can also select Geocoding Status to view a four-character code that describes the results of the geocode
operation for each address.
Port Location
The following table provides the location and default precision of the Geocoding Complete port:
Port Type
Port Group
Template Model
Precision
Output
Geocoding
Basic
60
Geocoding Complete Example
The following table shows the Geocoding Complete output for an address:
Address
Latitude
Longitude
Coordinate
Standard
300 Rector Place,
40.709060
-74.016970
WGS84
New York, NY 10280
The following string shows the appearance of the latitude, longitude, and coordinate standard data in the
output port:
40.709060 -74.016970 WGS84
Latitude
Output port that contains the latitude coordinate for the address.
Address validation presents latitude and longitude data according to the current World Geodetic System
(WGS) standard. The current standard is WGS84.
Latitude Usage
Select Latitude to add the latitude coordinate of an address to the output data.
Geocoding Complete
125
Port Location
The following table provides the location and default precision of the Latitude port:
Port Type
Port Group
Template Model
Precision
Output
Geocoding
Basic
30
Latitude Example
Johnstown Post Office in Johnstown, Pennsylvania has the following latitude:
40.32606
Latitude Longitude Unit
Output port that contains the measurement system used by geocoding in address validation.
Geocoding provides latitude and longitude coordinates for an address.
Address validation presents latitude and longitude data according to the current World Geodetic System
(WGS) standard. The current standard is WGS84.
Latitude Longitude Unit Usage
Select Latitude Longitude Unit to include the geocoding system in the address data.
Port Location
The following table provides the location and default precision of the Latitude Longitude Unit port:
Port Type
Port Group
Template Model
Precision
Output
Geocoding
Basic
10
Latitude Longitude Unit Output Codes
The Latitude Longitude Unit writes the following string as output:
WGS84
Longitude
Output port that contains the longitude coordinate for the address.
Address validation presents latitude and longitude data according to the current World Geodetic System
(WGS) standard. The current standard is WGS84.
Longitude Usage
Select Longitude to add the longitude coordinate of an address to the output data.
126
Chapter 8: Enrichment Data Ports
Port Location
The following table provides the location and default precision of the Longitude port:
Port Type
Port Group
Template Model
Precision
Output
Geocoding
Basic
30
Longitude Example
Johnstown Post Office in Johnstown, Pennsylvania has the following longitude:
-78.91712
Note: Longitudes west of the prime meridian have negative values.
Record ID Ports
Input and output ports that contain an identification string for each address in the data set.
Use this port to pass an identification string for each record. The Address Validator transformation does not
process this data.
Record ID Usage
Select a Record ID input port to pass a unique ID with each address record.
There are three Record ID ports. If an address contains more than one record, select additional Record ID
ports.
Port Locations
The following table provides the location and default precision of ports Record ID 1 through Record ID 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
ID Elements
Advanced
20
Record ID Example
You can pass any string as a record ID. The following string is a 15-digit identifier for an address:
637894066003681
Record ID Ports
127
Time Zone Code
Output port that indicates the time difference between the local time zone at the address and Greenwich
Mean Time (GMT).
Time Zone Code Usage
Select Time Zone Code to write the time zone difference to the address record. Sort records on this port to
organize the addresses according to the offset from GMT.
Use Time Zone Code with United States addresses.
Note: The Time Zone Code port does not recognize Daylight Savings Time.
Port Location
The following table provides the location and default precision of the Time Zone Code port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
3
Time Zone Code Output Codes
The time zone code is an two- or three-character string that states the time difference as a negative value.
Because the port does not recognize Daylight Savings Time, the output codes remain constant throughout
the year.
The following table describes the Time Zone Code output codes:
Time Zone
Output Code
Alaska standard time
-9
Atlantic standard time
-4
Central Standard Time
-6
Eastern Standard Time
-5
Hawaii-Aleutian standard time
-10
Mountain Standard Time
-7
Pacific Standard Time
-8
Time Zone Name
Output port that identifies the local time zone at the address.
Time Zone Name Usage
Select Time Zone Name to write the three- or four-letter abbreviation of the time zone to the address record.
Sort records on this port to organize the addresses by time zone.
128
Chapter 8: Enrichment Data Ports
Use Time Zone Name with United States addresses.
Port Location
The following table provides the location and default precision of the Time Zone Name port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
The time zone code is three-letter or four-letter string.
The following table describes the Time Zone Name output codes:
Code
Description
AKST
Alaska standard time
AST
Atlantic standard time
CST
Central standard time
EST
Eastern standard time
HAST or HST
Hawaii-Aleutian standard time
MST
Mountain standard time
PST
Pacific standard time
Transaction Key Ports
Input and output ports that contain transaction record data related to the address.
A transaction key is a string that an organization adds to an address record to identify a transaction
performed for that address. For example, a business may create a customer record with the customer name
and address and a unique transaction number related to a customer purchase. An online business may use
transaction keys to track customer orders that are completed by mail.
Transaction Key Usage
Select a Transaction Key input port to read transaction number or code data as part of an input address.
Select a Transaction Key output port to write transaction number or code data to the output address.
The Address Validator transformation does not parse or validate transaction data. If you select a Transaction
Key input port, select a Transaction Key output port and pass the data from the input to the output.
The Transaction Key output port has a lower precision than the input port. The Address Validator
transformation truncates the port data if the data length exceeds the precision.
Transaction Key Ports
129
Port Locations
The following table provides the location and default precision of the ports Transaction Key 1 through
Transaction Key 3:
130
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
ID Elements
Advanced
20
Chapter 8: Enrichment Data Ports
CHAPTER 9
Formatted Data Ports
This chapter includes the following topics:
•
Complete Address Ports, 131
•
Country Specific Last Line Ports, 132
•
Delivery Address Line Ports, 134
•
Formatted Address Line Ports, 136
•
Recipient Line Ports, 138
Complete Address Ports
Input and output ports that contain a complete postal address in the format that the local mail carrier
recognizes.
Complete Address ports read and write the address in a single delimited string.
Complete address data can include the following elements:
•
Contact data
•
Building and sub-building data
•
Street and dependent street data
•
Locality data
•
Province data
•
Post code data
•
Country data
Complete Address data does not include data that enhances deliverability, such as barcode data.
Complete Address Usage
Select the Complete Address input port when the input record contains a complete postal address in a
delimited string. The Address Validator transformation parses the input string for data that can complete a
standard postal address for the country identified in the record.
Select the Complete Address output port to write addresses that are structured for envelope printing and mail
delivery. Complete Address contains a correctly structured address in a single delimited string.
Correctly structured addresses can qualify for postal discounts.
131
Consider the following guidelines when you use Complete Address ports:
•
The Complete Address output port may combine or reorder data elements and may change the case of
the data.
•
If you select Formatted Address Line input ports, do not select a Complete Address input port. A
Complete Address port contains the same data as the set of Formatted Address Line ports.
•
When you select the Complete Address input port in Suggestion List mode, you can optionally select the
Country Name port from the Multiline port group. Otherwise, do not select any other port when you select
the Complete Address input port in Suggestion List mode.
•
The input address data must contain the complete postal address. The Address Validator transformation
cannot format an address if any data is absent.
Port Locations
The following table provides the location and default precision of the Complete Address port:
Port Type
Port Group
Template Model
Precision
Input
Multiline
Basic
250
Output
Formatted Address Line
Basic
250
Complete Address Example
The following example address contains data that the Address Validator transformation can parse to a
Complete Address port:
Mr. John Doe
21823 100TH Avenue South East
Suite 291
98031-2566
Kent
WA
The Complete Address output port contains the following delimited string:
MR. JOHN DOE, 21823 100TH AVE SE STE 291, KENT WA 98031-2566
The following example shows the appearance of this address when the delimited fields are printed in the
USPS standard format:
MR. JOHN DOE
21823 100TH AVE SE STE 291
KENT WA 98031-2566
Country Specific Last Line Ports
Input and output ports that contain the final line of locality data in a formatted address.
The national mail carrier defines the standard address format for mail items in a country. If you provide
addresses that conform to the standard format, the mail carrier can offer you a discount on the cost of
delivery.
A Country Specific Last Line port contains a locality name and may contain other data elements. For
example, a Country Specific Last Line port contains city, state, and ZIP Code data in a United States
address.
132
Chapter 9: Formatted Data Ports
The USPS recommends the following structure for domestic residential addresses:
Line 1
Line 2
Line 3
Person/Contact Data
Street Number, Street, Sub-Building
Locality, State, ZIP Code
JOHN DOE
123 MAIN ST NW STE 12
ANYTOWN NY 12345
Note: Domestic address data identifies a mailbox within a country. The Country Specific Last Line port does
not contain country data.
Country Specific Last Line Usage
Select a Country Specific Last Line input port when the input address is formatted for postal delivery.
Connect the port that contains the last or principal locality data element to the Country Specific Last Line
port.
Select a Country Specific Last Line output port to create a formatted address that writes the last line of
locality data to a single port.
When you select a Country Specific Last Line port to define a formatted address, you must also select the
ports that contain the other lines in the address. Select the following ports with Country Specific Last Line:
•
Recipient Line ports. Contain person or contact data.
•
Delivery Address Line ports. Contain building, street, and sub-building data.
•
Province ports. Required if province data is not part of the locality line.
•
Postcode ports. Required if the mail format places post code data below the locality data.
•
Country ISO3 Char port. Contains the ISO three-letter code. Required if the address contains country
information.
Consider the following guidelines when you use Country Specific Last Line ports:
•
There are six Country Specific Last Line ports. Use Country Specific Last Line 1 for the last line of the
locality data.
•
The Country Specific Last Line output port may combine or reorder data elements and may change the
case of the data.
Port Locations
The following table provides the location and default precision of ports Country Specific Last Line 1 through
Country Specific Last Line 3:
Port Type
Port Group
Template Model
Precision
Input
Hybrid
Basic
128
Output
Last Line Elements
Basic
128
The following table provides the location and default precision of ports Country Specific Last Line 4 through
Country Specific Last Line 6:
Port Type
Port Group
Template Model
Precision
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
128
Country Specific Last Line Ports
133
Country Specific Last Line Example
The following example address contains data that the Address Validator transformation can parse to a
Country Specific Last Line port:
Mr. John Doe
21823 100th Avenue South East
Suite 291
98031-2566
Kent
Washington
The following table shows the Address Validator transformation ports that create the formatted address for
the example:
Port
Data
Recipient Line 1
MR. JOHN DOE
Delivery Address Line 1
21823 100TH AVE SE STE 291
Country Specific Last Line 1
KENT WA 98031-2566
Delivery Address Line Ports
Input and output ports that contain building and street data that is formatted to mail delivery standards.
The national mail carrier defines the standard address format for mail items in a country. If you provide
addresses that conform to the standard format, the mail carrier can offer you a discount on the cost of
delivery. Delivery Address Line ports enable you to read and write building and street data in the format
expected by the national mail carrier.
For example, the USPS recommends the following structure for domestic residential addresses:
Line 1
Line 2
Line 3
Person or contact
Street Number, Street, Sub-building
City, State, ZIP Code
JOHN DOE
123 MAIN ST NW STE 12
ANYTOWN NY 12345
Delivery Address Line ports contain the street number, street, and sub-building data in this address. Delivery
Address Line ports can also contain building data.
Delivery Address Line Usage
Select Delivery Address Line input ports when the input address contains the building and street level data in
formatted lines.
Select Delivery Address Line output ports to create a formatted address that writes building and street level
data to a common set of ports.
When you select Delivery Address Line ports to define a formatted address, you must also select the ports
that contain the other lines in the address. Select the following ports with Delivery Address Line ports:
134
•
Recipient Line ports. Contain person or contact data.
•
Country Specific Last Line port. Contains the address line that includes the primary locality name.
•
Province ports. Required if province data is not part of the locality line.
Chapter 9: Formatted Data Ports
•
Postcode ports. Required if the mail format places post code data below the locality data
•
Country ISO3 Char port. Contains the ISO three-letter code. Required for international addresses.
Consider the following guidelines when you use Delivery Address Line ports:
•
Formatted Address Line ports can also create addresses in the structure expected by the domestic mail
carrier. However, a Formatted Address Line port can contain any type of address data. Select Delivery
Address Line output ports to ensure that the same ports contain all building and street level data for the
addresses in the data set.
•
There are six Delivery Address Line ports. The number of Delivery Address Line ports you need can differ
from country to country. Select the number of Delivery Address Line ports you need for each country in
the address data set.
•
The Delivery Address Line output ports may combine or reorder data elements and may change the case
of the data. Delivery Address Line output may also omit data elements that are not required by the mail
carrier.
Port Locations
The following table provides the location and default precision of ports Delivery Address Line 1 through
Delivery Address Line 6:
Port Type
Port Group
Template Model
Precision
Input
Hybrid
Basic
128
Output
Address Elements
Basic
128
Delivery Address Line Example
The following example address contains data that the Address Validator transformation can parse to Delivery
Address Line ports:
MR JOHN SMITH
36 PECKETT SQUARE
HIGHBURY GRANGE
LONDON
N5 2PB
The following table shows the Address Validator transformation ports that can create a formatted address for
the example:
Port
Data
Recipient Line 1
MR. JOHN SMITH
Delivery Address Line 1
36 PECKETT SQUARE
Delivery Address Line 2
HIGHBURY GRANGE
Country Specific Last Line 1
LONDON
Postcode 1
N5 2PB
Delivery Address Line Ports
135
Formatted Address Line Ports
Input and output ports that contain data that is formatted on multiple lines to mail delivery standards.
The national mail carrier defines the standard address format for mail items in a country. If you provide
addresses that conform to the standard format, the mail carrier can offer you a discount on the cost of
delivery. Formatted Address Line ports create address lines that are structured to the postal standards of the
mail carrier. Formatted Address Line ports read and write the address data to multiple lines.
You can use Formatted Address Line ports with addresses of different types and from different countries.
Formatted Address Line ports can contain any type of address data. For example, if the input data set
contains both residential and business addresses, the Address Validator transformation parses the lines of
each address according to the expected postal format. The output data creates a printable address
regardless of the address structure required.
Formatted address data can include the following elements:
•
Contact data
•
Building and sub-building data
•
Street and dependent street data
•
Post Office Box data
•
Locality data
•
Province data
•
Post code data
•
Country data
Formatted Address Line ports do not include data that enhances deliverability, such as barcode data.
Formatted Address Line Usage
Select Formatted Address Line input ports when the input data is composed of address line instead of fields
for specific information types.
Select Formatted Address Line output ports to write addresses that are formatted for envelope printing and
mail delivery.
Consider the following guidelines when you use Formatted Address Line ports:
136
•
The Formatted Address Line output ports may combine or reorder data elements and may change the
case of the data.
•
If you select Formatted Address Line input ports, do not select a Complete Address input port. A
Complete Address port contains the same data as the set of Formatted Address Line ports.
•
The input address data must contain the complete postal address. The Address Validator transformation
cannot format an address if any data is missing.
•
There are 19 Formatted Address Line input and output ports. Use ports Formatted Address Line 1 through
Formatted Address Line 12.
Chapter 9: Formatted Data Ports
Port Locations
The following table provides the location and default precision of ports Formatted Address Line 1 through
Formatted Address Line 12:
Port Type
Port Group
Template Model
Precision
Input
Multiline
Basic
128
Output
Formatted Address Line
Basic
128
The following table provides the location and default precision of ports Formatted Address Line 13 through
Formatted Address Line 19:
Port Type
Port Group
Template Model
Precision
Input
Multiline
Advanced
50
Output
Formatted Address Line
Advanced
128
Note: Formatted Address Line ports 13 through 19 are reserved for future use.
Formatted Address Line Example
The following example address contains data that the Address Validator transformation can parse to
Formatted Address Line ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
The following table shows the address in the United States Postal Service (USPS) standard format:
Port
Data
Formatted Address Line 1
MR. JOHN DOE
Formatted Address Line 2
1000 5TH AVE # 12
Formatted Address Line 3
NEW YORK NY 10028-0198
The USPS postal standard writes a residential United States address on three address lines.
Formatted Address Line Ports
137
Recipient Line Ports
Input and output ports that contain the first line of data that relates to the intended recipient of the mail.
Recipient Line data can form part of a formatted address.
The national mail carrier defines the standard address format for mail items in a country. If you provide
addresses that conform to the standard format, the mail carrier can offer you a discount on the cost of
delivery.
Recipient Line Usage
Select a Recipient Line input port to identify the person or organization to whom the mail is addressed in the
input record.
Select a Recipient Line output port to add the person or organization to whom the mail is addressed to the
output record.
When you select a Recipient Line port to define a formatted address, you must also select the ports that
contain the other lines in the address. Select the following ports with Recipient Line:
•
Delivery Address Line ports. Contain building, street, and sub-building data.
•
Country Specific Last Line port. Contains the last line of domestic data in the formatted address.
•
Postcode ports. Required if the mail format places the post code data below the locality data.
•
Country ISO3 Char port. Contains the ISO three-letter code. Required if the address contains country
information.
Consider the following guidelines when you use Recipient Line ports:
•
There are six Recipient Line ports. The number of Recipient Line ports that you need depends on the
number of recipients present in the input address data set.
•
Formatted Address Line ports can also create addresses in the structure expected by the domestic mail
carrier. Select Recipient Line output ports when you know that one or more ports contain recipient data
only and you want to recognize the ports in the output data set.
•
Contact data ports can contain the same data as Recipient Line ports. Select contact data ports when you
want to parse different details about the mail recipient to different ports. The Recipient Line ports write all
data on the recipient line to a single port.
•
Recipient Line ports and contact ports can contain the same data. Use contact data ports if the address
contains multiple types of recipient data and you want to write each type to a separate port. Use Recipient
Line ports to write the formatted line of contact data to a single port.
Port Locations
The following table provides the location and default precision of ports Recipient Line 1 through Recipient
Line 6:
138
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Contact Elements
Advanced
50
Chapter 9: Formatted Data Ports
Recipient Line Example
The following example address contains data that the Address Validator transformation can parse to a
Recipient Line port:
MR. JOHN DOE
38A ST. JAMES'S STREET
LONDON
E17 7PE
UNITED KINGDOM
The following table shows the Address Validator transformation ports that create the formatted address for
the example:
Port
Data
Recipient Line 1
MR. JOHN DOE
Delivery Address Line 1
38A ST. JAMES'S STREET
Country Specific Last Line
LONDON
Postcode 1
E17 7PE
Country ISO3 Char 1
GBR
Recipient Line Ports
139
CHAPTER 10
Postal Carrier Certification Data
Ports
This chapter includes the following topics:
140
•
Address Matching Approval System Status, 141
•
AMAS Error Code, 142
•
Barcode, 143
•
CASS Error Code, 144
•
Coding Accuracy Support System Status , 145
•
Carrier Route , 146
•
Category, 147
•
Commercial Mail Receiving Agent , 148
•
Default Flag, 149
•
Congressional District , 149
•
Delivery Point Identification, 150
•
Delivery Point Check Digit , 151
•
Delivery Point Code , 152
•
Delivery Point Validation Confirmation , 152
•
Delivery Point Validation False Positive , 153
•
Delivery Point Validation Footnote 1, 154
•
Delivery Point Validation Footnote 2, 155
•
Delivery Point Validation Footnote 3, 156
•
Delivery Point Validation Footnote Complete, 157
•
Delivery Service Locality, 158
•
Delivery Service Number, 159
•
Delivery Service Type, 160
•
Delivery Sequence File Second Generation No Statistics Indicator, 161
•
Delivery Sequence File Second Generation Vacant Indicator, 162
•
ELOT Flag, 163
•
ELOT Sequence, 164
•
Early Warning System Return Code, 164
•
Exclude Flag, 165
•
High Rise Default , 166
•
High Rise Exact , 167
•
Hygiene, 167
•
Locatable Address Conversion System , 168
•
Locatable Address Conversion System Link Indicator, 169
•
Locatable Address Conversion System Link Return Code , 169
•
Lot Number, 170
•
National Address Management Service Status, 171
•
Postal Phrase Number Ports (AMAS), 172
•
Postal Phrase Prefix, 172
•
Postal Phrase Suffix, 174
•
RD Number, 175
•
Residential Delivery Indicator, 176
•
SendRight Status, 176
•
Software Evaluation And Recognition Program Status , 177
•
SOA Record Ignored, 178
•
Street Number Ports (AMAS), 179
•
Suite Link Return Code , 179
•
Validity Code, 180
•
Zip Move Return Code , 181
Address Matching Approval System Status
Output port that indicates whether an output address record contains the types of data required by the
Address Matching Approval System (AMAS) of Australia Post.
To confirm the AMAS status of an address, configure the Address Validator transformation to run in certified
mode.
Address Matching Approval System Usage
Select Address Matching Approval System Status to verify that output address records contain all data
required for address validation to the AMAS standard. If the addresses you submit to Australia Post meet the
AMAS standard, you can qualify for mail discount.
To comply with the AMAS standard, an address must contain a Delivery Point Identifier (DPID) value.
Australia Post assigns a DPID value to every mailbox listed in its Postal Address File (PAF). The Address
Validator transformation can add a DPID value to a validated Australian address. Select the Delivery Point
Identification port to add the DPID value to the address record.
Note: The Address Matching Approval System Status value indicates whether an address can be validated to
the AMAS standard. It does not indicate the quality or deliverability of the address. However, if address
validation cannot provide all AMAS elements for an address, the address is not correct to DPID level.
Address Matching Approval System Status
141
Port Location
The following table provides the location and default precision of the Address Matching Approval System
Status port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
4
Address Matching Approval System Status Output Codes
The following table describes the Address Matching Approval System Status output codes:
Code
Description
EAM0
The Address Validator transformation did not perform an AMAS check on the
address. The address did not contain DPID data or the AMAS certification check
was not activated.
EAM1
The Address Validator transformation corrected or validated the address to the
AMAS standard. The address contains DPID data.
EAM2
The Address Validator transformation cannot perform an AMAS check on the
address. The transformation did not return DPID data.
AMAS Error Code
Output port that indicates whether the ports in the Australia Specific port group contain data for the address.
AMAS Error Code Usage
The Australia Specific port group includes data that Australia Post can use to certify the deliverability of the
address. Australia Post uses the Address Matching Approval System (AMAS) to certify address records. Use
the AMAS Error Code to verify that an address record contains the data required by the AMAS standard.
When an address does not meet the standard, the error code can indicate the reason why. The code can
indicate that one or more address values are not valid to the AMAS standard. In some cases, you can delete
the address values and submit the updated address record for certification. standard. When
Port Location
The following table provides the location and default precision of the AMAS Error Code port:
142
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Advanced
2
Chapter 10: Postal Carrier Certification Data Ports
AMAS Error Code Output Codes
The following table describes AMAS Error Code output codes:
Code
Description
E0
The address is valid to the AMAS standard. No changes are necessary.
E1
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete all address data.
E2
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete all street data and house number data.
E3
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete all delivery service or Post Office Box data.
E4
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete the street name.
E5
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete the house number.
E6
The address is not valid to the AMAS standard.
To use the address record in the record set you submit for AMAS
certification, delete the delivery service or Post Office Box number.
EX
Address validation cannot process the address to the AMAS standard. The
address format is not valid.
Barcode
Output port that contains the United States Postal Service (USPS) barcode number for an address.
The 11 digits of the barcode number contain all the information that the USPS needs to deliver a mail item to
its destination mailbox. The barcode digits enable an automated mailing system to generate the barcode for a
mail item.
The address record must contain a ZIP+4 Code and a Delivery Point Code (DPC) to generate the barcode
data. A DPC is a two-digit number that allows the USPS to uniquely identify the destination mailbox within the
area covered by the ZIP+4 Code.
Note: A printed barcode has 62 bars. The USPS uses Postal Numeric Encoding Technique (POSTNET)
technology to read the 11 barcode digits and generate the bars for each address.
Barcode
143
Barcode Usage
Select the Barcode port if you send address data to an automated mailing system for barcode printing. The
USPS sorts barcoded mail using high-speed scanners. The USPS discounts the cost of mail delivery for
barcoded mail items.
Correct barcode data also demonstrates that the address contains all required delivery information. This
information can certify to mail carriers that an address is fully complete.
To generate Barcode output, configure the Address Validator transformation to run in certified mode.
Port Location
The following table provides the location and default precision of the Barcode port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
11
Barcode Output Codes
The following table shows the structure of the Barcode output:
Positions 1-5
Positions 6-9
Positions 10-11
Five-digit ZIP Code
Four-digit ZIP+4 extension
Delivery Point Code
CASS Error Code
Output port that indicates whether the ports in the US Specific port group contain data for the address.
Address validation does not currently generate output on the CASS Error Code port.
CASS Error Code Usage
Use the following port to verify that an address meets the Coding Accuracy Support System (CASS) standard
of the United States Postal Service (USPS):
•
Coding Accuracy Support System Status
Port Location
The following table provides the location and default precision of the CASS Error Code port:
144
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Chapter 10: Postal Carrier Certification Data Ports
Coding Accuracy Support System Status
Output port that indicates whether an output address record contains the types of data required by the United
States Postal Service (USPS) Coding Accuracy Support System (CASS).
A United States address may not contain all data required for CASS certification, even if the address is
correct. When you validate United States addresses with the Address Validator transformation, the validation
process adds data elements to the address records so that they meet the CASS standard.
To confirm the CASS status of the address data, configure the Address Validator transformation in certified
mode.
Coding Accuracy Support System Status Usage
Select Coding Accuracy Support System Status to verify that output address records contain all data required
for address validation to the CASS standard. If the addresses you submit to the USPS meet the CASS
standard, you can qualify for mail discount.
Note: The Coding Accuracy Support System Status value indicates whether an address can be validated to
the CASS standard. It does not indicate the quality or deliverability of the address. However, if address
validation cannot provide all CASS elements for an address, the address is not correct to ZIP+4 Code level.
Port Location
The following table provides the location and default precision of the Coding Accuracy Support System Status
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
4
Coding Accuracy Support System Status Output Codes
The following table describes the Coding Accuracy Support System Status output codes:
Code
Description
ECA0
The address does not contain enough data for CASS certification.
Coding Accuracy Support System Status also returns ECA0 if you do not configure
the Address Validator transformation in certified mode.
ECA1
The address contains some of the data necessary for CASS certification. Address
validation cannot provide additional CASS data because some CASS database
files are missing.
ECA2 - ECA4
Reserved for future use.
ECA5
The address contains all relevant CASS data.
Coding Accuracy Support System Status
145
Carrier Route
Output port that identifies the United States Postal Service (USPS) carrier route for a United States address.
A carrier route can identify the area that is covered by a mail delivery person.
Carrier Route Usage
Select Carrier Route to identify the delivery route that an address belongs to. You can also use Carrier Route
to identify the carrier route type, such as city, rural route, or general delivery.
Note: An address is considered "general delivery" if the addressee cannot receive mail at a physical mailbox.
General delivery addressees can collect mail at a USPS post office.
Port Location
The following table provides the location and default precision of the Carrier Route port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
4
Carrier Route Output Codes
A complete postal carrier route has nine characters. The first five characters are the five-digit ZIP Code. The
last four characters specify the carrier route within the ZIP Code. The Carrier Route port returns the last four
characters.
The following table shows the structure of a carrier route:
Positions 1-5
Position 6
Positions 7-9
Five-digit ZIP Code
Letter
Route
The letter in position 6 identifies the route type. The following table lists the types of route that position 6
identifies:
146
Letter
Carrier Route Type
B
Post Office Box
C
City delivery
G
General delivery
H
Highway contract
R
Rural route
Chapter 10: Postal Carrier Certification Data Ports
Category
Output ports that describe the result of an address validation process on an address in Canada or in France.
The Address Validator transformation contains a Category port in the Canada Specific port group and the
Canada Specific port group. Select the correct port for addresses in France and in Canada.
If you submit address records to Canada Post for Software Evaluation And Recognition Program (SERP)
certification, you must provide the category code for each address. If you submit address records to La Poste
for National Address Management Service (SNA) certification, you must provide the category code for each
address. When you select the Category port, configure the Address Validator transformation to run in
Certified mode.
Category Usage
Select a Category port to review the results of address validation on address data from Canada or from
France.
The Category port provides summary indicators of the success of a validation operation. Use the Category
port output with the Match Code port output to evaluate the status of the addresses.
Port Location
The following table provides the location and default precision of the Category ports:
Port Type
Port Group
Template Model
Precision
Output
Canada Specific
Basic
2
Output
France Specific
Basic
3
Category Output Codes
The Category port writes a single-letter output code for a Canadian address.
The following table describes the codes:
Code
Description
V
Address validation validated the address as deliverable.
C
Address validation corrected the address with the reference data. The address
might be deliverable.
N
Address validation did not validate the address as deliverable.
The Category port writes a three-letter output code for a French address.
The following table describes the codes:
Code
Description
AVE
The output address is not valid.
NOK
The output address is not valid.
Category
147
Code
Description
ORI
The output address is valid. The input address and the output address are
identical.
RES
The output address is valid. The input address and the output address are not
identical.
Commercial Mail Receiving Agent
Output port that identifies addresses that are managed by a Commercial Mail Receiving Agent (CMRA).
A CMRA maintains Post Office Boxes (PO Boxes).
The USPS maintains a table of addresses that are deliverable to a CMRA mailbox and not to the physical
location of a business or place of residence. USPS address reference data includes this table. Address
validation validates an address against the CMRA reference table if the address contains a valid Delivery
Point Code number.
Note: A CMRA may also be known as an Office Business Center (OBC) or a Corporate Executive Center
(CEC).
Commercial Mail Receiving Agent Usage
Select Commercial Mail Receiving Agent to identify addresses that are managed by a CMRA.
CMRA data has the following uses:
•
Direct marketing. You can tell if an address delivers directly to business or householder or if the address
delivers to a PO Box.
•
Mail sorting. Automated mailing systems can tell if an address has a street mailbox or a mailbox at a
CMRA.
Port Location
The following table provides the location and default precision of the Commercial Mail Receiving Agent port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Commercial Mail Receiving Agent Output Codes
The following table describes the Commercial Mail Receiving Agent output codes:
148
Code
Description
Y
The validated address matches an address in the CMRA table.
N
The validated address does not match an address in the CMRA table.
[Blank]
Address validation did not check the address against the CMRA table.
Chapter 10: Postal Carrier Certification Data Ports
Default Flag
Output port that indicates if a United States address matches a high-rise default or rural route default address
in the reference data.
Default Flag Usage
Select Default Flag to determine if the address record matches one of the following address types in the
reference data:
•
High-rise default
•
Rural route default
Port Location
The following table provides the location and default precision of the Default Flag port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Default Flag Output Codes
The following table describes the Default Flag output codes:
Code
Description
Y
The address matches a high-rise default or rural route default address.
[Blank]
The address does not match a high-rise default or rural route default address.
RELATED TOPICS:
•
“High Rise Default ” on page 166
•
“Rural Route Default ” on page 192
Congressional District
Output port that identifies the congressional district that an address belongs to.
Each congressional district contains approximately 600,000 people. Address validation uses the ZIP+4 Code
to generate the congressional district number for an address.
Congressional District Usage
Select Congressional District to add the congressional district number to an address record.
Use congressional district numbers to understand the geographical distribution of a large record set. Some
five-digit ZIP Codes lie within congressional districts, while some cross district boundaries. All ZIP+4 Codes
lie within congressional districts.
Direct mail and government agencies can use congressional district numbers to verify that mail items reach
addressees in particular districts.
Default Flag
149
Port Location
The following table provides the location and default precision of the Congressional District port:
Port Type
Port Group
Template Model
Precision
US Specific
Output
Basic
3
Congressional District Output Codes
The congressional district number is a two-digit number that identifies a congressional district within a state.
You can view a list of congressional districts on the following site:
http://www.house.gov/representatives/
Delivery Point Identification
Output port that contains the Delivery Point Identifier (DPID) value for an Australian or New Zealand address.
An address record must include a DPID to meet the Address Matching Approval System (AMAS) or
SendRight standard.
The DPID is an 8-digit number that identifies a mailbox in the Postal Address Files (PAF) of Australia Post
and New Zealand Post. The DPID contains all the information that Australia Post and New Zealand Post
need to deliver a mail item. The postal services can use the eight digits to generate barcodes for mail items.
Note: Multiple address records can share a DPID. For example, a DPID can identify a building that contains
more than one mailbox.
Delivery Point Identification Usage
To add DPID data to an Australian or New Zealand address, select the Delivery Point Identification port.
Consider the following factors when you select the Delivery Point Identification port:
150
•
When you generate address records for AMAS or SendRight certification, select the Delivery Point
Identification port.
•
When you select the Delivery Point Identification port for Australian addresses, select the Address
Matching Approval System Status port also. Address Matching Approval System Status indicates if the
address record data meets the AMAS standard.
•
When you select the Delivery Point Identification port for New Zealand addresses, select the SendRight
Status port. The SendRight Status port indicates if the address record data meets the SendRight
standard.
•
To view Delivery Point Identification data, configure the Address Validator transformation to run in certified
mode.
Chapter 10: Postal Carrier Certification Data Ports
Port Location
The following table provides the location and default precision of the Delivery Point Identification port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
8
Output
New Zealand Specific
Basic
20
Delivery Point Identification Output Codes
In a New Zealand address, the DPID is an 8-digit number in the range from 1 through 99,999,999.
In an Australian address, the DPID is an 8-digit number in the range from 30,000,000 through 99,999,999.
Delivery Point Check Digit
Output port that validates the ZIP+4 Code and Delivery Point Code (DPC) information in a United States
address.
A check digit is single digit that is calculated using other digits in the same string. Address validation
generates a delivery point check digit for all addresses with valid ZIP+4 Code and DPC information. When
you add the digits in a ZIP+4 Code and DPC to the correct check digit, the sum is evenly divisible by ten. An
automated mail system can use the delivery point check digit to verify that the ZIP+4 Code and DPC identify
a valid United States address.
A delivery point is a unique mailbox recognized by the postal system. The United States Postal Service
(USPS) assigns a two-digit DPC to every mailbox in a ZIP+4 Code area.
Note: The USPS uses the combined digits of the ZIP+4 Code and the DPC to form barcode numbers.
Delivery Point Check Digit Usage
Select Delivery Point Check Digit to enable an automated mail system to validate the ZIP+4, DPC, and
barcode information in an address.
Port Location
The following table provides the location and default precision of the Delivery Point Check Digit port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Delivery Point Check Digit Output Codes
The following table shows a sample ZIP+4 Code, delivery point code, and check digit:
ZIP+4 Code
Delivery Point Code
Check Digit
12345-6789
01
4
Delivery Point Check Digit
151
The following calculation verifies that the ZIP+4 code and delivery point information identify a valid address:
ZIP+4 Code = 123456789
Delivery Point Code = 01
Sum of digits 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 0 + 1 = 46
Add check digit +4
Equals 50
Divide 50 by 10 = 5 with no remainder
Delivery Point Code
Output port that identifies a mailbox in an area covered by a ZIP+4 Code.
The USPS assigns a two-digit Delivery Point Code (DPC) to every mailbox in a ZIP+4 Code area. Address
validation uses USPS address reference data to add the DPC to an address. The DPC is a pair of digits
between 00 and 99.
Delivery Point Code Usage
Select Delivery Point Code to add the DPC to the output address record. Add the DPC to the ZIP+4 Code to
identify any deliverable address in the United States.
Address validation can generate a USPS barcode from the combined ZIP+4 Code and DPC information.
Port Location
The following table provides the location and default precision of the Delivery Point Code port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Delivery Point Validation Confirmation
Output port that confirms the validity of the Delivery Point Code (DPC) value for a United States address.
Delivery Point Validation (DPV) is a form of address validation designed by the USPS to ensure that an
address can receive mail. USPS address reference data set includes DPV data.
A delivery point is a unique mailbox recognized by the postal system. The USPS assigns a two-digit DPC to
every mailbox in a ZIP+4 Code area. If an address has a valid DPC for its ZIP+4 Code, then the USPS can
confirm that the address identifies a deliverable mailbox.
Note: A ZIP+4 Code defines a range of addresses, such as from 1 Main Street through 99 Main Street.
However, the presence of a valid ZIP+4 Code in an address does not confirm that a mailbox exists for the
address. The address "99 Main Street" may have a deliverable mailbox, but the address "98 Main Street"
may not. DPV reference data identifies physical mailboxes in the ZIP+4 Code area.
An address with a valid ZIP+4 Code but without a valid DPC may identify a building that is unused, a building
that does not exist, or a vacant lot.
Delivery Point Validation Confirmation Usage
Select Delivery Point Validation Confirmation to confirm that an address has a valid DPC and is therefore a
deliverable to a mailbox. The USPS considers an address without a confirmed DPC to be undeliverable.
152
Chapter 10: Postal Carrier Certification Data Ports
Note: You can get additional information about the deliverable status of non-DPC addresses by selecting the
Record Type output port.
Port Location
The following table provides the location and default precision of the Delivery Point Validation Confirmation
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Delivery Point Validation Confirmation Output Codes
The following table describes the Delivery Point Validation Confirmation output codes:
Code
Description
Y
Confirms the DPC value for the address. The address is confirmed deliverable.
D
Partial confirmation of the DPC value. Some address information is missing.
S
Partial confirmation of the delivery point values. Some address information cannot
be confirmed.
N
The DPC value is not valid for the address.
[Blank]
The address did not contain a DPC value and was not presented for DPV
confirmation.
Delivery Point Validation False Positive
Output port that indicates whether the address validation detected a falsified address.
Delivery Point Validation (DPV) is the USPS system of ensuring that the delivery point identified by an
address can receive mail. The USPS address reference data contains DPV data.
The USPS adds false addresses to the DPV reference data to detect mailers who attempt to generate mailing
lists from the reference data. The USPS encrypts its reference data. If an address record set contains a false
positive address, the mailer has used decryption software to read the reference data and create a mailing list.
Delivery Point Validation False Positive Usage
Use Delivery Point Validation False Positive to verify that the address validation process conforms to USPS
rules concerning mailing lists.
Delivery Point Validation False Positive
153
Port Location
The following table provides the location and default precision of the Delivery Point Validation False Positive
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Delivery Point Validation False Positive Output Codes
The following table describes the Delivery Point Validation False Positive output codes:
Code
Description
Y
The address appears in the false positive table in the DPV reference data.
N
The address does not appear in the false positive table in the DPV reference data.
[Blank]
The address was not passed to the false positive table in the DPV reference data.
Delivery Point Validation Footnote 1
Output port that indicates if the address validation process can match the input address with an address in
the USPS Delivery Point Validation (DPV) reference data set.
The DPV reference data set verifies that a physical mailbox exists for an address. The types of mailbox
include houses, apartments, offices, rural mailboxes, and commercial mail receiving agencies.
DPV processing requires a valid ZIP+4 Code.
Delivery Point Validation Footnote 1 Usage
Select Delivery Point Validation Footnote 1 to verify that the input address contains enough data to pass
delivery point validation. Delivery Point Validation Footnote 1 is a two-character code.
The USPS groups DPV footnote information in a single string. To generate a complete DPV result string,
select the following ports:
154
•
Delivery Point Validation Confirmation
•
Delivery Point Validation Footnote 1
•
Delivery Point Validation Footnote 2
•
Delivery Point Validation Footnote 3
Chapter 10: Postal Carrier Certification Data Ports
Port Location
The following table provides the location and default precision of the Delivery Point Validation Footnote 1
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Delivery Point Validation Footnote 1 Output Codes
The following table describes the output codes for Delivery Point Validation Footnote 1:
Code
Description
AA
The address matches the USPS ZIP + 4 Code data.
A1
The address does not match the USPS ZIP + 4 Code data.
Delivery Point Validation Footnote 2
Output port that describes the result of the Delivery Point Validation (DPV) check performed on an address.
Delivery Point Validation Footnote 2 Usage
Select Delivery Point Validation Footnote 2 to view a coded description of the DPV status of the address.
Delivery Point Validation Footnote 2 is a two-letter code.
Note: The USPS groups DPV footnote information in a single string. To generate a complete DPV result
string, select the following ports:
•
Delivery Point Validation Confirmation
•
Delivery Point Validation Footnote 1
•
Delivery Point Validation Footnote 2
•
Delivery Point Validation Footnote 3
Port Location
The following table provides the location and default precision of the Delivery Point Validation Footnote 2
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Delivery Point Validation Footnote 2
155
Delivery Point Validation Footnote 2 Output Codes
The following table describes the output codes for Delivery Point Validation Footnote 1:
Code
Description
BB
The input address matches an address in the USPS DPV data set in all
respects.
CC
The primary number in the input address matches an address in the USPS
DPV data set, but the secondary number does not match.
N1
The primary number in the input address matches an address in the USPS
DPV data set, but the secondary number is missing.
M1
The primary number in the input address is absent.
M3
The primary number in the input address is not valid.
P1
The rural route or highway contract number in the input address is absent.
P3
The post office, rural route, or highway contract number in the input
address is absent.
F1
The input address matches a military address.
G1
The input address matches a general delivery address. An address is
considered "general delivery" if the addressee cannot receive mail at a
physical mailbox. General delivery addressees can collect mail at a USPS
post office.
UI
The input address matches a unique ZIP Code.
Delivery Point Validation Footnote 3
Output port that indicates if the Delivery Point Validation (DPV) check identified the address as a Commercial
Mail Receiving Agent (CMRA).
Delivery Point Validation Footnote 3 can also indicate if DPV processing changed the Private Mailbox (PMB)
indicator in a CMRA address. For example, the CMRA address may identify the mailbox number with the
number symbol (#). DPV processing may change the number symbol if it finds more accurate information in
the USPS DPV reference data set.
Delivery Point Validation Footnote 3 Usage
Select Delivery Point Validation Footnote 3 to determine if an address belongs to a CMRA and to verify if
DPV processing altered the PMB information. Delivery Point Validation Footnote 3 is a two-character code.
Note: The USPS groups DPV footnote information in a single string. To generate a complete DPV result
string, select the following ports:
156
•
Delivery Point Validation Confirmation
•
Delivery Point Validation Footnote 1
Chapter 10: Postal Carrier Certification Data Ports
•
Delivery Point Validation Footnote 2
•
Delivery Point Validation Footnote 3
Port Location
The following table provides the location and default precision of the Delivery Point Validation Footnote 3
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Delivery Point Validation Footnote 3 Output Codes
The following table describes the output codes for Delivery Point Validation Footnote 3:
Code
Description
RR
The input address is a CMRA, and the PMB indicator matches the reference data.
R1
The input address is a CMRA, and DPV processing changed the PMB indicator.
No data
The input address does not identify a CMRA.
Delivery Point Validation Footnote Complete
Output port that writes data from other Delivery Point Validation Footnote ports as a single string.
Delivery Point Validation Footnote Complete Usage
Select Delivery Point Validation Footnote Complete to write output data from the following ports as a single
string:
•
Delivery Point Validation Footnote 1
•
Delivery Point Validation Footnote 2
•
Delivery Point Validation Footnote 3
Port Location
The following table provides the location and default precision of the Delivery Point Validation Footnote
Complete port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
6
Delivery Point Validation Footnote Complete Output Codes
The Delivery Point Validation Footnote Complete output code is a six-character string that comprises the
aggregate output from Delivery Point Validation Footnote ports 1 through 3.
Delivery Point Validation Footnote Complete
157
The following table describes the output code "AAUIRR."
Code
Port Name
Description
AA
Delivery Point Validation Footnote
1
The address matches the USPS ZIP + 4 Code data.
UI
Delivery Point Validation Footnote
2
The input address matches a unique ZIP Code.
RR
Delivery Point Validation Footnote
3
The input address is a Commercial Mail Receiving Agent, and the
Private Mailbox indicator matches the reference data.
Delivery Service Locality
Output port that identifies the mail town associated with a delivery service address. Use the Delivery Service
Locality port with New Zealand address data.
When you create a New Zealand address that identifies a delivery service mailbox, you must include locality
or mail town data. New Zealand Post does not recognize province, region, district, or territory elements in a
delivery service elements.
To view Delivery Service Locality data, configure the Address Validator transformation to run in certified
mode.
Delivery Service Locality Usage
To add the locality or mail town to a New Zealand address, select the Delivery Service Locality port.
Port Location
The following table provides the location and default precision of the Delivery Service Locality port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
50
Delivery Service Locality Example
The following address contains data that the Address Validator transformation can parse to a Delivery
Service Locality port:
JOHN SMITH
PO BOX 17999
GREENLANE
AUCKLAND 1546
158
Chapter 10: Postal Carrier Certification Data Ports
The following table shows the Address Validator transformation ports that can create a formatted address for
the example:
Port
Data
Recipient Line 1
JOHN SMITH
Delivery Service Type
PO BOX
Delivery Service Number
17999
Building Name 1
GREENLANE
Delivery Service Locality
AUCKLAND
Postcode 1
1546
Note: The building name identifies the mail center that stores the PO Box mail.
Delivery Service Number
Output port that contains the delivery service number in a New Zealand address.
The delivery service number identifies the mailbox that receives mail items for the address. The mailbox
might be one of several delivery service mailboxes at the same location. For example, a postal center stores
several Post Office Box (PO Box) mailboxes.
Use Delivery Service ports to define an address in the format preferred by New Zealand Post. When you
create an address that identifies a delivery service mailbox, you must include locality or mail town data. New
Zealand Post does not recognize province, region, district, or territory elements in a delivery service
elements. Use the Delivery Service Type, Delivery Service Number, and Delivery Service Locality ports to
create the address in the correct format.
To view Delivery Service Number data, configure the Address Validator transformation to run in certified
mode.
Delivery Service Number Usage
To write the number of the delivery service mailbox to a separate port, Select Delivery Service Number.
Port Location
The following table provides the location and default precision of the Delivery Service Number port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
Delivery Service Number
159
Delivery Service Number Example
The following address contains data that the Address Validator transformation can parse to a Delivery
Service Number port:
JOHN SMITH
PRIVATE BAG 93899
NORTH SHORE CITY 0753
The following table shows the Address Validator transformation ports that can create a formatted address for
the example:
Port
Data
Recipient Line 1
JOHN SMITH
Delivery Service Type
PRIVATE BAG
Delivery Service Number
93899
Delivery Service Locality
NORTH SHORE CITY
Postcode 1
1546
Delivery Service Type
Output port that describes the type of mailbox in an address record that does not identify a street or rural
address. Use the Delivery Service Type port with New Zealand address data.
The types of delivery service mailbox include Post Office Box (PO Box), Community Mail Box (CMB), and
private bag. To view Delivery Service Type data, configure the Address Validator transformation to run in
certified mode.
Delivery Service Type Usage
To identify the type of delivery service mailbox in a New Zealand address, select the Delivery Service Type
port.
Port Location
The following table provides the location and default precision of the Delivery Service Type port:
160
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
30
Chapter 10: Postal Carrier Certification Data Ports
Delivery Service Type Output Codes
The following table describes the Delivery Service Type output codes:
Code
Description
Bag
Private bag.
A private bag stores mail in the same way as a PO Box
but can hold a larger number of mail items.
Box
PO Box.
CMB
Community Mail Box.
A community mail box is a type of PO Box available at
rural postal centers.
Counter
Counter delivery.
In counter delivery, customers collect mail over the
counter at a postal center. Poste restante is a form of
counter delivery.
Delivery Sequence File Second Generation No
Statistics Indicator
Output port that indicates whether the USPS considers an address to be valid but undeliverable.
The USPS provides the Delivery Sequence File (DSF) system to help organizations to identify deliverable
addresses. The DSF is a computerized file that contains all delivery point addresses served by the USPS,
with the exception of general delivery addresses. DSF2 is the second generation of this system. Address
validation validates an address against the DSF file if the address contains a Delivery Point Code.
Note: An address is considered "general delivery" if the addressee cannot receive mail at a physical mailbox.
General delivery addressees can collect mail at a USPS post office.
Delivery Sequence File Second Generation No Statistics Indicator Usage
Select Delivery Sequence File Second Generation No Statistics Indicator to identify addresses that the USPS
considers undeliverable for one of the following reasons:
•
The USPS has not yet established delivery to the address.
•
The customer receives mail as a part of mail forwarding service.
•
The postal carrier returns the mail undelivered.
Port Location
The following table provides the location and default precision of the Delivery Sequence File Second
Generation No Statistics Indicator port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Delivery Sequence File Second Generation No Statistics Indicator
161
Delivery Sequence File Second Generation No Statistics Indicator Output Codes
The following table describes the Delivery Sequence File Second Generation No Statistics Indicator output
codes:
Code
Description
Y
The DSF reference data identifies the address as undeliverable.
N
The DSF reference data does not identify the address as undeliverable.
[Blank]
The address was not passed to the DSF reference data.
Delivery Sequence File Second Generation Vacant
Indicator
Output port that indicates whether an address is inactive. The USPS may consider an address inactive if it is
unoccupied for 90 days.
The USPS provides the Delivery Sequence File (DSF) system to help organizations to identify deliverable
addresses. The DSF is a computerized file that contains all delivery point addresses served by the USPS,
with the exception of general delivery addresses. DSF2 is the second generation of this system.
Address validation validates an address against the DSF file if the address contains a valid Delivery Point
Code.
Note: An address is considered "general delivery" if the addressee cannot receive mail at a physical mailbox.
General delivery addressees can collect mail at a USPS post office.
Delivery Sequence File Second Generation Vacant Indicator Usage
Select Delivery Sequence File Second Generation Vacant Indicator to identify addresses that the USPS
considers undeliverable because the DSF2 file indicates that the address is unoccupied.
Port Location
The following table provides the location and default precision of the Delivery Sequence File Second
Generation Vacant Indicator port:
162
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Chapter 10: Postal Carrier Certification Data Ports
Delivery Sequence File Second Generation Vacant Indicator Output Codes
The following table describes the Delivery Sequence File Second Generation Vacant Indicator output codes:
Code
Description
Y
The USPS considers this address vacant.
N
The USPS does not consider this address vacant.
[Blank]
The address was not passed to the DSF reference data file.
ELOT Flag
Output port that indicates the order in which the mail delivery agent reads ELOT Sequence numbers.
ELOT sequence numbers run in ascending or descending order. The order depends on the direction in which
the delivery agent travels on the mail route. For example, a delivery agent can travel east or west from a mail
center. The first item in the mail bag when the agent travels east become the final item in the mail bag when
the agent travels west.
ELOT Flag Usage
Use the ELOT Flag data to prepare mail items for delivery after you add ELOT Sequence data to the mail
items. If the ELOT Flag data indicates that mail items are sequenced in ascending order, the agent who
delivers the mail starts with lowest-numbered mail item in the mail bag.
Port Location
The following table provides the location and default precision of the ELOT Flag port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
ELOT Flag Output Codes
The following table describes ELOT Flag output codes:
Code
Description
A
The ELOT Sequence numbers run in ascending order.
D
The ELOT Sequence numbers run in descending order.
ELOT Flag
163
ELOT Sequence
Output port that indicates the location of the mail item in the delivery sequence on the mail route.
The ELOT sequence indicates the order in which the mail carrier can deliver the items. The sequence
corresponds to the physical route that the carrier takes at street level. Mail carriers in the United States use
Enhanced Line of Travel (ELOT) data to organize mail items for delivery,
The ELOT Sequence port returns a four-digit number. When you add ELOT sequence numbers to a set of
mail items, the mail carrier can sort the mail items in numerical order. The code numbers indicate the order in
which the carrier will reach each address on the route.
ELOT Sequence Usage
Use ELOT Sequence to sort mail items in the order in which the mail carrier will deliver them on the mail
route.
Select the ELOT Flag port when you select the ELOT Sequence port. The ELOT Flag determines whether the
ELOT Sequence numbers run in ascending or descending order.
Port Location
The following table provides the location and default precision of the ELOT Sequence port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
4
ELOT Sequence Output Codes
The ELOT Sequence port writes a four-digit number as output.
An address does not have static ELOT Sequence number. The number depends on the list of addresses that
the mail carrier must deliver on a given day.
Early Warning System Return Code
Output port that indicates whether an address contains a street name that is part of a new development that
the address reference data does not yet recognize.
The United States Postal Service (USPS) Early Warning System (EWS) is a list of streets that are not yet
included in the reference data to ZIP+4 Code level. The list is incorporated in United States address
reference data to ensure that address validation does not dismiss newly completed streets or code them
inaccurately.
Early Warning System Return Code Usage
Select Early Warning System Return Code if you are concerned that an input address refers to a new street
that the primary United States address reference data does not recognize. If address validation does not
validate an address to ZIP+4 Code level, you can check the Early Warning System Return Code value and
determine whether the address may be too new for complete validation.
164
Chapter 10: Postal Carrier Certification Data Ports
Port Location
The following table provides the location and default precision of the Early Warning System Return Code
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Early Warning System Return Code Output Codes
The following table describes the Early Warning System Return Code output codes:
Code
Description
Y
The address appears in the USPS EWS list.
N
The address does not appear in the USPS EWS list.
[Blank]
The address was not passed to the USPS EWS list.
Exclude Flag
Output port that indicates if an address meets the accuracy standards of the Point of Call address accuracy
program of Canada Post.
Canada Post uses the Point of Call address accuracy program to certify that an address accurately identifies
a physical mailbox. Address validation software programs can use Point of Call address reference data to
identify addresses that Canada Post recognizes as deliverable to Point of Call standards.
The Point of Call address reference data does not cover all Canadian addresses. The Exclude Flag status of
an address does not indicate the SERP certification status.
Exclude Flag Usage
Select Exclude Flag to determine if an address is present in the Point of Call address accuracy reference
data. You provide the total number of excluded addresses on the Statement of Accuracy report you provide
to Canada Post.
Port Location
The following table provides the location and default precision of the Exclude Flag port:
Port Type
Port Group
Template Model
Precision
Output
Canada Specific
Basic
8
Exclude Flag
165
Exclude Flag Output Codes
The following table describes the Exclude Flag output codes:
Code
Description
EXCLUDED
The address is not present in the reference data that is used by the Point of Call
address reference data.
[Blank]
The address is present in the reference data that is used by the Point of Call
address reference data.
High Rise Default
Output port that indicates whether an address matches a high-rise record in the address reference data and
does not contain a unit identifier.
A high-rise address is located in a high-rise building, such as an apartment building. The United States Postal
Service (USPS) maintains tables of high-rise addresses that do not contain a unit identifier. The USPS
assigns a default unit value to these addresses.
High Rise Default provides the same information as the Suite Link Return Code port.
High Rise Default Usage
Select High Rise Default when you need to know if an address has all the data needed for delivery in a highrise building. An address without a unit number may still be deliverable, particularly if it has a ZIP+4 Code.
Review the output address records and calculate the number of High Rise Default or Rural Route Default
addresses they contain. A high number of High Rise Default or Rural Route Default addresses increases mail
delivery costs and slows down mail delivery.
Note: The High Rise Exact output port identifies high-rise addresses that contain unit identifiers.
Port Location
The following table provides the location and default precision of the High Rise Default port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
High Rise Default Output Codes
The following table describes the High Rise Default output codes:
166
Code
Description
Y
The address is present in the USPS High-Rise Default table.
N
The address is not present in the USPS High-Rise Default table.
Chapter 10: Postal Carrier Certification Data Ports
RELATED TOPICS:
•
“Default Flag” on page 149
•
“Rural Route Default ” on page 192
High Rise Exact
Output port that indicates whether an address matches a high-rise record in the address reference data and
also contains a unit identifier.
A high-rise address is located in a high-rise building, such as an apartment building. The USPS maintains
tables of high-rise addresses that contain a unit identifier.
High Rise Exact Usage
Select High Rise Exact to identify an address that has all the data needed for delivery in a high-rise building.
An address without a unit number may still be deliverable, particularly if it has a ZIP+4 Code.
Note: The High Rise Default output port identifies high-rise addresses that do not contain unit identifiers.
Port Location
The following table provides the location and default precision of the High Rise Exact port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
High Rise Exact Output Codes
The following table describes the High Rise Exact output codes:
Code
Description
Y
The address is present in the USPS High-Rise Exact table.
N
The address is not present in the USPS High-Rise Exact table.
Hygiene
Output port that indicates if the SendRight standards permit data cleansing operations on the address record.
Hygiene Usage
To identify addresses that you can cleanse without risk to SendRight certification, select the Hygiene port.
Note: Address validation returns no data to the Hygiene port. The SendRight standards defined by New
Zealand Post state that you cannot modify an address record that you submit for SendRight certification.
High Rise Exact
167
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
Hygiene Output Codes
The Hygiene port does not return data. You cannot perform data cleansing operations on a certified address.
Locatable Address Conversion System
Output port that indicates whether a United States address has been converted from a rural address format
to an urban format. The United States Postal Service (USPS) converts rural addresses so that emergency
services can find the addresses more easily.
The Address Validator transformation compares the address with the Locatable Address Conversion Service
(LACS) reference data. LACS data is part of the United States reference data set. If an address is in the
LACS database table, the USPS has created a new version of the address in the urban format.
An urban United States address has the following format:
Person or organization data
Building, sub-building, and street data
City, state, and ZIP Code data
Locatable Address Conversion System Usage
Select Locatable Address Conversion System to identify a rural address for which the USPS has created an
urban version.
If you select the Locatable Address Conversion System port, select the Locatable Address Conversion
System Link Return Code port.
Port Location
The following table provides the location and default precision of the Locatable Address Conversion System
port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Locatable Address Conversion System Output Codes
The following table shows the Locatable Address Conversion System output codes:
168
Code
Description
L
The address is present in the USPS LACS table.
[Blank]
The address is not present in the USPS LACS table.
Chapter 10: Postal Carrier Certification Data Ports
Locatable Address Conversion System Link Indicator
Output port that indicates if the Address Validator transformation checks the address against the Locatable
Address Conversion System (LACS) reference database.
The LACS reference data lists United States addresses that the United States Postal Service (USPS) has
converted from a rural format to the standard urban format. The USPS converts rural addresses so that
emergency services can find the addresses more easily.
Locatable Address Conversion System Link Indicator Usage
Select Locatable Address Conversion System Link Indicator to write an output value to an address that
indicates whether the address was checked against LACS reference data.
Port Location
The following table provides the location and default precision of the Locatable Address Conversion System
Link Indicator port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Locatable Address Conversion System Link Indicator Output Codes
The following table describes the Locatable Address Conversion System Link Indicator output codes:
Code
Description
Y
The address is checked against LACS reference data.
[Blank]
The address is not checked against LACS reference data.
Locatable Address Conversion System Link Return
Code
Output port that indicates the degree to which the input address matches Locatable Address Conversion
System (LACS) data and whether the address validation process updated the address.
Locatable Address Conversion System Link Return Code Usage
Select Locatable Address Conversion System Link Return Code to find more information about addresses
that match address records in the LACS reference database. If an address is in the LACS database, the
USPS has created a new version of the address.
If you select the Locatable Address Conversion System port, select the Locatable Address Conversion
System Link Return Code port. Review the Locatable Address Conversion System port output to identify
addresses that are contained in the LACS database.
Locatable Address Conversion System Link Indicator
169
Port Location
The following table provides the location and default precision of the Locatable Address Conversion System
Link Return Code port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Locatable Address Conversion System Link Return Code Output Codes
The following table shows the Locatable Address Conversion System Link Return Code output codes:
Code
Description
A
The United States address reference data provides an urban form of the address.
00
The United States address reference data does not provide an urban form of the
address.
14
The United States address reference recognizes the address as convertible to an
urban form, but it cannot provide the urban form of the address.
92
The input address matches an address in the address reference data, but the input
address contains a secondary number and the reference address does not.
[Blank]
The input address was not passed to the LACS reference database.
Lot Number
Output port that contains the lot number in an Australian address.
A lot is a unit of property. Australia Post assigns a lot number to a property when it cannot assign a street
number. For example, it may be impractical to apply street numbers to properties on a rural road. Lot
numbers and street numbers perform the same function in Australian addresses.
Lot Number Usage
Select Lot Number when an Australian address identifies a mailbox by lot number instead of street number.
To view lot number data, configure the Address Validator transformation to run in certified mode.
Port Location
The following table provides the location and default precision of the Lot Number port:
170
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
12
Chapter 10: Postal Carrier Certification Data Ports
Lot Number Example
The following example address identifies a property in Queensland, Australia:
MS. JANE BURKE
LOT 3 BEACH RD
SARINA QLD 4737
AUS
The following table shows the Address Validator transformation port that relates to lot number data in the
address:
Port Name
Data
Contact Complete 1
MS. JANE BURKE
Lot Number
LOT 3
Street Complete 1
BEACH RD
Locality Complete 1
SARINA
Province Abbreviation 1
QLD
Postcode 1
4737
Country ISO3 Char
AUS
National Address Management Service Status
Output port that indicates whether an output address meets the certification standard of the National Address
Management Service (SNA) of La Poste.
National Address Management Service Status Usage
Select National Address Management Service Status to verify that address records are valid to the SNA
standard. If the addresses you submit to La Poste meet the standard, you can qualify for mail discounts.
To comply with the SNA standard, the output address must follow a format that La Poste defines. Use the
Formatted Address Line ports to write the output address. The following table describes the format:
Output Port
Address Element Types
Formatted Address Line 1
Contact name
Formatted Address Line 2
Organization name or sub-building identifier
Formatted Address Line 3
Building name
Formatted Address Line 4
Street name with house number, or plot and
thoroughfare identifier
National Address Management Service Status
171
Output Port
Address Element Types
Formatted Address Line 5
Dependent locality name or delivery service identifier
Formatted Address Line 6
Post code and primary locality name and optional
CEDEX code
Use the following rules and guidelines when you validate an address to the SNA standard:
•
The Formatted Address Line 4 port and Formatted Address Line 6 port must contain data.
•
If the address does not contain a data element for a port, let the port remain empty. Do not move an
address element from one line to another line.
•
The address must not contain data on any line outside the formatted address structure.
•
Configure the Address Validator transformation to run in certified mode.
•
Set the Preferred Script property on the Address Validator transformation to Database or ASCII Simplified.
Port Location
The following table provides the location and default precision of the National Address Management Service
Status port:
Port Type
Port Group
Template Model
Precision
Output
France Specific
Basic
4
National Address Management Service Status Output Codes
The following table describes the National Address Management Service Status output codes:
Code
Description
ESN0
Address validation did not perform an SNA check on the address.
ESN1
Address validation corrected or validated the address to the SNA standard.
Postal Phrase Number Ports (AMAS)
See Postal Phrase Number Ports.
Postal Phrase Prefix
Output port that contains one or more characters that precede the mailbox number at a postal agency. Use
Postal Phrase Prefix with Australian address data.
Post Office Box (PO Box) data is the most common type of postal phrase data.
172
Chapter 10: Postal Carrier Certification Data Ports
Postal Phrase Prefix Usage
Select the Postal Phrase Prefix port when an address meets the following conditions:
•
The address identifies an Australian mailbox.
•
The address contains a postal phrase number, and you have selected the Postal Phrase Number port
from the Australia Specific group.
•
The address is part of a data set that you will submit for AMAS certification.
You can select the Postal Phrase Prefix port with postal phrase ports in the Discrete or Address Elements
groups.
To view postal phrase prefix data, configure the Address Validator transformation to run in certified mode.
Port Location
The following table provides the location and default precision of the Postal Phrase Prefix port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
3
Postal Phrase Prefix Example
The following example address identifies a mailbox property in the Australian Capital Territory (ACT):
MR. JAMES RYAN
PO BOX N2A
KINGSTON ACT 2604
AUS
The following table shows the Address Validator transformation ports that relate to postal phrase data in the
address:
Port
Data
Contact Complete 1
Mr. James Ryan
Postal Phrase Complete 1
PO BOX N2A
Postal Phrase Descriptor 1
PO BOX
Postal Phrase Prefix
N
Postal Phrase Number
00002
Postal Phrase Number 1
N2A
Postal Phrase Suffix
A
Locality Complete 1
KINGSTON
Province Abbreviation 1
ACT
Postcode 1
2604
Country ISO3 Char
AUS
Postal Phrase Prefix
173
Postal Phrase Suffix
Output port that contains one or more characters that follow the mailbox number at a postal agency. Use
Postal Phrase Suffix with Australian address data.
Post Office Box (PO Box) data is the most common type of postal phrase data.
Postal Phrase Suffix Usage
Select the Postal Phrase Suffix port when an address meets the following conditions:
•
The address identifies an Australian mailbox.
•
The address contains a postal phrase number, and you have selected the Postal Phrase Number port
from the Australia Specific group.
•
The address is part of a data set that you will submit for AMAS certification.
You can select the Postal Phrase Suffix port with postal phrase ports in the Discrete or Address Elements
groups.
To view postal phrase suffix data, configure the Address Validator transformation to run in certified mode.
Port Location
The following table provides the location and default precision of the Postal Phrase Suffix port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
3
Postal Phrase Suffix Example
The following example address identifies a mailbox property in the Australian Capital Territory (ACT):
MR. JAMES RYAN
PO BOX N2A
KINGSTON ACT 2604
AUS
The following table shows the Address Validator transformation ports that relate to postal phrase data in the
address:
174
Port
Data
Contact Complete 1
MR. JAMES RYAN
Postal Phrase Complete 1
PO BOX N2A
Postal Phrase Descriptor 1
PO BOX
Postal Phrase Prefix
N
Postal Phrase Number
00002
Postal Phrase Number 1
N2A
Postal Phrase Suffix
A
Locality Complete 1
KINGSTON
Chapter 10: Postal Carrier Certification Data Ports
Port
Data
Province Abbreviation 1
ACT
Postcode 1
2604
Country ISO3 Char
AUS
RD Number
Output port that identifies the delivery route for a rural address in New Zealand.
New Zealand Post defines urban and rural address formats. A rural address identifies a mailbox that is not
located in a city, town, or suburb. New Zealand Post uses Rural Delivery (RD) routes to organize mail to rural
mailboxes. Each route has a unique RD number within a postal district.
RD Number Usage
To identify the rural delivery route for a New Zealand address, select RD Number.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
RD Number Alpha Example
The following address contains data that can populate the RD Number port:
BRIAN HILLS
220A LYNWOOD AVENUE
RD 1
OTAKI 5581
The following table shows the ports that relate to rural delivery number data in the address:
Port Name
Data
Recipient Line 1
BRIAN HILLS
House Number Alpha
220A
Street Name 1
LYNWOOD AVENUE
RD Number
RD 1
Locality Name 1
OTAKI
Postcode 1
5581
RD Number
175
Residential Delivery Indicator
Output port that indicates if a United States address identifies a residence or a business.
The Address Validator transformation uses a subset of the Coding Accuracy Support System (CASS)
reference data files to identify residential addresses. If the reference data files contain ZIP+4 code data for
an address, the transformation recognizes the address as a residence. You do not need to identify a mail
item as residential or business to qualify for CASS discounts.
Residential Delivery Indicator Usage
Select Residential Delivery Indicator to identify residential or business addresses. The port writes the result
to the address record.
Most mail carriers charge less to deliver business mail. If you separate residential mail from business mail,
you can send the business mail by a different method and reduce mail costs.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Residential Delivery Indicator Output Codes
The following table describes the Residential Delivery Indicator output codes:
Code
Description
Y
The residential data files contain the ZIP+4 code for the address. Address
validation recognizes the address as a residence.
N
The residential data files do not contain the ZIP+4 code for the address. Address
validation recognizes the address as a business.
SendRight Status
Output port that indicates whether a New Zealand address contains the necessary data for validation to the
SendRight standard.
SendRight is the address certification program maintained by New Zealand Post. If an address identifies a
mailbox to delivery point level, it meets the SendRight standard.
To confirm the SendRight status of an address, configure the Address Validator transformation to run in
certified mode.
SendRight Status Usage
To verify that address records meets the SendRight standard, select SendRight Status.
When an address meets the standard, the address validation process can add data to the address that
improves deliverability. New Zealand Post offers reduced postal rates to organizations that validate address
records to the SendRight standard.
176
Chapter 10: Postal Carrier Certification Data Ports
Note: New Zealand Post does not permit the validation process to correct input address data during
SendRight certification. Use the Match Code port to verify that the validation process does not correct the
data. If the Match Code returns values in the range C1 through C4, you must run the validation process
again. First, run the process in Batch mode to correct the records. Then run the process in certified mode to
verify that the addresses meet the SendRight standard without correction.
Port Location
The following table provides the location and default precision of the SendRight Status port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
4
SendRight Status Output Codes
The following table describes the SendRight Status output codes:
Code
Description
ESR0
SendRight data is not available for the address.
ESR1
SendRight data is available for the address.
A code of ESR1 indicates that the address meets the SendRight standard and the address validation process
can add SendRight data to the address record.
Software Evaluation And Recognition Program
Status
Output port that indicates whether an output address record contains the data required for address validation
to SERP standards.
The Software Evaluation and Recognition Program (SERP) is a Canada Post standards mechanism that
certifies the completeness and accuracy of an address. When you validate addresses with the Address
Validator transformation, the validation process uses Canadian reference data to enhance or complete an
address, so that a SERP-certified address is both complete and accurate to Canada Post standards.
The Software Evaluation And Recognition Program Status value indicates if the address is eligible for
validation to the SERP standard. It does not indicate the quality or deliverability of the address.
Software Evaluation And Recognition Program Status Usage
Select Software Evaluation And Recognition Program Status to verify that output address records contain all
data required for address validation to the SERP standard.. If the addresses are valid to the level set by the
Canada Post, your organization can qualify for bulk mailing discounts.
Prerequisites
Verify that you have set the following prerequisites for Software Evaluation And Recognition Program Status:
•
Configure the Address Validator transformation to run in certified mode.
Software Evaluation And Recognition Program Status
177
•
Enable SERPEnrichment for the Content Management Service.
Port Locations
The following table provides the location and default precision of the Software Evaluation And Recognition
Program Status port:
Port Type
Port Group
Template Model
Precision
Output
Canada Specific
Basic
4
Software Evaluation And Recognition Program Status Output Codes
The following table describes the SERP output codes:
Code
Description
ESE0
The address does not contain enough data for SERP certification.
Software Evaluation And Recognition Program Status also returns ESE0 if
you do not configure the Address Validator transformation in certified
mode.
ESE1
The address contains enough data for SERP certification.
SOA Record Ignored
Output port that indicates if the address is eligible for inclusion in Statement of Accuracy (SOA) calculations
for New Zealand Post.
When you submit an address record set to New Zealand Post, you indicate the number of records that meet
the SendRight validation standard. To qualify for SendRight mail charges, 85 percent of the address records
must meet the standard. Use the SOA Record Ignored port to identify records that you cannot count among
the records that meet the SendRight standard.
Note: Some valid addresses do not qualify for SendRight certification. The SendRight standard requires an
address to uniquely identify a physical mailbox at which an addressee can receive mail. The address must
conform to the data stored by New Zealand Post in its Postal Address File (PAF).
SOA Record Ignored Usage
To count the records in a record set that meet the SendRight standard, select SOA Record Ignored
The SOA Record Ignored port identifies the following address types as ineligible for SendRight certification:
178
•
Poste restante
•
Mail addressed to a private bag
Chapter 10: Postal Carrier Certification Data Ports
Port Locations
The following table provides the location and default precision of the SOA Record Ignored port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
SOA Record Ignored Output Codes
The following table describes SOA Record Ignored output codes:
Code
Description
[blank]
The address record can be included in the Statement of Accuracy calculations.
Y
The address record cannot be included in the Statement of Accuracy calculations.
Address validation returns Y when it finds an address that you cannot include in the Statement of Accuracy.
Otherwise, Address validation does not return a value on the port.
Street Number Ports (AMAS)
See Street Number Ports.
Suite Link Return Code
Output port that identifies high-rise business addresses in the United States that lack suite identification
information.
Suitelink is a United States Postal Service (USPS) database of business addresses that are located in highrise buildings and that lack suite information. The USPS requires this information in CASS-certified
addresses.
Suite Link Return Code Usage
Select Suite Link Return Code to identify addresses that do not contain the suite information that the USPS
requires for Coding Accuracy Support System (CASS) certification.
Note: Suite Link Return Code provides the same information as the High Rise Default port.
Port Location
The following table provides the location and default precision of the Suite Link Return Code port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
2
Street Number Ports (AMAS)
179
Suite Link Return Code Output Codes
The following table describes the Suite Link Return Code output codes:
Code
Description
00
The address does not match an address in the Suitelink reference data.
A
The address matches an address in the Suitelink reference data.
[Blank]
The address was not passed to the Suitelink reference data.
Validity Code
Output port that summarizes the result of an address validation process on a New Zealand address.
The Validity Code output indicates the level of similarity between an address record and the addresses
defined in the New Zealand address reference data. Use the output as a high-level measure of the validity of
the address. For example, if the input address is a unique match with an address defined in the reference
data, the address is a candidate for SendRight certification.
Validity Code Usage
Select Validity Code to add a summary indicator of address validity to the address record.
Port Location
The following table provides the location and default precision of the port:
Port Type
Port Group
Template Model
Precision
Output
New Zealand Specific
Basic
20
Validity Code Output Codes
The following table describes the output codes for the Validity Code port:
Code
Description
VALID-U
The address reference data can provide an identical
address to delivery point level.
VALID-B
The address reference data contains an address that
matches the address record but cannot verify delivery
point data for the address.
Note: For urban addresses, verify that the address
contains street number data. For rural addresses,
verify that the address contains a rural delivery
identifier.
INVALID
180
Chapter 10: Postal Carrier Certification Data Ports
The address reference data does not contain a match
for the address record.
Zip Move Return Code
Output port that indicates if the United States Postal Service (USPS) has recently changed the ZIP+4 Code
assigned to the address.
The USPS maintains a database of addresses with changed ZIP Codes. Address validation passes an
address as deliverable to a prior ZIP Code if the address data is present in the USPS ZIPMOVE database.
Zip Move Return Code Usage
Select Zip Move Return Code to identify addresses with ZIP+4 Codes that the USPS changed recently. Use
this data to verify that an address is deliverable even if its ZIP Code is out-of-date.
Port Location
The following table provides the location and default precision of the Zip Move Return Code port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Zip Move Return Code Output Codes
The following table describes the Zip Move Return Code output codes:
Code
Description
Y
The address matches an address in the USPS ZIPMOVE reference data.
N
The address does not match an address in the USPS ZIPMOVE reference
data.
[Blank]
The address was not passed to the USPS ZIPMOVE reference data.
Zip Move Return Code
181
CHAPTER 11
Postcode Data Ports
This chapter includes the following topics:
•
Postcode Ports Overview, 182
•
Postal Address Code AT, 183
•
Postal Address Code RS, 184
•
Postal Code Extension, 185
•
Postcode Ports, 186
•
Postcode Add On , 187
•
Postcode Base, 188
•
Postcode Complete , 189
•
Postcode Formatted Ports, 190
•
Postcode Unformatted Ports, 191
•
Rural Route Default , 192
•
Rural Route Exact , 193
Postcode Ports Overview
The Address Validator transformation provides multiple ports that can contain post code ports. Select the
post code ports that suit the input data structure and your output data requirements.
Consider the following factors when you select a post code port:
•
The Postcode, Postcode Complete, and Postcode Formatted ports contain all post code data. The
Postcode, Postcode Complete, and Postcode Formatted output ports format the data according to the
punctuation standards of the national mail carrier.
•
The Postcode Base and Postcode Add On ports are designed for ZIP+4 Code data. The Postcode Base
port contains the five-digit ZIP Code. The Postcode Add On port contains the four-digit suffix.
•
The Postcode Unformatted ports contain post code data with character spaces and dashes removed.
When you select post code input ports, verify that the ports do not contain duplicate data for an address. For
example, if the data set contains formatted data and unformatted post code data in different fields, do not
select both as inputs.
182
Postal Address Code AT
Output port that contains building-level post code data for an Austrian address. The postal address code
supplements the regular post code data that the Austrian postal service recognizes.
The Austrian postal service uses a four-digit post code to identify the territory that a post office serves. All
addresses in a territory have a common post code. The postal address code for an Austrian address contains
nine digits and identifies the building that contains the address mailbox.
Postal Address Code AT Usage
The postal address code identifies the building that contains the address mailbox. To write the postal address
code to an Austrian address, select the Postal Address Code AT output port.
Port Locations
The following table provides the location and default precision of the Postal Address Code AT port:
Port Type
Port Group
Template Model
Precision
Output
AT Supplementary
Basic
9
Postal Address Code AT Example
The following address has a Postal Address Code AT value of 105176447:
Thomas Schüssel
Plättenstraße 7
2380 Perchtoldsdorf
Niederösterreich
The following table shows the Address Validator transformation ports that relate to the post code data in the
address:
Port Name
Data
Contact Complete 1
Thomas Schüssel
Street Number Complete 1
7
Street Complete 1
Plättenstraße
Postcode 1
2380
Locality Complete 1
Perchtoldsdorf
Province Country Standard 1
Niederösterreich
Postal Address Code AT
105176447
Country ISO3 Char
AUT
Postal Address Code AT
183
Postal Address Code RS
Output port that contains street-level post code data for a Serbian address. The postal address code
supplements the locality post code data that Post Serbia recognizes for a Serbian address.
The postal address code for a Serbian address contains six digits. Post Serbia places the prefix PAK before
the postal address code. The Address Validator transformation omits the prefix from the Postal Address Code
RS port.
Postal Address Code RS Usage
The postal address code identifies the street that contains the address mailbox. To write the postal address
code to a Serbian address, select the Postal Address Code RS output port.
When you select Postal Address Code RS, also select a port that can contain general post code data from
Post Serbia. For example, select the Postcode Base port when you select the Postal Address Code RS port.
Port Location
The following table provides the location and default precision of the Postal Address Code RS port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
6
Output
RS Supplementary
Basic
6
Postal Address Code RS Example
The following address has a Postal Address Code RS value of 456769:
Petar Petrovic
Beogradska 3
Bajmok
24210
Serbia
The following table shows the Address Validator transformation ports that relate to postal address code data:
184
Port Name
Data
Contact Complete 1
Petar Petrovic
Street Number Complete 1
3
Street Complete 1
Beogradska
Postcode 1
24210
Locality Complete 1
Bajmok
Postal Address Code RS
456769
Country ISO3 Char
SRB
Chapter 11: Postcode Data Ports
Postal Code Extension
Output port that contains a two-digit suffix for the post code of a Swiss address.
Swiss Post uses a four-digit post code to identify the territory that a post office serves. All addresses in a
territory have a common post code. The postal code extension identifies subdivisions in each post office
territory.
Postal Code Extension Usage
To write the postal code extension to a Swiss address, select the Postal Code Extension output port.
Port Locations
The following table provides the location and default precision of the Postal Code Extension port:
Port Type
Port Group
Template Model
Precision
Output
CH Supplementary
Basic
2
Postal Code Extension Example
The following example address contains data that can populate the Postal Code Extension port:
Joseph Maurer
Hohlen 1
3800 Sundlauenen
Switzerland
The following table shows the Address Validator transformation ports that relate to the post code data in the
address:
Port Name
Data
Contact Complete 1
Joseph Maurer
Street Number Complete 1
1
Street Complete 1
Hohlen
Postcode 1
3800
Locality Complete 1
Sundlauenen
Province Extended 1
Bern
Postal Code Extension
05
Country ISO3 Char
CHE
Postal Code Extension
185
Postcode Ports
Input and output ports that contain the complete post code for an address.
Postcode, Postcode Complete, and Postcode Formatted contain the same data.
Postcode Usage
Select a Postcode input port when the input address data set has a single post code port.
Select a Postcode output port to write the post code to an output port in a data set that uses one port for all
post code data.
Port Locations
The following table provides the location and default precision of the Postcode 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
15
Input
Hybrid
Basic
15
Output
Last Line Elements
Basic
10
The following table provides the location and default precision of the Postcode 2 port:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Basic
5
Note: The default precision values on a post code port can change between input and output. Verify that the
input and output port precision can contain the post code data in the data set when you select post code
ports.
Postcode Example
The following example address contains data that the Address Validator transformation can parse to post
code ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
The following table shows the Address Validator transformation ports that relate to post code data in the
address:
186
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Chapter 11: Postcode Data Ports
Port
Data
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode 1
10028-0198
Postcode Add On
Output port that contains the final four digits of a United States ZIP+4 Code.
Postcode Add On Usage
Select Postcode Add On when you select Postcode Base.
Select a Postcode Base input port when the input data set contains the five-digit ZIP Code and the four-digit
ZIP+4 Code suffix in different ports.
Select a Postcode Base output port to write the five-digit ZIP Code and the four-digit ZIP+4 Code suffix to
different ports.
Port Locations
The following table provides the location and default precision of the Postcode Add On 2 and Postcode Add
On 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Advanced
10
Postcode Add On Example
The following example address contains data that the Address Validator transformation can parse to post
code ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
The following table shows the Address Validator transformation ports that relate to post code data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Postcode Add On
187
Port
Data
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Complete 1
10028-0198
Postcode Base 2
10028
Postcode Add On 2
0198
Postcode Base
Output port that contains the base post code data for an address. In the United States, the Postcode Base
port contains the five-digit ZIP Code.
Postcode Base Usage
Select a Postcode Base output port to write the base post code to a single port. For example, select the
Postcode Base output port to write the five-digit ZIP Code for a United States address. When you select
Postcode Base, select the Postcode Add On port to add the four-digit ZIP Code suffix to the address.
Port Locations
The following table provides the location and default precision of the Postcode Base 1 port:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Basic
10
The following table provides the location and default precision of the Postcode Base 2 and Postcode Base 3
ports:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Advanced
10
Postcode Base Example
The following example address contains data that the Address Validator transformation can parse to post
code ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
188
Chapter 11: Postcode Data Ports
The following table shows the Address Validator transformation ports that relate to post code data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Complete 1
10028-0198
Postcode Base 2
10028
Postcode Add On 2
0198
Postcode Complete
Output port that contains the complete post code for an address.
Postcode, Postcode Complete, and Postcode Formatted contain the same data.
Postcode Complete Usage
Select Postcode Complete to write the complete post code as an output in cases where you also write post
code data to Postcode Base and Postcode Add On ports.
Port Location
The following table provides the location and default precision of the Postcode Complete port:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Basic
15
Postcode Complete Example
The following sample address contains data that the Address Validator transformation can parse to post code
ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
Postcode Complete
189
The following table describes the Address Validator transformation ports that relate to post code data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Complete 1
10028-0198
Postcode Formatted Ports
Input and output ports that contain the complete post code formatted to national mail carrier standards.
Postcode, Postcode Complete, and Postcode Formatted contain the same data.
Postcode Formatted Usage
Select a Postcode Formatted input port when the input data set contains a post code that is complete and
formatted to mail carrier standards.
Select a Postcode Formatted output port to write a correctly formatted complete post code to the output
address.
Port Locations
The following table provides the location and default precision of the Postcode Formatted 2 and Postcode
Formatted 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
15
Postcode Formatted Example
The following example address contains data that the Address Validator transformation can parse to post
code ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
190
Chapter 11: Postcode Data Ports
The following table shows the Address Validator transformation ports that relate to post code data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Formatted 2
10028-0198
Postcode Unformatted 1
100280198
Postcode Unformatted Ports
Input and output ports that contain the complete post code as a single string with no punctuation or character
spaces.
Postcode Unformatted Usage
Select a Postcode Unformatted input port when the input data set contains a complete and unformatted post
code that is formatted to mail carrier standards.
Select a Postcode Unformatted output port to write a complete post code to the output address as a single
string.
Port Locations
The following table provides the location and default precision of ports Postcode Unformatted 1 through
Postcode Unformatted 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
15
Postcode Unformatted Example
The following example address contains data that the Address Validator transformation can parse to post
code ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
Postcode Unformatted Ports
191
NY
10028-0198
The following table shows the Address Validator transformation ports that relate to post code data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Complete 1
10028-0198
Postcode Unformatted 1
100280198
Rural Route Default
Output port that indicates if the address is a valid rural route but exact data is unavailable.
Rural Route Default Usage
Select Rural Route Default when you need to know if an address has all the data needed for delivery on a
rural route.
You can use Rural Route Exact port data with Rural Route Default port data. The Rural Route Default port
indicates if rural route data is complete.
Review the output data and calculate the number of High Rise Default or Rural Route Default addresses it
contains. A high number of High Rise Default or Rural Route Default addresses increases mail delivery costs
and slows down mail delivery.
Port Locations
The following table provides the location and default precision of the Rural Route Default port:
192
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Chapter 11: Postcode Data Ports
Rural Route Default Output Codes
The following table describes the Rural Route Default output codes:
Code
Description
Y
The address matches a rural route address in the address reference data but does not contain a box
number.
N
All other options. The address may match a rural route address and contain a box number, or the
address may not match a rural route address, or the address was not checked against the rural route
reference data.
RELATED TOPICS:
•
“Default Flag” on page 149
•
“High Rise Default ” on page 166
Rural Route Exact
Output port that indicates if the address matches a rural route address in the USPS address reference data
set.
Rural Route Exact Usage
Select Rural Route Default to determine if an address has all the data required for delivery on a rural route.
You can use Rural Route Exact port data with Rural Route Default port data. The Rural Route Default port
indicates if rural route data is complete.
Review the output data and calculate the number of High Rise Default and Rural Route Default addresses it
contains. A high number of High Rise Default or Rural Route Default addresses increases mail delivery costs
and slows down mail delivery.
Port Locations
The following table provides the location and default precision of the Rural Route Exact port:
Port Type
Port Group
Template Model
Precision
Output
US Specific
Basic
1
Rural Route Exact Output Codes
The following table describes the Rural Route Exact output codes:
Code
Description
Y
The address matches a rural route address in the address reference data.
N
The address does not match a rural route address in the address reference data, or the address was not
checked against the rural route reference data.
Rural Route Exact
193
CHAPTER 12
Province and State Data Ports
This chapter includes the following topics:
•
Province Ports, 194
•
Province Abbreviation Ports, 196
•
Province Extended Ports, 197
•
Province Country Standard Ports, 199
•
Province ISO Ports, 200
Province Ports
Input ports that read province data from an address record set.
In address validation, a province is the largest political or administrative division in a country. For example,
address validation identfies a state in the United States, a province in Canada, and a canton in Switzerland
as provinces.
A Province port can read the full province name or the abbreviated name.
Province Usage
Select a Province port to read data that identifies the highest level of territory or region in a country, such as
a state of the United States, from the input address data set.
Consider the following guidelines when you use Province ports:
194
•
There are six Province ports. Use Province 1 to identify the province. Use Province 2 to identify the
primary subdivision in the province. For example, use Province 2 for county data in the United States. You
may need to select a port in the Province 3 through Province 6 range if the province data is highly
complex.
•
The mail carrier may not require the sub-province data. Or, you may configure sub-province level data on
a locality port.
Port Locations
The following table provides the location and default precision of the Province 1 through Province 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Input
Hybrid
Basic
50
The following table provides the location and default precision of the Province 4 through Province 6 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Province Example
The following example address contains data that the Address Validator transformation can parse to province
data ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
The following table shows an address that uses province data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province 1
NY
Postcode Complete 1
10028-0198
Country ISO3 Char
USA
Province Ports
195
Province Abbreviation Ports
Input and output ports that contain the abbreviated province name.
In address validation, a province is the largest political or administrative division in a country. For example,
address validation identifies a state in the United States, a province in Canada, and a canton in Switzerland
as provinces.
Province Abbreviation Usage
Select a Province Abbreviation input port to read the province abbreviation from the input address data.
Select a Province Abbreviation output port to write the province abbreviation to the output address.
Consider the following guidelines when you use Province Abbreviation ports:
•
There are six Province Abbreviation ports. Use Province Abbreviation 1 to identify the province. Use
Province Abbreviation 2 to identify the primary subdivision in the province. For example, use Province
Abbreviation 2 for county data in the United States. You may need to select a port in the Province
Abbreviation 3 throughProvince Abbreviation 6 range if the province data is highly complex.
•
The Province Abbreviation 1 output port contains the same data as the Province Country Standard 1
output port for a United States address. Both ports return the two-letter state code.
•
The mail carrier may not require the sub-province data. Or, you may configure sub-province level data on
a locality port.
Note: The Province Abbreviation 2 output port does not abbreviate United States county data.
Port Locations
The following table provides the location and default precision of ports Province Abbreviation 1 through
Province Abbreviation 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Basic
25
The following table provides the location and default precision of ports Province Abbreviation 4 through
Province Abbreviation 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
15
Province Abbreviation Example
The following example address contains data that the Address Validator transformation can parse to province
data ports:
Mr. John Doe
1000 Fifth Avenue
196
Chapter 12: Province and State Data Ports
# 12
New York
NY
10028-0198
The following table shows an address that uses province data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Abbreviation 1
NY
Postcode Complete 1
10028-0198
Country ISO3 Char
USA
Province Extended Ports
Input and output ports that contain the full name of the province.
In address validation, a province is the largest political or administrative division in a country. For example,
address validation identfies a state in the United States, a province in Canada, and a canton in Switzerland
as provinces.
Province Extended Usage
Select Province Extended to write the complete province name to the output address record.
Consider the following guidelines when you use Province Extended ports:
•
There are six Province Extended ports. Use Province Extended 1 for the full province name. Use Province
Extended 2 for the full name of the primary subdivision in the province. For example, use Province
Extended 2 for county data in the United States. You may need to select a port in the Province Extended
3 through Province Extended 6 range if the province data is highly complex.
•
The complete province name may not be required in the address. For example, in United States
addresses, the USPS requires addresses to use the two-letter abbreviation for the state name. Use the
Province Country Standard port to write the required province abbreviation.
•
The mail carrier may not require the sub-province data. Or, you may configure sub-province level data on
a locality port.
Province Extended Ports
197
Port Locations
The following table provides the location and default precision of ports Province Extended 1 through Province
Extended 3:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Basic
50
The following table provides the location and default precision of ports Province Extended 4 through Province
Extended 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Input
Hybrid
Advanced
50
Output
Last Line Elements
Advanced
50
Province Extended Example
The following example address contains data that the Address Validator transformation can parse to province
data ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
The following table shows an address that uses province data:
198
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Extended 1
New York
Postcode Complete 1
10028-0198
Country ISO3 Char
USA
Chapter 12: Province and State Data Ports
Province Country Standard Ports
Output ports that contain the province name in the form that the national mail carrier prefers.
In address validation, a province is the largest political or administrative division in a country. For example,
address validation identfies a state in the United States, a province in Canada, and a canton in Switzerland
as provinces.
The Province Country Standard port follows the standard of the national mail carrier in the destination
country. For example, the United States Postal Service (USPS) standard requires a two-letter state name
abbreviation. The Deutsche Post standard requires the full province name.
Province Country Standard Usage
Select a Province Country Standard output port to write province data to the output address in the form that
the mail carrier prefers.
Consider the following guidelines when you use Province Country Standard ports:
•
There are six Province Country Standard ports. Use Province Country Standard 1 to identify the province.
Use Province Country Standard 2 to identify the primary subdivision in the province. For example, use
Province Country Standard 2 for county data in the United States. You may need to select a port in the
Province Country Standard 3 through Province Country Standard 6 range if the province data is highly
complex.
•
The mail carrier may not require the sub-province data. Or, you may configure sub-province level data on
a locality port.
Port Locations
The following table provides the location and default precision of the Province Country Standard 1 to
Province Country Standard 3 ports:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Basic
50
The following table provides the location and default precision of the Province Country Standard 4 to
Province Country Standard 6 ports:
Port Type
Port Group
Template Model
Precision
Output
Last Line Elements
Advanced
50
Province Country Standard Example
The following example address contains data that the Address Validator transformation can parse to province
data ports:
Mr. John Doe
1000 Fifth Avenue
# 12
New York
NY
10028-0198
Province Country Standard Ports
199
The following table shows an address that uses province data:
Port
Data
Contact Complete 1
Mr. John Doe
Street Number Complete 1
1000
Street Complete 1
Fifth Avenue
Sub-building Complete 1
#12
Locality Complete 1
New York
Province Country Standard 1
NY
Postcode Complete 1
10028-0198
Country ISO3 Char
USA
Province ISO Ports
Input and output ports that identify the province in which an address is located. The ports read or write the
province identifier that the International Organization for Standardization (ISO) defines in the ISO 3166-2
standard.
In address validation, a province is the largest political or administrative division in a country. For example,
address validation identifies a state in the United States, a province in Canada, and a canton in Switzerland
as provinces.
Province ISO Usage
To read or write the province ISO 3166-2 code for the province, select a Province ISO port.
Consider the following guidelines when you use Province ports:
•
There are three Province ISO input ports and six Province ISO output ports. Use Province ISO 1 to
identify the province or region defined at the highest level in the country, such as a state in the United
States of America. Use Province ISO 2 to identify a subdivision of the province if the ISO 3166-2 standard
records the subdivision.
•
The ISO 3166-2 standard defines provinces at multiple levels in some countries. Use Province ISO 1 to
identify the largest political region. For example, the standard defines code values at regional and
provincial level in the Philippines. In this case, use Province ISO 1 to identify the regions and Province
ISO 2 to identify the provinces. In the Philippines, a region contains multiple provinces.
Note: The ISO 3166-2 standard does not identify state subdivisions in the United States. Use the Province
Abbreviation 2 port to identify United States county names.
200
Chapter 12: Province and State Data Ports
Port Locations
The following table provides the location and default precision of the Province 1 through Province 3 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
3
Output
Last Line Elements
Basic
50
The following table provides the location and default precision of the Province 4 through Province 6 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
3
Input
Last Line Elements
Advanced
50
Province ISO Example
The ISO 3166-2 standard uses two coded values to uniquely identify a province. The first value identifies the
country and the second value identifies the province. The province values can use letters or numbers and
can have up to three characters.
For example. the following values identify New York state in the United States:
US-NY
The Province ISO ports contain the province values only. The ISO also tracks the country identification codes
in the 3166-1 specification.
You can view a list of ISO 3166-2 codes on the following site:
http://www.iso.org/iso/country_codes
Province ISO Ports
201
CHAPTER 13
Residual Data Ports
This chapter includes the following topics:
•
Residue Ports, 202
•
Residue Superfluous Ports, 203
•
Residue Unrecognized Ports, 205
Residue Ports
Input and output ports that contain data that an address parsing operation determines to be duplicate or
redundant data.
The Address Validator transformation attempts to parse all input data to an output ports that are relevant to
the address. The transformation takes into account the position of the data in the input address and whether
any element is missing from the address.
If the Address Validator transformation finds duplicate or redundant data elements, it writes them to one of
the residue data ports. The port that the transformation uses for residue data depends on the mode that you
set for the transformation:
•
Parsing mode. The Address Validator transformation writes duplicate or redundant data to the Residue
output port.
•
Batch, certified, suggestion list, or interactive mode. The Address Validator transformation writes duplicate
or redundant data to the Residue Superfluous output port.
Residue Usage
Select a Residue input port if you identify a data column that contains duplicate or redundant data before you
run an address parsing process.
Select a Residue output port to write as output any duplicate or redundant data that the parsing process
identified.
Consider the following guideline when you use Residue ports:
•
202
There are six Residue ports. You may need to select more than one Residue port if your data is highly
complex.
Port Locations
The following table provides the location and default precision of ports Residue 1 through Residue 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Residue
Basic
128
Residue Example
The following address contains data that the Address Validator transformation may write to a residue data
port:
36 Peckett Square
Highbury Grange
London
London
N5 2PB
GBR
The following table shows the Address Validator transformation ports that contain residue data following a
parsing operation:
Data
Port
Building Number Complete2
36
Street Complete 1
Highbury Grange
Street Complete 2
Peckett Square
Locality Name 1
London
Postcode 1
N5 2PB
Country ISO3 Char
GBR
Residue 1
London
Residue Superfluous Ports
Input and output ports that contain data that an address validation operation determines to be duplicate or
redundant data.
The Address Validator transformation attempts to parse all input data to an output ports that are relevant to
the address. The transformation takes into account the position of the data in the input address and whether
any element is missing from the address.
Residue Superfluous Ports
203
If the Address Validator transformation finds duplicate or redundant data elements, it writes them to one of
the residue data ports. The port that the transformation uses for residue data depends on the mode that you
set for the transformation:
•
Parsing mode. The Address Validator transformation writes duplicate or redundant data to the Residue
port.
•
Batch, certified, suggestion list, or interactive mode. The Address Validator transformation writes duplicate
or redundant data to the Residue Superfluous output port.
Residue Superfluous Usage
Select a Residue Superfluous input port if you identify a data column that contains duplicate or redundant
data before you run an address validation process.
Select a Residue Superfluous output port to write as output any duplicate or redundant data that the
validation process identified.
Consider the following guideline when you use Residue Superfluous ports:
•
There are six Residue Superfluous ports. You may need to select more than one Residue Superfluous
port if your data is highly complex.
Port Locations
The following table provides the location and default precision of ports Residue Superfluous 1 through
Residue Superfluous 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Residue
Advanced
128
Residue Superfluous Example
The following address contains data that the Address Validator transformation may write to a residue data
port:
36 Peckett Square
Highbury Grange
London
London
N5 2PB
GBR
The following table shows the Address Validator transformation ports that contain residue data following a
validation operation:
204
Data
Port
Building Number Complete2
36
Street Complete 1
Highbury Grange
Street Complete 2
Peckett Square
Locality Name 1
London
Postcode 1
N5 2PB
Chapter 13: Residual Data Ports
Data
Port
Country ISO3 Char
GBR
Residue Superfluous 1
London
Residue Unrecognized Ports
Output port that contains data that the Address Validator transformation cannot parse to an address data
port.
The Address Validator transformation does not populate the Residue Unrecognized port under normal
circumstances.
The transformation attempts to parse all input data to an output ports that are relevant to the address. The
transformation takes into account the position of the data in the input address and whether any element is
missing from the address.
If the Address Validator transformation finds duplicate or redundant data elements, it writes them to one of
the residue ports. The port that the transformation uses for residue data depends on the mode that you set
for the transformation:
•
Parsing mode. The Address Validator transformation writes duplicate or redundant data to the Residue
port.
•
Batch, certified, suggestion list, or interactive mode. The Address Validator transformation writes duplicate
or redundant data to the Residue Superfluous port as part of the validation process.
Residue Unrecognized Usage
Select Residue Unrecognized if your output address is missing one or more data elements and you selected
all address ports that are relevant to the address structure.
Before you select Residue Unrecognized, select one or more Residue or Residue Superfluous output ports.
The Address Validator transformation is likely to populate a Residue or Residue Superfluous port instead of a
Residue Unrecognized port.
Select Residue if you configured the Address Validation transformation in parsing mode.
Select Residue Superfluous if you configured the Address Validation transformation in batch, certified,
suggestion list, or interactive mode.
Consider the following guideline when you use Residue Unrecognized ports:
•
There are six Residue Unrecognized ports. You may need to select more than one Residue Unrecognized
port if your data is highly complex.
Port Locations
The following table provides the location and default precision of ports Residue Unrecognized 1 through
Residue Unrecognized 6:
Port Type
Port Group
Template Model
Precision
Output
Residue
Advanced
128
Residue Unrecognized Ports
205
CHAPTER 14
Street Data Ports
This chapter includes the following topics:
•
Street Additional Info Ports, 206
•
Street Complete Ports, 207
•
Street Complete with Number Ports, 209
•
Street Identifier DE, 211
•
Street Name Ports, 212
•
Street Number Ports, 214
•
Street Number Additional Info Ports, 216
•
Street Number Complete Ports, 217
•
Street Number Descriptor Ports, 218
•
Street Number Suffix, 220
•
Street Post-Descriptor Ports, 221
•
Street Post-Directional Ports, 223
•
Street Pre-Descriptor Ports, 224
•
Street Pre-Directional Ports, 226
Street Additional Info Ports
Input and output ports that contain information about the street that can assist delivery to the address. This
data takes the form of notes added to the data record.
Street number ports are related by number. For example, Street Additional Info 1 provides information about
the data in the Street Complete 1 port. You can select a Street Additional Info port and other Street ports
concurrently.
Street Additional Info Usage
Select Street Additional Info when the input address contains information about the street that can assist in
delivering mail to an address.
Address validation does not parse or validate data for this port. If you select a Street Additional Info input
port, connect the data to a Street Additional Info output port.
206
Port Locations
The following table provides the location and default precision of ports Street Additional Info 1 through Street
Additional Info 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Additional Info Example
The following example address contains data that can populate the Street Additional Info 1 port:
K-3/80
M.H Road Behind Central Arcade
Gurgaon - 122 002
INDIA
The following table shows the Address Validator transformation port that contains additional street data:
Port
Data
Street Number Complete 1
K-3/80
Street Complete 1
M.H. Road
Street Additional Info 1
Behind Central Arcade
Locality Complete 1
Gurgaon
Postcode 1
122 002
Country ISO3 Char
IND
Street Complete Ports
Input and output ports that contain all data related to a street name in an address record.
The Street Complete ports contain all data in the following ports:
•
Street Name
•
Street Post-Descriptor
•
Street Post-Directional
•
Street Pre-Descriptor
•
Street Pre-Directional
Street Complete ports do not contain street number data.
The street data ports are related by port number. For example, Street Complete 1 contains all data in Street
Name 1, Street Post-Descriptor 1, Street Post-Directional 1, Street Pre-Descriptor 1, and Street PreDirectional 1.
Street Complete Ports
207
Street Complete Usage
Select a Street Complete input port when an input address contains all data that identifies a street in a single
port.
Select a Street Complete output port to write all identification that identifies a street in a single port.
Consider the following guidelines when you use Street Complete ports:
•
There are six Street Complete ports. If an address record contains more than one street, select additional
Street Complete ports.
•
Most countries use Street Complete 1 or Street Complete 2 ports. You may need to select a port in the
Street Complete 3 through Street Complete 6 range if the street data is highly complex.
•
For each street in an address, select the Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, or Street Pre-Directional
input ports.
•
You can select all street data output ports.
•
Street Complete ports do not contain house or building numbers. Use Building Number ports for house
and building numbers.
•
Use Street Name ports to identify a number in a street name, such as "10th" in "10th Street."
Port Locations
The following table provides the location and default precision of the Street Complete 1 and Street Complete
2 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Output
Address Elements
Basic
50
The following table provides the location and default precision of the Street Complete 3 and Street Complete
4 ports:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
50
Output
Address Elements
Advanced
50
The following table provides the location and default precision of the Street Complete 5 and Street Complete
6 ports:
208
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
50
Chapter 14: Street Data Ports
Street Complete Example
The following example address contains data that can populate the Street Complete 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the street data in the
address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Name
North
Street Post-Descriptor
St.
Street Number Complete 1
No. 11
Street Number Descriptor 1
No.
Street Number 1
11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Complete with Number Ports
Output ports that contain all data that identifies a street and a building on a street in an address record.
The Street Complete with Number ports contain all the data that appears in the Street Complete ports and
Street Number Complete ports in the address record.
The street data ports are related by port number. For example, Street Complete with Number 1 contains all
data in Street Complete 1 and Street Number Complete 1.
Street Complete with Number Ports
209
Street Complete with Number Usage
To write all street-level data and all building-level data to a single port, select a Street Complete with Number
port.
Consider the following guidelines when you use Street Complete ports:
•
The Street Complete with Number ports do not contain sub-building data.
•
There are six Street Complete with Number ports. If an address record contains data that relates to more
than one street or building, select additional Street Complete with Number ports.
•
Most countries use Street Complete with Number 1 or Street Complete with Number 2 ports. You might
need to select port numbers 3 through 6 if the street data is highly complex.
•
You can add all street data output ports to an output address, including the Street Complete with Number
ports.
Port Locations
The following table provides the location and default precision of the Street Complete with Number 1 and
Street Complete with Number 2 ports:
Port Type
Port Group
Template Model
Precision
Output
Address Elements
Basic
50
The following table provides the location and default precision of the ports in the range Street Complete 3
through Street Complete 6:
Port Type
Port Group
Template Model
Precision
Output
Address Elements
Advanced
50
Street Complete with Number Example
The following example address contains data that can populate the Street Complete with Number 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the street data in the
address:
210
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Chapter 14: Street Data Ports
Port Name
Data
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Street Complete with Number 1
No. 11 North St.
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Identifier DE
Input and output ports that contain a street-level identification code for a German address. The street
identifier is a number of variable length.
Street Identifier DE Usage
The Street Identifier DE port value identifies the street that contains the address mailbox. The Address
Validator transformation can generate the street, city, state, and post code from a street identifier. The street
identifier does not identify a building number.
To read the street identifier from a German address, select the Street Identifier DE input port. To write the
street identifier to a German address, select the Street Identifier DE output port.
Port Location
The following table provides the location and default precision of the Street Identifier DE port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
9
Output
DE Supplementary
Basic
9
Street Identifier DE Example
The street identifier 100560690 corresponds to the following address:
Röntgenstr.
67133 Maxdorf
Rheinland-Pfalz
Germany
Street Identifier DE
211
The following table shows Address Validator transformation ports that you might select for the address:
Port Name
Data
Street Complete 1
Röntgenstr.
Street Identifier DE
100560690
Locality Complete 1
Maxdorf
Province Country Standard 1
Rehinland-Pfalz
Postcode Unformatted 1
67133
Country Name 1
Germany
Street Name Ports
Input and output ports that contain the street name data in an address record.
The Street Name port contains a subset of the data in the Street Complete port. For example, "Fifth" is the
street name in "Fifth Avenue." The ports are linked by number, so that for example Street Name 1 is a subset
of Street Complete 1.
Street Name Usage
Select a Street Name input port when an input address contains the street name in a single port.
Select a Street Name output port to write the street name in a single port.
Consider the following guidelines when you use Street Number ports:
•
There are six Street Name ports. If an address record contains more than one street name, select
additional Street Name ports.
•
Most countries use a single Street Name. You may also need the Street Name 2 port if an address
contains a dependent street. You may need to select a port in the Street Name 3 through Street Name 6
range if the street data is highly complex.
•
For each street in an address, select the Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, or Street Pre-Directional
input ports.
•
You can select all street data output ports.
•
Street name ports can contain street numbers, such as "10th" in "10th Street."
Port Locations
The following table provides the location and default precision of the Street Name 1 and Street Name 2 ports:
212
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
50
Chapter 14: Street Data Ports
The following table provides the location and default precision of ports Street Name 3 through Street Name 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
50
Street Name Example
The following example address contains data that can populate the Street Name 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the street name data in
the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Name 1
North
Street Post-Descriptor 1
St.
Street Number Complete 1
No. 11
Street Number Descriptor 1
No.
Street Number 1
11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Name Ports
213
Street Number Ports
Input and output ports that contain numerical data that identifies a building or residence with a single mailbox
in an address record.
The Street Number port contains a subset of the data in the Street Number Complete port. For example, "10"
is the street number in "Number 10 Downing Street." The street number ports are related by port number. For
example, Street Number Complete 1 contains the data in Street Number 1 and Street Number Descriptor 1.
Street Number Ports and Australian Address Data
The Address Validator transformation writes five digits to the Street Number 1 and Street Number 2 output
ports when you select these ports from the Australia Specific group. For example, the Street Number 1 port
writes the number "16" as "00016." The five-digit format is mandated by Australia Post for AMAS certification.
You can select street number output ports from the Australia Specific group and from other groups for the
same address. Each port reads the same data. The Australia Specific ports write the data in the five-digit
format.
Note: The Street Number ports in the Australia Specific group write numerical data only. If a street number
data element contains alphanumeric data, such as "16A DRYSDALE RD," the Address Validator
transformation writes the letter A to the Street Number Suffix port.
Street Number Ports and New Zealand Address Data
Do not use Street Number ports with New Zealand addresses when you run an address validation process in
certified mode. Use House Number and House Number Alpha ports instead.
Street Number Usage
Select a Street Number input port when an input address contains the street number for a building or
residence in a single port.
Select a Street Number output port to write the street number for a building or residence in a single port.
To view street number data for an Australian address, configure the Address Validator transformation in
certified mode.
Consider the following guidelines when you use Street Number ports:
214
•
There are six Street Number ports. If an address record contains more than one street number, select
additional Street Number ports.
•
Most countries use Street Number 1 or Street Number 2 ports. Select a port in the Street Number 3
through Street Number 6 range if the street data is highly complex.
•
For each street in an address, select the Street Number Complete input port or select one or more of the
Street Number or Street Number Descriptor input ports.
•
You can select all street number data output ports.
•
Street number ports do not identify numbers in street names. Use a Street Name port to identify a number
in a street name, for example "10th" in "10th Street."
Chapter 14: Street Data Ports
Port Locations
The following table provides the location and default precision of the Street Number 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
Output
Australia Specific
Basic
12
The following table provides the location and default precision of the Street Number 2 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Output
Australia Specific
Basic
12
The following table provides the location and default precision of ports Street Number 3 through Street
Number 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Number Example
The following address contains data that can populate the Street Number 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the street number data in
the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Street Number Ports
215
Port Name
Data
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Street Number Descriptor 1
No.
Street Number 1
11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Number Additional Info Ports
Input and output ports that contain information about the street number that can assist delivery to the
address. This data takes the form of notes added to the data record
Street number ports are related by number. For example, Street Number Additional Info 1 provides
information about the data in the Street Number 1 port. You can select a Street Number Additional Info port
and other Street Number ports concurrently.
Street Number Additional Info Usage
Select Street Number Additional Info when the input address contains information related to the building or
house number that can assist in delivering mail to an address.
Address validation does not parse or validate data for this port. If you select a Street Number Additional Info
input port, connect the data to a Street Number Additional Info output port.
Port Locations
The following table provides the location and default precision of the Street Number Additional Info 1 through
Street Number Additional Info 6 ports:
216
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
12
Chapter 14: Street Data Ports
Street Number Complete Ports
Input and output ports that contain all street number data in an address record.
A street number identifies a building or residence with a single mailbox.
The street number data ports are related by port number. For example, Street Number Complete 1 might
contain data from Street Number 1 and Street Number Descriptor 1. The correspondence applies when you
select the Street Number and Street Number Descriptor ports from the Discrete or Address Elements group.
The Street Number ports in the Australia Specific group do not share data with Street Number Complete
ports.
Street Number Complete Usage
Select a Street Number Complete input port when an input address contains all street number data for a
building or residence in a single port.
Select a Street Number Complete output port to write all street number data for a building or residence in the
address in a single port.
Consider the following guidelines when you use Street Number Complete ports:
•
There are six Street Number Complete ports. If an address record contains more than one street number,
select additional Street Number Complete ports.
•
Most countries use Street Number Complete 1 or Street Number Complete 2 ports. You may need to
select a port in the Street Number Complete 3 through Street Number Complete 6 range if the street
identification data is highly complex.
•
For each street in an address, select a Street Number Complete input port or select one or more of the
Street Number Descriptor and Street Number input ports.
•
You can select all street number data ports as outputs.
•
Street number ports do not identify numbers in street names. Use a Street Name port to identify a number
in a street name, for example "10th" in "10th Street."
Port Locations
The following table provides the location and default precision of the Street Number Complete 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
30
Output
Address Elements
Basic
30
The following table provides the location and default precision of ports Street Number Complete 2 through
Street Number Complete 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
30
Street Number Complete Ports
217
Street Number Complete Example
The following example address contains data that can populate the Street Number Complete 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to all street number data in
the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Complete 1
North St.
Street Number Complete 1
No. 11
Street Number Descriptor 1
No.
Street Number 1
11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Number Descriptor Ports
Input and output ports that contain descriptive terms for street numbers.
The Street Number Descriptor port formally identifies the street number. For example, "Number" is the street
number descriptor in "Number 10 Downing Street."
The street number descriptor ports are related by port number. For example, Street Number Complete 1
contains the data in Street Number 1 and Street Number Descriptor 1.
Street Number Descriptor Usage
Select a Street Number Descriptor input port when an input address uses a descriptive term with the street
number of a building or residence.
Select a Street Number output port to write the descriptive term for a street number to a single port.
218
Chapter 14: Street Data Ports
Consider the following guidelines when you use Street Number Descriptor ports:
•
There are six Street Number Descriptor ports. If an address record contains more than one descriptor,
select additional Street Number Descriptor ports.
•
Most countries use Street Number Descriptor 1 or Street Number Descriptor 2 ports. You may need to
select a port in the Street Number Descriptor 3 through Street Number Descriptor 6 range if the street
address data is highly complex.
•
For each street number port in an address, select the Street Number Complete input port or select one or
more of the Street Number or Street Number Descriptor input ports.
•
You can select all street number data output ports.
Port Locations
The following table provides the location and default precision of the Street Number Descriptor 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Street Number Descriptor 2 through
Street Number Descriptor 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Number Descriptor Example
The following example address contains data that can populate the Street Number Descriptor 1 port:
Mr. J. Tsang
Floor 12, Apt 231
Fung Wah Estate, Hiu Fung Tower
No. 11 North St.
Kennedy Town
Hong Kong Island
HKG
The following table shows the Address Validator transformation ports that relate to the street descriptor data
in the address:
Port Name
Data
Contact Complete 1
Mr. J. Tsang
Building Complete 1
Fung Wah Estate
Building Complete 2
Hiu Fung Tower
Sub-building Complete 1
Floor 12
Sub-building Complete 2
Apt 231
Street Number Descriptor Ports
219
Port Name
Data
Street Complete 1
North St.
Street Number Complete 1
No. 11
Street Number Descriptor 1
No.
Street Number 1
11
Locality Complete 1
Kennedy Town
Province Country Standard 1
Hong Kong Island
Country ISO3 Char
HKG
Street Number Suffix
Output port that contains one or more characters that follow the street number in an Australian address.
Street Number Suffix Usage
Select the Street Number Suffix port when an address meets the following conditions:
•
The address identifies an Australian mailbox.
•
The address contains a street number, and you have selected the Street Number 1 or Street Number 2
port from the Australia Specific group.
•
The address is part of a data set that you will submit for AMAS certification.
You can select the Street Number Suffix port with street number ports in the Discrete or Address Elements
groups.
To view street number suffix data, configure the Address Validator transformation in certified mode.
Port Location
The following table provides the location and default precision of the Street Number Suffix port:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
2
Street Number Suffix Example
The following example shows street number suffix data in an address in Wester Australia:
MS. JANE RYAN
16A DRYSDALE RD
CRAIGIE WA 6025
AUS
220
Chapter 14: Street Data Ports
The following table shows the Address Validator transformation ports that relate to the street number suffix
data in the address:
Port
Data
Contact Complete 1
MS. JANE RYAN
Street Number 1 (Address Elements)
16A
Street Number 1 (Australia Specific)
00016
Street Number Suffix
A
Street Complete 1
DRYSDALE RD
Locality Complete 1
CRAIGIE
Province Abbreviation 1
WA
Country ISO3 Char
AUS
Street Post-Descriptor Ports
Input and output ports that contain descriptive data that comes after the street name in an address record.
The Street Pre-Descriptor value can specify a street in an area where several streets have a common Street
Name value. For example, postdescriptors separate "Fourth Avenue" and "Fourth Street." The Street PostDescriptor port contains a subset of the data in the Street Complete port. The ports are linked by number, so
that for example Street Post-Descriptor 1 is a subset of Street Complete 1.
Street Post-Descriptor Usage
Select a Street Pre-Descriptor input port when an input address contains descriptive data for a street name in
a single port and the data comes after the street name.
Select a Street Post-Descriptor output port to write descriptive data that comes after a street name to a single
port.
Consider the following guidelines when you use Street Post-Descriptor ports:
•
There are six Street Post-Descriptor ports. If an address record contains a postdescriptor for more than
one street, select additional Street Post-Descriptor ports.
•
A street address may use multiple words for descriptive data. In this case, a descriptive output port
contains all the words that describe the street. For example, the Address Validator transformation parses
"Park Drive" to a single port for the street address "Lincoln Park Drive."
•
Most countries use Street Post-Descriptor 1 or Street Post-Descriptor 2 ports. You may need to select a
port in the Street Post-Descriptor 3 through Street Post-Descriptor 6 range if the street data is highly
complex.
•
For each street in an address, select a Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, or Street Pre-Directional
ports.
You can select all street data ports as outputs.
Street Post-Descriptor Ports
221
Port Locations
The following table provides the location and default precision of the Street Post-Descriptor 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Street Post-Descriptor 2 through
Street Post-Descriptor 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Post-Descriptor Example
The following example address contains data that can populate the Street Post-Descriptor 1 port:
MR. JOHN DOE
DEF INC.
22087 100TH CT SE
STE 291
KENT WA 98031-2566
USA
The following table shows the Address Validator transformation port that relates to the street directional data
in the address:
222
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Organization Complete 1
DEF INC.
Street Complete 1
100TH CT SE
Street Name 1
100TH
Street Post-Descriptor 1
CT
Street Post-Directional 1
SE
Sub-building Complete 1
STE 291
Street Number Complete 1
22087
Postcode Complete
98031-2566
Locality Complete 1
KENT
Chapter 14: Street Data Ports
Port Name
Data
Province Abbreviation 1
WA
Country ISO3 Char
USA
Street Post-Directional Ports
Input and output ports that contain directional data that comes after a street name in an address record.
The Street Post-Directional port identifies the direction that the street runs. For example, "South" is the
directional data in "Central Park South." The Street Post-Directional port contains a subset of the data in the
Street Complete port. The ports are linked by number, so that for example Street Post-Directional 1 is a
subset of Street Complete 1.
Street Post-Directional Usage
Select a Street Post-Directional input port when an input address contains directional data that comes after a
street name in a single port.
Select a Street Post-Directional output port to write the postdirectional data for a street name in a single port.
Consider the following guidelines when you use Street Post-Directional ports:
•
There are six Street Post-Directional ports. If an address record contains postdirectional data for more
than one street, select additional Street Post-Directional ports
•
A street address may use multiple words for directional data. In this case, a postdirectional output port
contains all the words that identify the direction of the street. For example, the Address Validator
transformation parses "South West" to a single postdirectional port for the street address "Ridge Road
South West."
•
Most countries use Street Post-Directional 1 or Street Post-Directional 2 ports. You may need to select a
port in the Street Post-Directional 3 through Street Post-Directional 6 range if the street data is highly
complex.
•
For each street in an address, select a Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, or Street Pre-Directional
ports.
You can select all street data ports as outputs.
Port Locations
The following table provides the location and default precision of the Street Post-Directional 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
Street Post-Directional Ports
223
The following table provides the location and default precision of ports Street Post-Directional 2 through
Street Post-Directional 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Post-Directional Example
The following example address contains data that can populate the Street Post-Directional 1 port:
MR. JOHN DOE
2 MCGRATH PL E
ST. JOHN'S NL A1B 3V4
CANADA
The following table shows the Address Validator transformation port that relates to the street directional data
in the address:
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Street Complete 1
2 MCGRATH PL E
Street Name 1
MCGRATH
Street Post-Descriptor 1
PL
Street Post-Directional 1
E
Street Number Complete 1
2
Postcode Complete
A1B 3V4
Locality Complete 1
ST. JOHN'S
Province Abbreviation 1
NL
Country ISO3 Char
CAN
Street Pre-Descriptor Ports
Input and output ports that contain descriptive data that precedes the street name in an address record.
The Street Pre-Descriptor value can specify a street in an area where several streets have a common Street
Name value. For example, predescriptors separate "Rue St. Germain" and "Boulevard St. Jean." The Street
Pre-Descriptor port contains a subset of the data in the Street Complete port. The ports are linked by
number, so that for example Street Pre-Descriptor 1 is a subset of Street Complete 1.
224
Chapter 14: Street Data Ports
Street Pre-Descriptor Usage
Select a Street Pre-Descriptor input port when an input address contains descriptive data for a street name in
a single port and the data precedes the street name.
Select a Street Pre-Descriptor output port to write the predescriptive data for a street name to a single port.
Consider the following guidelines when you use Street Pre-Descriptor ports:
•
There are six Street Pre-Descriptor ports. If an address record contains a predescriptor for more than one
street, select additional Street Pre-Descriptor ports.
•
Most countries use Street Pre-Descriptor 1 or Street Pre-Descriptor 2 ports. You may need to select a port
in the Street Pre-Descriptor 3 through Street Pre-Descriptor 6 range if the street data is highly complex.
•
For each street in an address, select a Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, or Street Pre-Directional
input ports.
You can select all street data ports as outputs.
Port Locations
The following table provides the location and default precision of the Street Pre-Descriptor 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Street Pre-Descriptor 2 through Street
Pre-Descriptor 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Pre-Descriptor Example
The following example address contains data that can populate the Street Pre-Descriptor 1 port:
9309 RUE DE LILLE
MONTREAL QC H1Z 2P4
CANADA
The following table shows the Address Validator transformation port that relates to the street descriptive data
in the address:
Port Name
Data
Street Complete 1
RUE DE LILLE
Street Name 1
DE LILLE
Street Pre-Descriptor 1
RUE
Street Pre-Descriptor Ports
225
Port Name
Data
Postcode 1
H1Z 2P4
Locality Complete 1
MONTREAL
Province Abbreviation 1
QC
Country ISO3 Char
CAN
Street Pre-Directional Ports
Input and output ports that contain directional data that precedes a street name in an address record.
The Street Pre-Directional port identifies the direction that the street runs. For example, "West" is the
directional data in "West 10th Street." The Street Pre-Directional port contains a subset of the data in the
Street Complete port. The Street Pre-Directional port contains a subset of the data in the Street Complete
port. The ports are linked by number, so that for example Street Pre-Directional 1 is a subset of Street
Complete 1.
Street Pre-Directional Usage
Select a Street Pre-Directional input port when an input address contains directional data for a street name in
a single port and the data precedes the street name.
Select a Street Post-Descriptor output port to write the predirectional data for a street name to a single port.
Consider the following guidelines when you use Street Pre-Directional ports:
226
•
There are six Street Pre-Directional ports. If an address record contains predirectional data for more than
one street, select additional Street Pre-Directional ports.
•
A street address may use multiple words for directional data. In this case, a predirectional output port
contains all the words that identify the direction of the street. For example, the Address Validator
transformation parses "North West" to a single predirectional port for the street address "North West
Valley Park."
•
Most countries use Street Pre-Directional 1 or Street Pre-Directional 2 ports. You may need to select a
port in the Street Pre-Directional 3 through Street Pre-Directional 6 range if the street data is highly
complex.
•
For each street in an address, select a Street Complete input port or select one or more of the Street
Name, Street Post-Descriptor, Street Post-Directional, Street Pre-Descriptor, and Street Pre-Directional
ports.
You can select all street data ports as outputs.
Chapter 14: Street Data Ports
Port Locations
The following table provides the location and default precision of the Street Pre-Directional 1 port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Basic
20
The following table provides the location and default precision of ports Street Pre-Directional 2 through Street
Pre-Directional 6:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Advanced
50
Output
Address Elements
Advanced
20
Street Pre-Directional Example
The following example address contains data that can populate the Street Pre-Directional 1 port:
MR. JOHN DOE
118 W AARON SQ
AARONSBURG PA 16820-9407
UNITED STATES
The following table shows the Address Validator transformation port that relates to the street directional data
in the address:
Port Name
Data
Contact Complete 1
MR. JOHN DOE
Street Complete 1
118 W AARON SQ
Street Name 1
AARON
Street Post-Descriptor 1
SQ
Street Pre-Directional 1
W
Street Number Complete 1
118
Postcode Complete
16820-9407
Locality Complete 1
AARONSBURG
Province Abbreviation 1
PA
Country ISO3 Char
USA
Street Pre-Directional Ports
227
CHAPTER 15
Supplementary Data Ports
This chapter includes the following topics:
228
•
Address Key, 229
•
Census Block Group, 230
•
Census Block Number, 231
•
Census Tract Number, 231
•
Choumei Aza Code JP, 232
•
Choumei Aza and Gaiku Code JP, 234
•
Consolidated Metropolitan Statistical Area Identification, 235
•
Core-Based Statistical Area Identification , 235
•
County Federal Information Processing Standard Code , 236
•
Delivery Point Suffix , 237
•
Gaiku Code, 237
•
Gmina Code PL, 238
•
INSEE 9-Digit, 239
•
INSEE 5-Digit, 240
•
Institute of Geography and Statistics Code, 241
•
Locality Identifier DE, 242
•
Metropolitan Statistical Area Identification , 242
•
Minor Civil Division Identification, 243
•
National Address Database Identifier ZA, 243
•
New Choumei Aza Code JP, 244
•
Official Municipality Key DE, 246
•
Place Federal Information Processing Standard Code, 246
•
Postal Address Code AT, 247
•
Postal Address Code RS, 247
•
Postal Code Extension, 247
•
Primary Metropolitan Statistical Area Identification, 247
•
Record Type , 248
•
State Federal Information Processing Standard Code , 249
•
Street Identifier DE, 250
•
Supplementary AT Status, 250
•
Supplementary BR Status, 251
•
Supplementary CH Status, 252
•
Supplementary DE Status, 253
•
Supplementary FR Status, 254
•
Supplementary GB Status, 255
•
Supplementary JP Status, 256
•
Supplementary PL Status, 257
•
Supplementary RS Status, 258
•
Supplementary US Status, 259
•
Supplementary ZA Status, 260
•
TERYT Locality Identifier PL, 261
•
TERYT Street Identifier PL, 262
•
Unique Delivery Point Reference Number GB, 263
Address Key
Output port that writes the address key to a United Kingdom address. The address key is an eight-digit code
that uniquely identifies an address location in the United Kingdom.
Address Key Usage
To find the unique identifier for a United Kingdom address, select the Address Key port.
Consider the following guidelines when you use the Address Key port:
•
The address key might not uniquely identify the destination mailbox for an address record. For example, a
single building might contain the residence of John Smith and the office of J. Smith Real Estate.
To find a unique identifier for a United Kingdom mailbox, select the Unique Delivery Point Reference
Number GB port.
•
Address key codes can change regularly, for example if the Royal Mail updates the post code for the
address.
Port Locations
The following table provides the location and default precision of the Address Key port:
Port Type
Port Group
Template Model
Precision
Output
Basic
UK Supplementary
8
Address Key Example
The following example address contains data that can populate the Address Key port:
Ms. Patricia Highland
12 Smith Street
Bulwell
NOTTINGHAM
NG6 8AL
Address Key
229
The following table shows the Address Validator transformation ports that relate to the street name data in
the address:
Port Name
Data
Contact Complete 1
MS. PATRICIA HIGHLAND
Street Number Complete 1
12
Street Complete 1
SMITH STREET
Postcode Complete 1
NG6 8AL
Locality Complete 1
NOTTINGHAM
Locality Complete 2
BULWELL
Country ISO3 Char
GBR
Address Key
02341509
Census Block Group
Output port that contains a United States census block group number.
The Census Bureau uses census tracts and census blocks to organize census data. A census tract is
composed of census block groups. A census block group is composed of census blocks.
The Census Bureau uses demographic data to define census tracts so that the inhabitants of each tract have
a common economic status and population profile. The Census Bureau does not use demographic data to
define census blocks.
A census block group contains an average of 39 census block. Each census block group has a maximum of
3,000 inhabitants. A census tract can contain between one and nine census block groups.
Census Block Group Usage
Select Census Block Group to identify the census block group that an address belongs to.
Use census tract and census block data to analyze the distribution of your mail items. For example, before
you run a direct mail campaign, you can use census tract and census block data to verify that mail items are
distributed evenly across a city or region.
Port Location
The following table provides the location and default precision of the Census Block Group port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
1
Census Block Group Output Codes
Census block groups use a single digit in the range from one through nine. A block group consists of all
census blocks that begin with same digit.
230
Chapter 15: Supplementary Data Ports
Census Block Number
Output port that contains a United States census block number.
The Census Bureau uses census tracts and census blocks to organize census data. A census tract is
composed of census block groups. A census block group is composed of census blocks.
The Census Bureau uses demographic data to define census tracts, so that the inhabitants of each tract have
a common economic status and population profile. The Census Bureau does not use demographic data to
define census blocks.
A census block group contains an average of 39 census block. Each census block group has a maximum of
3,000 inhabitants. A census tract can contain between one and nine census block groups.
In a city, a census block may correspond to a city block. In rural areas, the Census Bureau may use a
physical feature, such as a river, to define a census block boundary.
Census block populations vary greatly. A quarter of all census blocks have no inhabitants.
Census Block Number Usage
Select Census Block Number to identify the census block that an address belongs to.
Use census tract and census block data to analyze the distribution of your mail items. For example, before
you run a direct mail campaign, you can use census tract and census block data to verify that mail items are
distributed evenly across a city or region.
Port Location
The following table provides the location and default precision of the Census Block Number port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
Census Block Number Output Codes
Census block numbers are unique within a census tract. Most census block numbers have three digits.
A census block number may add a letter to the block number if the block area crosses another geographical
boundary, such as a minor civil division boundary.
The Census Bureau maintains a Geographic Areas Reference Manual that describes census blocks and
other population areas. You can read the manual on the following site:
http://www.census.gov/geo/reference/garm.html
Census Tract Number
Output port that contains a United States census tract number.
The Census Bureau uses census tracts and census blocks to organize census data. A census tract is
composed of census block groups. A census block group is composed of census blocks.
The Census Bureau uses demographic data to define census tracts, so that the inhabitants of each tract have
a common economic status and population profile. The Census Bureau does not use demographic data to
define census blocks.
Census Block Number
231
A census block group contains an average of 39 census block. Each census block group has a maximum of
3,000 inhabitants. A census tract can contain between one and nine census block groups.
Census tracts have between 1,500 and 8,000 inhabitants. The Census Bureau uses physical features to
define the area of a census tract, such as roads, rivers, and railroads. The shape and size of a census tract
can change over time as the population changes. Census tracts do not cross state or county boundaries.
Census Tract Number Usage
Select Census Tract Number to identify the census tract that an address belongs to.
Use census tract and census block data to analyze the distribution of your mail items. For example, before
you run a direct mail campaign, you can use census tract and census block data to verify that mail items are
distributed evenly across a city or region.
Port Location
The following table provides the location and default precision of the Census Tract Number port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
6
Census Tract Number Output Codes
Census tract numbers are unique with a county. Most census tract numbers have three digits. A census tract
number may add two digits after the decimal place.
The Census Bureau maintains a Geographic Areas Reference Manual that describes census tracts and other
population areas. You can read the manual on the following site:
http://www.census.gov/geo/reference/garm.html
Choumei Aza Code JP
Output port that contains the Choumei Aza code that Japan Post defined for an earlier version of the
address. The Choumei Aza code contains 11 digits.
When a street address changes, Japan Post updates the Choumei Aza code that it maintains for the address.
The address reference data for Japan contains the current code for each address and any earlier version of
the code. If the street address does not change over time, the Choumei Aza Code JP port and the New
Choumei Aza Code JP port return the same data.
Choumei Aza Code JP Usage
To find the earlier version of the Choumei Aza code for a Japanese address, select the Choumei Aza Code
JP port.
232
Chapter 15: Supplementary Data Ports
Consider the following guidelines when you use the Choumei Aza Code JP port:
•
When a street address changes, Japan Post updates the Choumei Aza code that it maintains for the
address. The address reference data for Japan contains the current code for each address and any earlier
version of the code. If the street address does not change, the Choumei Aza Code JP port and the New
Choumei Aza Code JP port return the same data.
To return both versions of the code, select the New Choumei Aza Code JP port and the Choumei Aza
Code JP port. When you select the ports, set the Matching Extended Archive advanced property on the
transformation.
If the transformation returns different values on each port, verify that the input address uses the current
Choumei Aza code.
•
If the input address cannot uniquely identify a mailbox, the port returns an identifier for the smallest
unique locality identifier in the address. For example, the port might identify the cho or neighborhood for
the address.
•
The Address Validator transformation can read and write the code from an address that uses Western
characters.
Port Location
The following table provides the location and default precision of the Choumei Aza Code JP port:
Port Type
Port Group
Template Model
Precision
Output
JP Supplementary
Basic
30
Choumei Aza Code JP Example
The following example address contains data that address validation can use to populate the Choumei Aza
Code JP port:
2 CHOME
HAMADAYAMA
SUGINAMI-KU TOKYO-TO 168-0065
The following table shows the formatted address and the Choumei Aza Code JP code for the address:
Port Name
Data
Formatted Address Line 1
2 CHOME
Formatted Address Line 2
HAMADAYAMA
Formatted Address Line 3
SUGINAMI-KU TOKYO-TO 168-0065
Choumei Aza Code JP
13115028002
RELATED TOPICS:
•
“Choumei Aza and Gaiku Code JP” on page 234
•
“Gaiku Code” on page 237
•
“New Choumei Aza Code JP” on page 244
Choumei Aza Code JP
233
Choumei Aza and Gaiku Code JP
Input port that contains the current Choumei Aza code and the Gaiku code for a Japanese address in a single
string. The Address Validator transformation reads the codes and returns the address that they represent.
The Choumei Aza code uniquely identifies a mailbox in Japan. The Gaiku code identifies the city block or ban
to which an address belongs.
Choumei Aza and Gaiku Code JP Usage
Select the Choumei Aza and Gaiku Code JP port to return the address that the codes identify. When you
select the port, configure the Address Validator transformation to run in address code lookup mode.
Consider the following guidelines when you use the Choumei Aza and Gaiku Code JP port:
•
The port reads a 15-digit string. The first 11 digits specify the current Choumei Aza code. The final four
digits specify the Gaiku code.
•
Address code lookup mode uses the Choumei Aza code and the Gaiku code to return an address from the
Japanese address reference data. To return the address that a Choumei Aza code identifies, use batch
mode or interactive mode and select the New Choumei Aza Code JP output port. To return the Gaiku
Code for an address, use batch mode or interactive mode and select the Gaiku Code output port.
Port Locations
The following table provides the location and default precision of the Choumei Aza and Gaiku Code JP port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
15
Choumei Aza and Gaiku Code JP Example
The following table identifies the current Choumei Aza code and the Gaiku code in the string
131040040000020:
Choumei Aza Code
Gaiku Code
13104004000
0020
RELATED TOPICS:
234
•
“Choumei Aza Code JP” on page 232
•
“Gaiku Code” on page 237
•
“New Choumei Aza Code JP” on page 244
Chapter 15: Supplementary Data Ports
Consolidated Metropolitan Statistical Area
Identification
Output port that contains the Consolidated Metropolitan Statistical Area (CMSA) number when an address is
located in a CMSA.
A CMSA is a United States metropolitan area that is composed of other metropolitan areas and that has an
overall population greater than 1,000,000. A CMSA can contain two or more Primary Metropolitan Statistical
Areas (PMSAs).
Consolidated Metropolitan Statistical Area Identification Usage
Select Consolidated Metropolitan Statistical Area Identification to identify the CMSA that the address belongs
to. that a United States address belongs to. You can use this information to sort large record sets by areas of
population. Use Consolidated Metropolitan Statistical Area Identification with United States addresses.
Port Location
The following table provides the location and default precision of the Consolidated Metropolitan Statistical
Area Identification port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
Output Codes
The Consolidated Metropolitan Statistical Area Identification value is a four-digit number. If the address does
not belong to a PMSA, the port returns no data.
You can view a list of the CMSAs that the U.S. government recognized in 2000 on the following site:
http://www.census.gov/population/cen2000/phc-t3/tab01.txt
Note: The United States Census Bureau supports the use of CMSA data. The United States government no
longer uses the CMSA definition to describe population areas.
Core-Based Statistical Area Identification
Output port that contains a Core-Based Statistical Area (CBSA) identification number. A CBSA identifies an
urban area with a population greater than 10,000.
A CBSA can be a Metropolitan Statistical Area or Micropolitan Statistical Area. A Metropolitan Statistical Area
has over 50,000 inhabitants. A Micropolitan Statistical Area has between 10,000 and 50,000 inhabitants.
Core-Based Statistical Area Identification Usage
Select Core-Based Statistical Area Identification to identify the Core-Based Statistical Area that a United
States address belongs to. You can use this information to sort large record sets by areas of population
density.
Consolidated Metropolitan Statistical Area Identification
235
Port Location
The following table provides the location and default precision of the Core-Based Statistical Area
Identification port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
5
Core-Based Statistical Area Identification Output Codes
The Core-Based Statistical Area Identification number contains five digits. For example, Austin, Texas has
the CBSA ID of 12420.
The United States government recognizes over 900 CBSAs. You can download a list of statistical areas from
the following site:
http://www.census.gov/population/metro/data/def.html
County Federal Information Processing Standard
Code
Output port that identifies a county or county equivalent in the United States and United States possessions.
Some freely-associated states also uses this code.
The United States Federal Information Processing Standard (FIPS) maintains a set of codes that identify
states, counties, and other territorial possessions. The two-digit state code identifies each state. The threedigit county code identifies a county within a state. The five digits of the state and county code can uniquely
identify any county or county equivalent. The County Federal Information Processing Standard Code port
contains the three digits of the county code.
County Federal Information Processing Standard Code Usage
Select County Federal Information Processing Standard Code to add the three-digit county code to a United
States address.
Select County Federal Information Processing Standard Code and State Federal Information Processing
Standard Code to write a FIPS code that unique identifies a county.
Port Location
The following table provides the location and default precision of the County Federal Information Processing
Standard Code port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
3
County Federal Information Processing Standard Code Output Codes
The county code is a three-digit number that identifies a county within a state. You can view the United
States FIPS codes on the following site:
http://www.epa.gov/enviro/html/codes/state.html
236
Chapter 15: Supplementary Data Ports
Delivery Point Suffix
Output port that enables the Royal Mail to identify any deliverable address in a post code.
The Royal Mail assigns a two-character suffix to every mailbox in a UK post code area. It uses the post code
and delivery point suffix to identify every mailbox.
The delivery point suffix format is a digit followed by a letter.
Delivery Point Suffix Usage
Select Delivery Point Suffix to add the delivery point suffix to the output address record. The combined
delivery point suffix and post code can identify any deliverable address in the United Kingdom.
Port Location
The following table provides the location and default precision of the Delivery Point Suffix port:
Port Type
Port Group
Template Model
Precision
Output
UK Supplementary
Basic
2
Delivery Point Suffix Output Code
The folllowing table shows a UK post code with the corresponding delivery point suffix:
Post Code
Delivery Point Suffix
BX1 1LT
1A
Gaiku Code
Output port that contains the identification code for the city block or ban in a Japanese address. The Address
Validator transformation writes the Gaiku code for any address that includes block data. The Gaiku code
contains four digits.
Gaiku Code Usage
Select the Gaiku Code output port to add the Gaiku code to a Japanese address.
Port Locations
The following table provides the location and default precision of the Gaiku Code port:
Port Type
Port Group
Template Model
Precision
Output
Discrete
JP Supplementary
4
Gaiku Code Example
In the following address, the Gaiku Code is 0065:
2 CHOME
HAMADAYAMA
SUGINAMI-KU TOKYO-TO 168-0065
Delivery Point Suffix
237
RELATED TOPICS:
•
“Choumei Aza Code JP” on page 232
•
“Choumei Aza and Gaiku Code JP” on page 234
•
“New Choumei Aza Code JP” on page 244
Gmina Code PL
Output port that contains the identification code for the municipality or commune to which a Polish address
belongs. A gmina is the smallest unit of government administration in Poland. The National Official Register
of the Territorial Division of the Country (TERYT) maintains the list of gminas and gmina codes.
TERYT defines the following types of gmina:
•
Urban. A single city or town.
•
Urban-rural. A city or town and the adjacent villages or countryside.
•
Rural. One or more villages and the adjacent countryside.
Gmina Code PL Usage
To add a code that identifies the municipality or commune to which a Polish address belongs, select the
Gmina Code PL port.
Port Locations
The following table provides the location and default precision of the Gmina Code PL port:
Port Type
Port Group
Template Model
Precision
Output
PL Supplementary
Basic
4
Gmina Code PL Example
The following example address contains data that can populate the Gmina Code PL port:
Adrian Kieślowski
ul. Laskowa 1
50510 Wrocław
Poland
The following table shows Address Validator transformation ports that you might select for the address:
238
Port Name
Data
Contact Complete 1
Adrian Kieślowski
Street Complete 1
ul. Laskowa
Street Number Complete 1
1
Province Country Standard 1
dolnośląskie
Gmina Code PL
2183
Chapter 15: Supplementary Data Ports
Port Name
Data
Locality Complete 1
Wrocław
Postcode 1
50510
Country Name 1
Poland
INSEE 9-Digit
Output port that identifies the statistical unit to which a French address belongs. A statistical unit is a
subdivision of a commune. The National Institute of Statistics and Economic Studies (INSEE) defines the
statistical units to assist in the analysis of census data. INSEE refers to the code as the IRIS code.
The first five digits of the code identify the department and the commune to which the address belongs. The
final four digits are a unique code for the statistical unit within the commune. INSEE maintains the code data.
Note: The INSEE 5-Digit Code port returns the department and commune data.
INSEE 9-Digit Usage
To identify the statistical unit for a French address, select the INSEE 9-Digit port. Use the INSEE 9-Digit port
to match the address to the area that INSEE defines for census data collection.
Port Locations
The following table provides the location and default precision of the INSEE 9-Digit port:
Port Type
Port Group
Template Model
Precision
Output
FR Supplementary
Basic
9
INSEE 9-Digit Example
The following table lists the codes that identify statistical units in the commune of Bourg-en-Bresse in the
department of Ain:
INSEE 9-Digit
IRIS Label
INSEE 5-Digit Code
Commune Name
010530101
Centre-Ville
01053
Bourg-en-Bresse
010530102
Champ-de-Foire
01053
Bourg-en-Bresse
010530103
Prefecture
01053
Bourg-en-Bresse
010530201
Citadelle
01053
Bourg-en-Bresse
010530202
Mail
01053
Bourg-en-Bresse
010530203
Peloux
01053
Bourg-en-Bresse
010530301
Gare
01053
Bourg-en-Bresse
INSEE 9-Digit
239
INSEE 9-Digit
IRIS Label
INSEE 5-Digit Code
Commune Name
010530302
Brou
01053
Bourg-en-Bresse
010530401
Vennes-Ouest
01053
Bourg-en-Bresse
010530402
Vennes-Est
01053
Bourg-en-Bresse
010530501
Baudieres
01053
Bourg-en-Bresse
010530502
Sardieres
01053
Bourg-en-Bresse
010530503
Croix-Blanche
01053
Bourg-en-Bresse
010530601
Pont-des-Chevres
01053
Bourg-en-Bresse
010530602
Reyssouze-Ouest
01053
Bourg-en-Bresse
010530603
Reyssouze-Est
01053
Bourg-en-Bresse
010530604
Cenord-Grand-Challes
01053
Bourg-en-Bresse
010530701
Granges-Bardes-Alagnier
01053
Bourg-en-Bresse
To learn more about the INSEE codes, visit the INSEE website:
http://www.insee.fr/en/methodes/default.asp?page=definitions/iris.htm
INSEE 5-Digit
Output port that identifies the administrative regions to which a French address belongs. The port contains a
five-digit code that identifies the department and the commune for the address. The first two digits identify the
department. The final three digits identify the commune. The National Institute of Statistics and Economic
Studies (INSEE) maintains the codes.
INSEE 5-Digit Usage
To identify the department and commune for a French address, select the INSEE 5-Digit port.
Commune names are not unique across the departments in France. Use the INSEE 5-Digit port to uniquely
identify a commune.
Port Locations
The following table provides the location and default precision of the INSEE 9-Digit port:
240
Port Type
Port Group
Template Model
Precision
Output
FR Supplementary
Basic
5
Chapter 15: Supplementary Data Ports
INSEE 5-Digit Example
The following example address contains data that can populate the INSEE 5-Digit port:
3 Lieu Dit Chante Alouette
3330 St Emilion
France
The following table shows the Address Validator transformation ports that relate to the street name data in
the address:
Port Name
Data
Street Complete 1
Lieu Dit Chante Alouette
Street Number Complete 1
3
Locality Complete 1
St Emilion
INSEE 5-Digit
33394
Postcode 1
33330
Country Name 1
France
Institute of Geography and Statistics Code
Output port that contains a seven-digit identification code for the city or state to which a Brazilian address
belongs. The Brazilian Institute of Geography and Statistics (IGBE) maintains the identification codes.
Institute of Geography and Statistics Code Usage
To add an administrative code that identifies the city or state to a Brazilian address, select the Institute of
Geography and Statistics Code port.
The Brazilian government uses the Institute of Geography and Statistics codes to organize the address
records that it maintains for tax-gathering and other purposes.
Port Location
The following table provides the location and default precision of the Institute of Geography and Statistics
Code port:
Port Type
Port Group
Template Model
Precision
Output
BR Supplementary
Basic
7
Institute of Geography and Statistics Code Example
The following address has an Institute of Geography and Statistics Code value of 2606101:
Rua da Matriz 9
Centro
Glória do Goitá - PE
55620-000
Brazil
Institute of Geography and Statistics Code
241
The following table shows Address Validator transformation ports that you might select for the address:
Port Name
Data
Street Complete 1
Rua da Matriz
Street Number Complete 1
9
Institute of Geography and Statistics Code
2606101
Locality Complete 1
Glória do Goitá
Province 1
Pernambuco
Postcode Complete 1
55620-000
Country Name 1
Brazil
Locality Identifier DE
See City and Locality Data Ports.
Metropolitan Statistical Area Identification
Output port that contains the Metropolitan Statistical Area identification number. This number identifies an
urban area with a population greater than 50,000.
Metropolitan Statistical Area Identification Usage
Select Metropolitan Statistical Area Identification to identify the Metropolitan Statistical Area that an address
belongs to.
Port Location
The following table provides the location and default precision of the Metropolitan Statistical Area
Identification port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
Metropolitan Statistical Area Identification Output Codes
The Metropolitan Statistical Area Identification number contains four digits. You can download a list of
statistical areas from the following site:
http://www.census.gov/population/www/metroareas/metrodef.html
242
Chapter 15: Supplementary Data Ports
Minor Civil Division Identification
Output port that contains a Minor Civil Division (MCD) identification number. An MCD is a political or
administrative area within a United States county.
All United States counties comprise MCDs or Census County Divisions (CCDs). The Census Bureau
recognizes MCDs in 29 states and in the District of Columbia, Puerto Rico, and the Island Areas.
Minor Civil Division Identification Usage
Select Minor Civil Division Identification to identify the MCD that an address belongs to. If the address does
not belong to an MCD, the port does not return data.
Port Location
The following table provides the location and default precision of the Minor Civil Division Identification port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
5
Minor Civil Division Identification Output Codes
The MCD code is a five-digit number.
The Census Bureau maintains a Geographic Areas Reference Manual that describes MCDs and other
population areas. You can read the manual on the following site:
http://www.census.gov/geo/reference/garm.html
National Address Database Identifier ZA
Output port that contains a seven-digit identification code for the street in a South African address.
The South African government uses a National Address Database to uniquely identify each street in South
Africa. If an input address contains street-level information, address validation can generate the National
Address Database code for the street. If an input address includes a National Address Database code,
address validation can generate the street address that corresponds to the code.
National Address Database Identifier ZA Usage
To read a National Address Database code from an input address, select the National Address Database
Identifier ZA input port.
To generate a National Address Database code from an input address, select the National Address Database
Identifier ZA output port.
Minor Civil Division Identification
243
Port Location
The following table provides the location and default precision of the National Address Database Identifier ZA
port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
7
Output
ZA Supplementary
Basic
7
National Address Database Identifier ZA Example
The following address has a National Address Database code value of 2153781:
4 Balfour Road
Vincent
East London
5247
South Africa
The following table shows Address Validator transformation ports that you might select for the address:
Port Name
Data
Street Complete 1
Balfour Road
Street Number Complete 1
4
National Address Database Identifier ZA
2153781
Locality Complete 1
East London
Province 1
Eastern Cape
Postcode 1
5247
Country Name 1
South Africa
New Choumei Aza Code JP
Input and output ports that contains the current Choumei Aza code for a Japanese address. The Choumei
Aza code uniquely identifies a mailbox in Japan. The code contains 11 digits.
New Choumei Aza Code JP Usage
To write the current Choumei Aza code to a Japanese address record, select the New Choumei Aza JP
output port.
To read the current Choumei Aza code from an input address record, select the New Choumei Aza Code JP
input port.
244
Chapter 15: Supplementary Data Ports
Consider the following guidelines when you use the New Choumei Aza Code JP ports:
•
When a street address changes, Japan Post updates the Choumei Aza code that it maintains for the
address. The address reference data for Japan contains the current code for each address and any earlier
version of the code. If the street address does not change, the Choumei Aza Code JP port and the New
Choumei Aza Code JP port return the same data.
To return both versions of the code, select the New Choumei Aza Code JP port and the Choumei Aza
Code JP port. When you select the ports, set the Matching Extended Archive advanced property on the
transformation.
If the transformation returns different values on each port, verify that the input address uses the current
Choumei Aza code.
•
If the input address cannot uniquely identify a mailbox, the port returns an identifier for the smallest
unique locality identifier in the address. For example, the port might identify the cho or neighborhood for
the address.
•
The Address Validator transformation can read and write the code from an address that uses Western
characters.
Port Locations
The following table provides the location and default precision of the New Choumei Aza Code JP port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
11
Output
JP Supplementary
Basic
30
New Choumei Aza Code JP Example
The following example address contains data that address validation can use to populate the New Choumei
Aza Code JP port:
2 CHOME
HAMADAYAMA
SUGINAMI-KU TOKYO-TO 168-0065
JPN
The following table shows the formatted address and the New Choumei Aza Code JP code for the address:
Port Name
Data
Formatted Address Line 1
2 CHOME
Formatted Address Line 2
HAMADAYAMA
Formatted Address Line 3
SUGINAMI-KU TOKYO-TO 168-0065
New Choumei Aza Code JP
13115028002
RELATED TOPICS:
•
“Choumei Aza Code JP” on page 232
•
“Choumei Aza and Gaiku Code JP” on page 234
•
“Gaiku Code” on page 237
New Choumei Aza Code JP
245
Official Municipality Key DE
Input and output ports that contain the identification number for a German municipality. A municipality is
administrative area in the German federal system. The German government assigns an eight-digit number to
each municipality,
Official Municipality Key DE Usage
To read the municipality key from a German address, select the Official Municipality Key DE input port
To write the municipality key to a German address, select the Official Municipality Key DE output port
Port Location
The following table provides the location and default precision of the Official Municipality Key DE port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
8
Output
DE Supplementary
Basic
8
Official Municipality Key DE Example
The municipality key is an eight-digit number. The first two digits identify the federal state. The next three
digits identify the district within the state. The final three digits identify the municipality. For example, the
municipality key for the town of Maxdorf is 07338018.
The following table shows the elements of the municipality key for Maxdorf:
Type of Administrative
Area
Name of Administrative Area
Area Code
State
Rhineland-Pfalz
07
District
Rhein-Pfalz-Kreis
338
Municipality
Maxdorf
018
Place Federal Information Processing Standard Code
Output port that contains the Federal Information Processing Standard (FIPS) code for a populated place.
The term "place" defines a populated residential area. The Census Bureau recognizes FIPS codes for
incorporated places, census-designated places, and other geographical entities.
Place Federal Information Processing Standard Code Usage
Select Place Federal Information Processing Standard Code to find the FIPS code number for the place
identified in the address record.
246
Chapter 15: Supplementary Data Ports
Port Location
The following table provides the location and default precision of the Place Federal Information Processing
Standard Code port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
5
Place Federal Information Processing Standard Code Output Codes
The place code is a five-digit number. You can download a list of state, county, minor civil divisions, and
incorporated place codes for all U.S. counties from the following site:
http://www.census.gov/geo/www/codes/place/download.html
Postal Address Code AT
See Postcode Data Ports.
Postal Address Code RS
See Postcode Data Ports.
Postal Code Extension
See Postcode Data Ports.
Primary Metropolitan Statistical Area Identification
Output port that contains the Primary Metropolitan Statistical Area (PMSA) number when an address is
located in a PMSA.
A PMSA is a metropolitan area that connects with one or more metropolitan areas to create an area with a
population greater than 1,000,000. For example, one PMSA may serve as a commuter belt for another
contiguous area. The combined area is called a Consolidated Metropolitan Statistical Area (CMSA).
Primary Metropolitan Statistical Area Identification Usage
Select Primary Metropolitan Statistical Area Identification to identify the PMSA that an address belongs to.
You can use this information to sort large record sets by areas of areas of population. Use Primary
Metropolitan Statistical Area Identification with United States addresses.
Postal Address Code AT
247
Port Location
The following table provides the location and default precision of the Primary Metropolitan Statistical Area
Identification port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
Primary Metropolitan Statistical Area Output Codes
The Primary Metropolitan Statistical Area Identification is a four-digit number. If the address does not belong
to a PMSA, the port returns no data.
You can view a list of the PMSAs that the U.S. government recognized in 2000 on the following site:
http://www.census.gov/population/cen2000/phc-t3/tab01.txt
Note: The United States Census Bureau supports the use of PMSA data. The United States government no
longer uses the PMSA definition to describe population areas.
Record Type
Output ports that contain a single-character code that describes the type of mailbox. For example, the code
can indicate if the address is in a high-rise building.
Include the record type value with the addresses that you submit for certification by the United States Postal
Service (USPS) or Australia Post. The USPS certifies address record sets according to the Coding Accuracy
Support System (CASS) standard. Australia Post certifies address record sets according to the Address
Matching Approval System (AMAS) standard. The Record Type code enables the mail carrier to process
addresses that are valid to post code level but not valid to Delivery Point Code (DPC) or Delivery Point ID
(DPID) level.
An AMAS or CASS certified process can reject an address record data set if the data set contains one or
more records without delivery point information. The Record Type output code can provide the mail carrier
with additional information about non-delivery point address, so that the mail carrier can accept the data set
for certification.
Record Type Usage
Select Record Type to generate a code value that represents the address type. Select this port if you are not
confident of the delivery point status of one or more addresses in a data set.
To view record type data, configure the Address Validator transformation to run in certified mode.
248
Chapter 15: Supplementary Data Ports
Port Locations
The following table provides the location and default precision of the Record Type ports:
Port Type
Port Group
Template Model
Precision
Output
Australia Specific
Basic
1
Output
US Specific
Basic
1
Output
US Supplementary
Basic
1
Record Type Output Codes
The following table lists the Record Type output codes:
Code
Description
S
Street
P
Post Office Box
R
Rural route
H
High-rise
F
Firm
G
General delivery
RELATED TOPICS:
•
“Address Type” on page 121
State Federal Information Processing Standard Code
Output port that uniquely identifies states and state equivalents in the United States and United States
possessions.
The Federal Information Processing Standard (FIPS) controls the numerical and alphabetical codes that
identify states and other territories or possessions of the United States. The State Federal Information
Processing Standard Code port writes the two-digit FIPS code.
State Federal Information Processing Standard Code Usage
Select State Federal Information Processing Standard Code to write the two-digit state identifier for a state or
territory in the United States as output.
Note: Select the County Federal Information Processing Standard Code port to write the three-digit county
FIPS code as output.
State Federal Information Processing Standard Code
249
Port Location
The following table provides the location and default precision of the State Federal Information Processing
Standard Code port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
2
State Federal Information Processing Standard Code Output Codes
You can view the United States FIPS codes on the following site:
http://www.epa.gov/enviro/html/codes/state.html
Street Identifier DE
See Street Data Ports.
Supplementary AT Status
Output port that indicates whether the address validation process can write supplementary data for Austrian
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Austria in the AT Supplementary port group. AT Supplementary port
data includes postal codes that identify the street for an Austrian mailbox.
Supplementary AT Status Usage
Select Supplementary AT Status to verify that the address validation process can populate the ports in the
AT Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Austrla.
Port Location
The following table provides the location and default precision of the Supplementary AT Status port:
250
Port Type
Port Group
Template Model
Precision
Output
Basic
AT Supplementary
4
Chapter 15: Supplementary Data Ports
Supplementary AT Status Output Codes
The following table describes Supplementary AT Status output codes:
Code
Description
EAT0
Supplementary data is not available for the current address.
EAT1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EATC
The address reference data is corrupted.
EATN
Address validation cannot find the address reference data.
EATU
Address validation cannot unlock the address reference data.
Supplementary BR Status
Output port that indicates whether the address validation process can write supplementary data for Brazilian
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Brazil in the BR Supplementary port group. BR Supplementary port
data includes code values from the Brazilian Institute of Geography and Statistics (IBGE) that can identify the
city or state for an street address.
Supplementary BR Status Usage
Select Supplementary BR Status to verify that the address validation process can populate the ports in the
BR Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Brazil.
Port Location
The following table provides the location and default precision of the Supplementary BR Status port:
Port Type
Port Group
Template Model
Precision
Output
Basic
BR Supplementary
4
Supplementary BR Status
251
Supplementary BR Status Output Codes
The following table describes Supplementary BR Status output codes:
Code
Description
EBR0
Supplementary data is not available for the current address.
EBR1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EBRC
The address reference data is corrupted.
EBRN
Address validation cannot find the address reference data.
EBRU
Address validation cannot unlock the address reference data.
Supplementary CH Status
Output port that indicates whether the address validation process can write supplementary data for Swiss
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Switzerland in the CH Supplementary port group. CH Supplementary
port data includes postal codes that identify the street for a Swiss mailbox.
Supplementary CH Status Usage
Select Supplementary CH Status to verify that the address validation process can populate the ports in the
CH Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Switzerland.
Port Location
The following table provides the location and default precision of the Supplementary CH Status port:
252
Port Type
Port Group
Template Model
Precision
Output
Basic
CH Supplementary
4
Chapter 15: Supplementary Data Ports
Supplementary CH Status Output Codes
The following table describes Supplementary CH Status output codes:
Code
Description
ECH0
Supplementary data is not available for the current address.
ECH1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
ECHC
The address reference data is corrupted.
ECHN
Address validation cannot find the address reference data.
ECHU
Address validation cannot unlock the address reference data.
Supplementary DE Status
Output port that indicates whether the address validation process can write supplementary data for German
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Germany in the DE Supplementary port group. DE Supplementary port
data includes postal codes that identify the street, locality, and municipality for a German mailbox.
Supplementary DE Status Usage
Select Supplementary DE Status to verify that the address validation process can populate the ports in the
DE Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Germany.
Port Location
The following table provides the location and default precision of the Supplementary DE Status port:
Port Type
Port Group
Template Model
Precision
Output
Basic
DE Supplementary
4
Supplementary DE Status
253
Supplementary DE Status Output Codes
The following table describes Supplementary DE Status output codes:
Code
Description
EDE0
Supplementary data is not available for the current address.
EDE1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EDEC
The address reference data is corrupted.
EDEN
Address validation cannot find the address reference data.
EDEU
Address validation cannot unlock the address reference data.
Supplementary FR Status
Output port that indicates whether the address validation process can write supplementary data for French
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for France in the FR Supplementary port group. FR Supplementary port
data includes data from the National Institute for Statistics and Economic Studies (INSEE) that identifies
French communes and departments.
Supplementary FR Status Usage
Select Supplementary FR Status to verify that the address validation process can populate the ports in the
FR Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for France.
Port Location
The following table provides the location and default precision of the Supplementary FR Status port:
254
Port Type
Port Group
Template Model
Precision
Output
Basic
FR Supplementary
4
Chapter 15: Supplementary Data Ports
Supplementary FR Status Output Codes
The following table describes Supplementary FR Status output codes:
Code
Description
EFR0
Supplementary data is not available for the current address.
EFR1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EFRC
The address reference data is corrupted.
EFRN
Address validation cannot find the address reference data.
EFRU
Address validation cannot unlock the address reference data.
Supplementary GB Status
Output port that indicates whether the address validation process can write supplementary data for United
Kingdom addresses. Add supplementary data elements to an address to assist the mail carrier in mail
delivery.
Find the supplementary data ports for the United Kingdom in the UK Supplementary port group. UK
Supplementary port data includes delivery point codes that can uniquely identify a mailbox in a United
Kingdom address.
The UK Supplementary ports add delivery point data to United Kingdom addresses.
Supplementary GB Status Usage
Select Supplementary GB Status to verify that the address validation process can populate the ports in the
UK Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for the United Kingdom.
Port Location
The following table provides the location and default precision of the Supplementary GB Status port:
Port Type
Port Group
Template Model
Precision
Output
UK Supplementary
Basic
4
Supplementary GB Status
255
Supplementary GB Status Output Codes
The following table describes Supplementary GB Status output codes:
Code
Description
EGB0
Supplementary data is not available for the current address.
EGB1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EGBC
The address reference data is corrupted.
EGBN
Address validation cannot find the address reference data.
EGBU
Address validation cannot unlock the address reference data.
Supplementary JP Status
Output port that indicates whether the address validation process can write supplementary data for Serbian
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Japan in the JP Supplementary port group. JP Supplementary port
data includes delivery point codes that can uniquely identify a mailbox in a Japanese address.
Supplementary JP Status Usage
Select Supplementary JP Status to verify that the address validation process can populate the ports in the JP
Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Japan.
Port Location
The following table provides the location and default precision of the Supplementary JP Status port:
256
Port Type
Port Group
Template Model
Precision
Output
JP Supplementary
Basic
4
Chapter 15: Supplementary Data Ports
Supplementary JP Status Output Codes
The following table describes Supplementary JP Status output codes:
Code
Description
EJP0
Supplementary data is not available for the current address.
EJP1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EJPC
The address reference data is corrupted.
EJPN
Address validation cannot find the address reference data.
EJPU
Address validation cannot unlock the address reference data.
Supplementary PL Status
Output port that indicates whether the address validation process can write supplementary data for Polish
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Poland in the PL Supplementary port group. PL Supplementary port
data includes postal codes that identify the street for a Polish mailbox.
Supplementary PL Status Usage
Select Supplementary PL Status to verify that the address validation process can populate the ports in the PL
Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Poland.
Port Location
The following table provides the location and default precision of the Supplementary PL Status port:
Port Type
Port Group
Template Model
Precision
Output
Basic
PL Supplementary
4
Supplementary PL Status
257
Supplementary PL Status Output Codes
The following table describes Supplementary PL Status output codes:
Code
Description
EPL0
Supplementary data is not available for the current address.
EPL1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EPLC
The address reference data is corrupted.
EPLN
Address validation cannot find the address reference data.
EPLU
Address validation cannot unlock the address reference data.
Supplementary RS Status
Output port that indicates whether the address validation process can write supplementary data for Serbian
addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for Serbia in the RS Supplementary port group. RS Supplementary port
data includes postal codes that identify the street for a Serbian mailbox.
Supplementary RS Status Usage
Select Supplementary RS Status to verify that the address validation process can populate the ports in the
RS Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for Serbia.
Port Location
The following table provides the location and default precision of the Supplementary RS Status port:
258
Port Type
Port Group
Template Model
Precision
Output
RS Supplementary
Basic
4
Chapter 15: Supplementary Data Ports
Supplementary RS Status Output Codes
The following table describes Supplementary RS Status output codes:
Code
Description
ERS0
Supplementary data is not available for the current address.
ERS1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
ERSC
The address reference data is corrupted.
ERSN
Address validation cannot find the address reference data.
ERSU
Address validation cannot unlock the address reference data.
Supplementary US Status
Output port that indicates whether the address validation process can write supplementary data for United
States addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for the United States in the US Supplementary port group. US
Supplementary port data includes census tract and census block numbers, Metropolitan Statistical Area
(MSA) codes, time zone codes, and Minor Civil Division (MCD) codes.
Supplementary US Status Usage
Select Supplementary US Status to verify that the address validation process can populate the ports in the
US Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for the United States.
Port Location
The following table provides the location and default precision of the Supplementary US Status port:
Port Type
Port Group
Template Model
Precision
Output
US Supplementary
Basic
4
Supplementary US Status
259
Supplementary US Status Output Codes
The following table describes Supplementary US Status output codes:
Code
Description
EUS0
Supplementary data is not available for the current address.
EUS1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EUSC
The address reference data is corrupted.
EUSN
Address validation cannot find the address reference data.
EUSU
Address validation cannot unlock the address reference data.
Supplementary ZA Status
Output port that indicates whether the address validation process can write supplementary data for South
African addresses. Add supplementary data elements to an address to assist the mail carrier in mail delivery.
Find the supplementary data ports for South Africa in the ZA Supplementary port group. ZA Supplementary
port data includes code values that can identify a building on a street in South Africa.
Supplementary ZA Status Usage
Select Supplementary ZA Status to verify that the address validation process can populate the ports in the
ZA Supplementary port group.
If the port indicates that the codes are not available, you need to update the supplementary address
reference data that you installed for South Africa.
Port Location
The following table provides the location and default precision of the Supplementary ZA Status port:
260
Port Type
Port Group
Template Model
Precision
Output
Basic
ZA Supplementary
4
Chapter 15: Supplementary Data Ports
Supplementary ZA Status Output Codes
The following table describes Supplementary ZA Status output codes:
Code
Description
EZXA0
Supplementary data is not available for the current address.
EZA1
Supplementary data is available for the current address.
Note: The address reference data sets might not contain data for every
supplementary address element. Review the data on the supplementary
ports to verify that the address record contains the data that you expect.
EZAC
The address reference data is corrupted.
EZAN
Address validation cannot find the address reference data.
ZAU
Address validation cannot unlock the address reference data.
TERYT Locality Identifier PL
Output port that contains the identification code for the locality to which a Polish address belongs. The code
represents the locality that the National Official Register of the Territorial Division of the Country (TERYT)
defines.
TERYT Locality Identifier PL Usage
To add a code that identifies the locality to which a Polish address belongs, select the TERYT Locality
Identifier PL port.
Port Locations
The following table provides the location and default precision of the TERYT Locality Identifier PL ports:
Port Type
Port Group
Template Model
Precision
Output
PL Supplementary
Basic
7
TERYT Locality Identifier PL Example
The following example address contains data that can populate the TERYT Locality Identifier PL port:
Adrian Kieślowski
ul. Laskowa 1
50510 Wrocław
Poland
TERYT Locality Identifier PL
261
The following table shows Address Validator transformation ports that you might select for the address:
Port Name
Data
Contact Complete 1
Adrian Kieślowski
Street Complete 1
ul. Laskowa
Street Number Complete 1
1
Province Country Standard 1
dolnośląskie
TERYT Locality Identifier PL
0986544
Locality Complete 1
Wrocław
Postcode Unformatted 1
50510
Country Name 1
Poland
TERYT Street Identifier PL
Output port that contains the identification code for the street in a Polish address. The National Official
Register of the Territorial Division of the Country (TERYT) maintains the list of street codes.
TERYT Street Identifier PL Usage
To add a code that identifies the street in a Polish address belongs, select the TERYT Street Identifier PL
port.
Port Locations
The following table provides the location and default precision of the TERYT Street Identifier PL port:
Port Type
Port Group
Template Model
Precision
Output
PL Supplementary
Basic
5
TERYT Street Identifier PL Example
The following example address contains data that can populate the TERYT Street Identifier PL port:
Adrian Kieślowski
ul. Laskowa 1
50510 Wrocław
Poland
262
Chapter 15: Supplementary Data Ports
The following table shows Address Validator transformation ports that you might select for the address:
Port Name
Data
Contact Complete 1
Adrian Kieślowski
Street Complete 1
ul. Laskowa
Street Number Complete 1
1
Province Country Standard 1
dolnośląskie
TERYT Street Identifier PL
10666
Locality Complete 1
Wrocław
Postcode Unformatted 1
50510
Country Name 1
Poland
Unique Delivery Point Reference Number GB
Input and output ports that uniquely identify a United Kingdom address.
The eight digits of the reference number contain all the data that the Royal Mail needs to deliver a mail item
to a destination mailbox. You can use the reference number in place of the United Kingdom street address.
Unique Delivery Point Reference Number GB Usage
To read a code that uniquely identifies a United Kingdom address, select the Unique Delivery Point
Reference Number GB input port.
To generate a code that uniquely identifies a United Kingdom address, select the Unique Delivery Point
Reference Number GB output port.
Port Location
The following table provides the location and default precision of the Unique Delivery Point Reference
Number GB port:
Port Type
Port Group
Template Model
Precision
Input
Discrete
Basic
8
Output
UK Supplementary
Basic
50
Unique Delivery Point Reference Number GB Example
The following example address contains data that can generate a unique delivery point reference number:
MS. ANDREA GOODE
1 LOIRSTON CLOSE
COVE
ABERDEEN
AB12 3AU
GBR
Unique Delivery Point Reference Number GB
263
The following table shows the Address Validator transformation ports that relate to the reference number data
in the address:
264
Port Name
Data
Contact Complete 1
MS. ANDREA GOODE
Street Number Complete 1
1
Street Complete 1
LOIRSTON CLOSE
Postcode Complete 1
AB12 3AU
Locality Complete 1
ABERDEEN
Locality Complete 2
COVE
Country ISO3 Char
GBR
Unique Delivery Point Reference Number GB
00022909
Chapter 15: Supplementary Data Ports
CHAPTER 16
XML Ports
This chapter includes the following topics:
•
Input Data, 265
•
Result, 266
Input Data
Output port that contains the data elements in an input address record in a structured XML format.
The Input Data port identifies the address elements that the AddressDoctor software library associates with
the input ports that you select on the transformation. When the address validation mapping runs, the Address
Validator transformation passes the input port data to the AddressDoctor software library. The software
library analyzes each data value as a tagged element in an XML structure.
Input Data Usage
To view the address elements in an input address in a structured XML format, select the Input Data port.
If address validation does not generate the results that you expect, use the Input Data port output to verify
the structure of the input address. For example, the Status Info ports might indicate that an address is
undeliverable because of problems in one or more address elements. Review the XML output to identify the
input ports that contain the address elements and to verify that you selected the correct port for each
element.
You can use the output from the Result port to troubleshoot the structure of the output address. The Result
port writes the data elements in an output address in a structured XML format.
Port Locations
The following table provides the location and default precision of the Input Data port:
Port Type
Port Group
Template Model
Precision
Output
XML
Advanced
2000
Input Data Example
The following address contains data that you can assign to input ports on the Address Validator
transformation:
MR. JOHN DOE
38A ST. JAMES'S STREET
265
LONDON E17 7PE
UNITED KINGDOM
The following table shows the Address Validator transformation input ports that you might select for the
address:
Port
Data
Country Name
UNITED KINGDOM
Locality Complete 1
LONDON
Postcode 1
E17 7PE
Street Complete 1
ST. JAMES'S STREET
Street Number 1
38A
The following XML fragment shows the XML output on the Input Data port:
<?xml version="1.0" encoding="UTF-16"?>
<!-- EngineVersion="5.5.0.27265" -->
<InputData>
<AddressElements>
<Country Item="1" Type="NAME">GBR</Country>
<Locality Item="1" Type="COMPLETE">LONDON</Locality>
<PostalCode Item="1" Type="FORMATTED">E17 7PE</PostalCode>
</AddressElements>
<AddressLines>
<DeliveryAddressLine Line="1">38A ST. JAMES'S STREET</DeliveryAddressLine>
<DeliveryAddressLine Line="2"></DeliveryAddressLine>
</AddressLines>
</InputData>
Result
Output port that contains the data elements in an output address record in a structured XML format.
The Result port identifies the address elements that the AddressDoctor software library associates with the
output ports that you select on the transformation. When the address validation mapping runs, the Address
Validator transformation passes the input port data to the AddressDoctor software library. The software
library analyzes the data and generates an output in an XML format.
Result Usage
To view the address elements in an output address in a structured XML format, select the Result port.
If address validation does not generate the results that you expect, use the Result port output to verify the
structure of the output address. For example, the CASS Status port might indicate that address validation
cannot certify an address to the CASS standard because a data element is missing. Review the XML output
to verify that you selected the correct output ports for CASS certification.
266
Chapter 16: XML Ports
Port Locations
The following table provides the location and default precision of the Result port:
Port Type
Port Group
Template Model
Precision
Output
XML
Advanced
2000
Result Example
The following address contains data elements that the Result port can write as XML:
80 Raffles Place
#50-01 UOB Plaza 1
Singapore
SGP
The following table shows the Address Validator transformation input ports that you might select for the
address:
Port
Data
Country ISO3 Char
SGP
Locality Name 1
Singapore
Postcode 1
048624
Street Complete 1
Raffles Place
Street Number 1
80
Building Complete 1
UOB Plaza 1
Sub-building Complete 1
50
Sub-building Complete 2
01
The following XML fragment shows the XML output on the Result port:
<?xml version="1.0" encoding="UTF-16"?>
<!-- EngineVersion="5.5.0.27265" -->
<Result ProcessStatus="C4"
ModeUsed="BATCH"
Count="1"
CountOverflow="NO"
CountryISO3="SGP"
PreferredScript="DATABASE"
PreferredLanguage="DATABASE">
<ResultData ResultNumber="1"
MailabilityScore="4"
ResultPercentage="100.00"
ElementResultStatus="80F000F0F000F04400E0"
ElementInputStatus="00600060600060220060"
AddressResolutionCode="00000000000000000000"
ExtElementStatus="00000000000060BB0000"
ElementRelevance="10100010100010000010"
AddressType="B"
LanguageISO3="XXX">
<AddressElements>
Result
267
<Country Type="NAME_EN" Item="1">SINGAPORE</Country>
<Locality Item="1">SINGAPORE</Locality>
<PostalCode Item="1">048624</PostalCode>
<Street Item="1">RAFFLES PLACE</Street>
<Number Item="1">80</Number>
<Building Item="1">UOB PLAZA 1</Building>
<SubBuilding Item="1"># 50</SubBuilding>
<SubBuilding Item="2">01</SubBuilding>
</AddressElements>
<AddressLines>
<DeliveryAddressLine Line="1">80 RAFFLES PLACE</DeliveryAddressLine>
<DeliveryAddressLine Line="2">#50-01 UOB PLAZA 1</DeliveryAddressLine>
<CountrySpecificLocalityLine Line="1">SINGAPORE 048624</
CountrySpecificLocalityLine>
<FormattedAddressLine Line="1">80 RAFFLES PLACE</FormattedAddressLine>
<FormattedAddressLine Line="2">#50-01 UOB PLAZA 1</FormattedAddressLine>
<FormattedAddressLine Line="3">SINGAPORE 048624</FormattedAddressLine>
</AddressLines>
<AddressComplete>80 RAFFLES PLACE
#50-01 UOB PLAZA 1
SINGAPORE 048624</AddressComplete>
</ResultData>
</Result>
Note: You can configure the Address Validator transformation to write an address value to more than one
output port. You can also select status ports that indicate the deliverable status of the address.
268
Chapter 16: XML Ports
Download PDF